api

Documentation

Index

• func AnalyzeCode(cache Cache, checksum []byte) (*types.AnalysisReport, error)
• func Create(cache Cache, wasm []byte) ([]byte, error)
• func Execute(cache Cache, checksum []byte, env []byte, info []byte, msg []byte, ...) ([]byte, uint64, error)
• func GetCode(cache Cache, checksum []byte) ([]byte, error)
• func GetMetrics(cache Cache) (*types.Metrics, error)
• func IBCChannelClose(cache Cache, checksum []byte, env []byte, channel []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func IBCChannelConnect(cache Cache, checksum []byte, env []byte, channel []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func IBCChannelOpen(cache Cache, checksum []byte, env []byte, channel []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func IBCPacketAck(cache Cache, checksum []byte, env []byte, ack []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func IBCPacketReceive(cache Cache, checksum []byte, env []byte, packet []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func IBCPacketTimeout(cache Cache, checksum []byte, env []byte, packet []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func Instantiate(cache Cache, checksum []byte, env []byte, info []byte, msg []byte, ...) ([]byte, uint64, error)
• func Migrate(cache Cache, checksum []byte, env []byte, msg []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func MockFailureCanonicalAddress(human string) ([]byte, uint64, error)
• func MockFailureHumanAddress(canon []byte) (string, uint64, error)
• func Pin(cache Cache, checksum []byte) error
• func Query(cache Cache, checksum []byte, env []byte, msg []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func ReleaseCache(cache Cache)
• func Reply(cache Cache, checksum []byte, env []byte, reply []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func Sudo(cache Cache, checksum []byte, env []byte, msg []byte, gasMeter *GasMeter, ...) ([]byte, uint64, error)
• func Unpin(cache Cache, checksum []byte) error
• type Cache
  • func InitCache(dataDir string, supportedFeatures string, cacheSize uint32, ...) (Cache, error)
• type CanonicalizeAddress
• type DBState
• type Gas
• type GasMeter
• type GoAPI
  • func NewMockFailureAPI() *GoAPI
• type HumanizeAddress
• type Iterator
• type KVStore
• type Querier

Functions

func AnalyzeCode

func AnalyzeCode(cache Cache, checksum []byte) (*types.AnalysisReport, error)

func Create

func Create(cache Cache, wasm []byte) ([]byte, error)

func Execute

func Execute(
	cache Cache,
	checksum []byte,
	env []byte,
	info []byte,
	msg []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func GetCode

func GetCode(cache Cache, checksum []byte) ([]byte, error)

func GetMetrics

func GetMetrics(cache Cache) (*types.Metrics, error)

func IBCChannelClose

func IBCChannelClose(
	cache Cache,
	checksum []byte,
	env []byte,
	channel []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func IBCChannelConnect

func IBCChannelConnect(
	cache Cache,
	checksum []byte,
	env []byte,
	channel []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func IBCChannelOpen

func IBCChannelOpen(
	cache Cache,
	checksum []byte,
	env []byte,
	channel []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func IBCPacketAck

func IBCPacketAck(
	cache Cache,
	checksum []byte,
	env []byte,
	ack []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func IBCPacketReceive

func IBCPacketReceive(
	cache Cache,
	checksum []byte,
	env []byte,
	packet []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func IBCPacketTimeout

func IBCPacketTimeout(
	cache Cache,
	checksum []byte,
	env []byte,
	packet []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func Instantiate

func Instantiate(
	cache Cache,
	checksum []byte,
	env []byte,
	info []byte,
	msg []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func Migrate

func Migrate(
	cache Cache,
	checksum []byte,
	env []byte,
	msg []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func MockFailureCanonicalAddress

func MockFailureCanonicalAddress(human string) ([]byte, uint64, error)

func MockFailureHumanAddress

func MockFailureHumanAddress(canon []byte) (string, uint64, error)

func Pin

func Pin(cache Cache, checksum []byte) error

func Query

func Query(
	cache Cache,
	checksum []byte,
	env []byte,
	msg []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func ReleaseCache

func ReleaseCache(cache Cache)

func Reply

func Reply(
	cache Cache,
	checksum []byte,
	env []byte,
	reply []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func Sudo

func Sudo(
	cache Cache,
	checksum []byte,
	env []byte,
	msg []byte,
	gasMeter *GasMeter,
	store KVStore,
	api *GoAPI,
	querier *Querier,
	gasLimit uint64,
	printDebug bool,
) ([]byte, uint64, error)

func Unpin

func Unpin(cache Cache, checksum []byte) error

Types

type Cache

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

func InitCache

func InitCache(dataDir string, supportedFeatures string, cacheSize uint32, instanceMemoryLimit uint32) (Cache, error)

type CanonicalizeAddress

type CanonicalizeAddress func(string) ([]byte, uint64, error)

type DBState

type DBState struct {
	Store KVStore
	// IteratorStackID is used to lookup the proper stack frame for iterators associated with this DB (iterator.go)
	IteratorStackID uint64
}

type Gas

type Gas = uint64

type GasMeter

type GasMeter interface {
	GasConsumed() Gas
}

GasMeter is a copy of an interface declaration from lfb-sdk Defined in https://github.com/line/lfb-sdk/blob/main/store/types/gas.go

type GoAPI

type GoAPI struct {
	HumanAddress     HumanizeAddress
	CanonicalAddress CanonicalizeAddress
}

func NewMockFailureAPI

func NewMockFailureAPI() *GoAPI

type HumanizeAddress

type HumanizeAddress func([]byte) (string, uint64, error)

type Iterator

type Iterator interface {
	// Valid returns whether the current iterator is valid. Once invalid, the Iterator remains
	// invalid forever.
	Valid() bool

	// Next moves the iterator to the next key in the database, as defined by order of iteration.
	// If Valid returns false, this method will panic.
	Next()

	// Key returns the key at the current position. Panics if the iterator is invalid.
	// CONTRACT: key readonly []byte
	Key() (key []byte)

	// Value returns the value at the current position. Panics if the iterator is invalid.
	// CONTRACT: value readonly []byte
	Value() (value []byte)

	// Error returns the last error encountered by the iterator, if any.
	Error() error

	// Close closes the iterator, releasing any allocated resources.
	Close() error
}

Iterator copies a subset of types from lfb-sdk

type KVStore

type KVStore interface {
	Get(key []byte) []byte
	Set(key, value []byte)
	Delete(key []byte)

	// Iterator over a domain of keys in ascending order. End is exclusive.
	// Start must be less than end, or the Iterator is invalid.
	// Iterator must be closed by caller.
	// To iterate over entire domain, use store.Iterator(nil, nil)
	Iterator(start, end []byte) Iterator

	// Iterator over a domain of keys in descending order. End is exclusive.
	// Start must be less than end, or the Iterator is invalid.
	// Iterator must be closed by caller.
	ReverseIterator(start, end []byte) Iterator
}

KVStore copies a subset of types from lfb-sdk We may wish to make this more generic sometime in the future, but not now Original KVStore is defined in https://github.com/line/lfb-sdk/blob/main/store/types/store.go

type Querier

type Querier = types.Querier