wasm

Documentation

Index

• Constants
• type Argument
• type BaseArgument
  • func (b *BaseArgument) Name() string
• type BaseValueArgument
  • func (b *BaseValueArgument) SetValue(data []byte)
  • func (b *BaseValueArgument) Value() []byte
• type Heap
  • func NewHeap(memory *wasmtime.Memory, allocator, dealloc *wasmtime.Func, ...) *Heap
  • func (h *Heap) Clear() error
  • func (h *Heap) ReadBytes(ptr int32, length int32) []byte
  • func (h *Heap) ReadString(ptr int32, length int32) string
  • func (h *Heap) Write(bytes []byte, from string) (int32, error)
  • func (h *Heap) WriteAndTrack(bytes []byte, track bool, from string) (int32, error)
  • func (h *Heap) WriteAtPtr(bytes []byte, ptr int32, from string) (int32, error)
• type InputType
• type Instance
  • func (i *Instance) Cleanup() error
  • func (i *Instance) Err() error
  • func (i *Instance) Execute() (err error)
  • func (i *Instance) ExecuteWithArgs(args ...interface{}) (err error)
  • func (i *Instance) Output() []byte
  • func (i *Instance) PushExecutionStack(event string)
  • func (i *Instance) ReachedLogsMaxByteCount() bool
  • func (i *Instance) SetOutputStore(store store.Store)
  • func (i *Instance) WriteOutputToHeap(outputPtr int32, value []byte, from string) error
• type MapInput
  • func NewMapInput(name string) *MapInput
• type Module
  • func (m *Module) FreeMem()
  • func (m *Module) NewInstance(clock *pbsubstreams.Clock, arguments []Argument) (*Instance, error)
• type PanicError
  • func (e *PanicError) Error() string
• type Runtime
  • func NewRuntime(extensions []WASMExtensioner) *Runtime
  • func (r *Runtime) NewModule(ctx context.Context, request *pbsubstreams.Request, wasmCode []byte, ...) (*Module, error)
• type SourceInput
  • func NewSourceInput(name string) *SourceInput
• type StoreDeltaInput
  • func NewStoreDeltaInput(name string) *StoreDeltaInput
• type StoreReaderInput
  • func NewStoreReaderInput(name string, store store.Store) *StoreReaderInput
• type StoreWriterOutput
  • func NewStoreWriterOutput(name string, store store.Store, ...) *StoreWriterOutput
• type ValueArgument
• type WASMExtension
• type WASMExtensioner

Constants

const ClockType = "sf.substreams.v1.Clock"

Types

type Argument

type Argument interface {
	Name() string
}

type BaseArgument

type BaseArgument struct {
	// contains filtered or unexported fields
}

func (*BaseArgument) Name

func (b *BaseArgument) Name() string

type BaseValueArgument

type BaseValueArgument struct {
	// contains filtered or unexported fields
}

func (*BaseValueArgument) SetValue

func (b *BaseValueArgument) SetValue(data []byte)

func (*BaseValueArgument) Value

func (b *BaseValueArgument) Value() []byte

type Heap

type Heap struct {
	// contains filtered or unexported fields
}

func NewHeap

func NewHeap(memory *wasmtime.Memory, allocator, dealloc *wasmtime.Func, store *wasmtime.Store) *Heap

func (*Heap) Clear

func (h *Heap) Clear() error

func (*Heap) ReadBytes

func (h *Heap) ReadBytes(ptr int32, length int32) []byte

func (*Heap) ReadString

func (h *Heap) ReadString(ptr int32, length int32) string

func (*Heap) Write

func (h *Heap) Write(bytes []byte, from string) (int32, error)

func (*Heap) WriteAndTrack

func (h *Heap) WriteAndTrack(bytes []byte, track bool, from string) (int32, error)

func (*Heap) WriteAtPtr

func (h *Heap) WriteAtPtr(bytes []byte, ptr int32, from string) (int32, error)

type InputType

type InputType int

type Instance

type Instance struct {
	Logs           []string
	LogsByteCount  uint64
	ExecutionStack []string
	Module         *Module
	// contains filtered or unexported fields
}

func (*Instance) Cleanup

func (i *Instance) Cleanup() error

func (*Instance) Err

func (i *Instance) Err() error

func (*Instance) Execute

func (i *Instance) Execute() (err error)

func (*Instance) ExecuteWithArgs

func (i *Instance) ExecuteWithArgs(args ...interface{}) (err error)

func (*Instance) Output

func (i *Instance) Output() []byte

func (*Instance) PushExecutionStack

func (i *Instance) PushExecutionStack(event string)

func (*Instance) ReachedLogsMaxByteCount

func (i *Instance) ReachedLogsMaxByteCount() bool

func (*Instance) SetOutputStore

func (i *Instance) SetOutputStore(store store.Store)

func (*Instance) WriteOutputToHeap

func (i *Instance) WriteOutputToHeap(outputPtr int32, value []byte, from string) error

type MapInput

type MapInput struct {
	BaseArgument
	BaseValueArgument
}

func NewMapInput

func NewMapInput(name string) *MapInput

type Module

type Module struct {
	CurrentInstance *Instance

	Heap *Heap
	// contains filtered or unexported fields
}

func (*Module) FreeMem

func (m *Module) FreeMem()

func (*Module) NewInstance

func (m *Module) NewInstance(clock *pbsubstreams.Clock, arguments []Argument) (*Instance, error)

type PanicError

type PanicError struct {
	// contains filtered or unexported fields
}

func (*PanicError) Error

func (e *PanicError) Error() string

type Runtime

type Runtime struct {
	// contains filtered or unexported fields
}

func NewRuntime

func NewRuntime(extensions []WASMExtensioner) *Runtime

func (*Runtime) NewModule

func (r *Runtime) NewModule(ctx context.Context, request *pbsubstreams.Request, wasmCode []byte, name string, entrypoint string) (*Module, error)

type SourceInput

type SourceInput struct {
	BaseArgument
	BaseValueArgument
}

func NewSourceInput

func NewSourceInput(name string) *SourceInput

type StoreDeltaInput

type StoreDeltaInput struct {
	BaseArgument
	BaseValueArgument
}

func NewStoreDeltaInput

func NewStoreDeltaInput(name string) *StoreDeltaInput

type StoreReaderInput

type StoreReaderInput struct {
	BaseArgument
	Store store.Store
}

func NewStoreReaderInput

func NewStoreReaderInput(name string, store store.Store) *StoreReaderInput

type StoreWriterOutput

type StoreWriterOutput struct {
	BaseArgument
	Store        store.Store
	UpdatePolicy pbsubstreams.Module_KindStore_UpdatePolicy
	ValueType    string
}

func NewStoreWriterOutput

func NewStoreWriterOutput(name string, store store.Store, updatePolicy pbsubstreams.Module_KindStore_UpdatePolicy, valueType string) *StoreWriterOutput

type ValueArgument

type ValueArgument interface {
	Argument
	Value() []byte
	SetValue([]byte)
}

type WASMExtension

type WASMExtension func(ctx context.Context, request *pbsubstreams.Request, clock *pbsubstreams.Clock, in []byte) (out []byte, err error)

WASMExtension defines the implementation of a function that will be exposed as wasm imports; therefore, exposed to the host language like Rust.

For example, this can be an RPC call, taking a structured request in `in` and outputting a structured response in `out`, both serialized as protobuf messages.

Such a function needs to be registered through RegisterRuntime.

type WASMExtensioner

type WASMExtensioner interface {
	WASMExtensions() map[string]map[string]WASMExtension
}