types

package
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2025 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package types contains shared type definitions and constants used by both the host environment and WebAssembly contracts

Index

Constants

View Source 
const HostBufferSize int32 = 2048

HostBufferSize defines the size of the buffer used for data exchange between host and contract

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address [20]byte

Address 表示区块链上的地址

func (Address) String added in v0.1.2 

func (addr Address) String() string

type BlockchainContext 

type BlockchainContext interface {
	// set block info and transaction info
	SetBlockInfo(height uint64, time int64, hash Hash) error
	SetTransactionInfo(hash Hash, from Address, to Address, value uint64) error
	// Blockchain information related
	BlockHeight() uint64      // Get current block height
	BlockTime() int64         // Get current block timestamp
	ContractAddress() Address // Get current contract address
	TransactionHash() Hash    // Get current transaction hash
	SetGasLimit(limit int64)  // Set gas limit
	GetGas() int64            // Get used gas
	// Account operations related
	Sender() Address                                          // Get transaction sender or contract caller
	Balance(addr Address) uint64                              // Get account balance
	Transfer(contract, from, to Address, amount uint64) error // Transfer operation

	// Object storage related - Basic state operations use panic instead of returning error
	CreateObject(contract Address) (VMObject, error)                      // Create new object
	CreateObjectWithID(contract Address, id ObjectID) (VMObject, error)   // Create new object
	GetObject(contract Address, id ObjectID) (VMObject, error)            // Get specified object
	GetObjectWithOwner(contract Address, owner Address) (VMObject, error) // Get object by owner
	DeleteObject(contract Address, id ObjectID) error                     // Delete object

	// Cross-contract calls
	Call(caller Address, contract Address, function string, args ...any) ([]byte, error)

	// Logs and events
	Log(contract Address, eventName string, keyValues ...any) // Log event
}

Context 是合约与区块链环境交互的主要接口

type CallParams 

type CallParams struct {
	Caller   Address `json:"caller,omitempty"`
	Contract Address `json:"contract,omitempty"`
	Function string  `json:"function,omitempty"`
	Args     []any   `json:"args,omitempty"`
	GasLimit int64   `json:"gas_limit,omitempty"`
}

type CallResult 

type CallResult struct {
	Data    []byte `json:"data,omitempty"`
	GasUsed int64  `json:"gas_used,omitempty"`
}

type Context added in v0.1.2 

type Context interface {
	// Blockchain information related
	BlockHeight() uint64      // Get current block height
	BlockTime() int64         // Get current block timestamp
	ContractAddress() Address // Get current contract address

	// Account operations related
	Sender() Address                                // Get transaction sender or contract caller
	Balance(addr Address) uint64                    // Get account balance
	Transfer(from, to Address, amount uint64) error // Transfer operation

	// Object storage related - Basic state operations use panic instead of returning error
	CreateObject() Object                             // Create new object, panic on failure
	GetObject(id ObjectID) (Object, error)            // Get specified object, may return error
	GetObjectWithOwner(owner Address) (Object, error) // Get object by owner, may return error
	DeleteObject(id ObjectID)                         // Delete object, panic on failure

	// Cross-contract calls
	Call(contract Address, function string, args ...any) ([]byte, error)

	// Logs and events
	Log(eventName string, keyValues ...any) // Log event
}

Context 是合约与区块链环境交互的主要接口

type DeleteObjectParams 

type DeleteObjectParams struct {
	Contract Address  `json:"contract,omitempty"`
	ID       ObjectID `json:"id,omitempty"`
}

type ExecutionResult 

type ExecutionResult struct {
	Success bool   `json:"success"`
	Data    any    `json:"data,omitempty"`
	Error   string `json:"error,omitempty"`
}

type GetObjectFieldParams 

type GetObjectFieldParams struct {
	Contract Address  `json:"contract,omitempty"`
	ID       ObjectID `json:"id,omitempty"`
	Field    string   `json:"field,omitempty"`
}

type GetObjectParams 

type GetObjectParams struct {
	Contract Address  `json:"contract,omitempty"`
	ID       ObjectID `json:"id,omitempty"`
}

type GetObjectWithOwnerParams 

type GetObjectWithOwnerParams struct {
	Contract Address `json:"contract,omitempty"`
	Owner    Address `json:"owner,omitempty"`
}

type HandleContractCallParams 

type HandleContractCallParams struct {
	Contract Address `json:"contract,omitempty"`
	Sender   Address `json:"sender,omitempty"`
	Function string  `json:"function,omitempty"`
	Args     []byte  `json:"args,omitempty"`
	GasLimit int64   `json:"gas_limit,omitempty"`
}

type Hash added in v0.1.2 

type Hash [32]byte

func HashFromString added in v0.1.2 

func HashFromString(str string) Hash

func (Hash) String added in v0.1.2 

func (h Hash) String() string

type LogParams 

type LogParams struct {
	Contract  Address `json:"contract,omitempty"`
	Event     string  `json:"event,omitempty"`
	KeyValues []any   `json:"key_values,omitempty"`
}

type Object added in v0.1.2 

type Object interface {
	ID() ObjectID          // Get object ID
	Owner() Address        // Get object owner
	Contract() Address     // Get object's contract
	SetOwner(addr Address) // Set object owner, panic on failure

	// Field operations
	Get(field string, value any) error // Get field value
	Set(field string, value any) error // Set field value
}

Object 接口用于管理区块链状态对象

type ObjectID 

type ObjectID [32]byte

ObjectID 表示状态对象的唯一标识符

func (ObjectID) String added in v0.1.2 

func (id ObjectID) String() string

type SetObjectFieldParams 

type SetObjectFieldParams struct {
	Contract Address  `json:"contract,omitempty"`
	Sender   Address  `json:"sender,omitempty"`
	ID       ObjectID `json:"id,omitempty"`
	Field    string   `json:"field,omitempty"`
	Value    any      `json:"value,omitempty"`
}

type SetOwnerParams 

type SetOwnerParams struct {
	Contract Address  `json:"contract,omitempty"`
	Sender   Address  `json:"sender,omitempty"`
	ID       ObjectID `json:"id,omitempty"`
	Owner    Address  `json:"owner,omitempty"`
}

type TransferParams 

type TransferParams struct {
	Contract Address `json:"contract,omitempty"`
	From     Address `json:"from,omitempty"`
	To       Address `json:"to,omitempty"`
	Amount   uint64  `json:"amount,omitempty"`
}

type VMObject 

type VMObject interface {
	ID() ObjectID                                  // Get object ID
	Owner() Address                                // Get object owner
	Contract() Address                             // Get object's contract
	SetOwner(contract, sender, addr Address) error // Set object owner

	// Field operations
	Get(contract Address, field string) ([]byte, error)             // Get field value
	Set(contract, sender Address, field string, value []byte) error // Set field value
}

Object 接口用于管理区块链状态对象

type WasmFunctionID 

type WasmFunctionID int32

WasmFunctionID defines constants for function IDs used in host-contract communication These constants must be used on both sides (host and contract) to ensure compatibility

IMPORTANT: These function IDs are critical for the communication between the host environment and WebAssembly contracts. Any mismatch in the function ID values between the host and contract will result in undefined behavior or system failures.

Always import and use these constants in both host and contract code, rather than defining separate constants in different parts of the codebase. This ensures consistent communication and prevents hard-to-debug errors due to mismatched function IDs.

Example usage in host code: 

const FuncGetSender = int32(types.FuncGetSender)

Example usage in contract code: 

const FuncGetSender = int32(types.FuncGetSender)

const (
	// FuncGetSender returns the address of the sender (caller) of the current transaction
	FuncGetSender WasmFunctionID = iota + 1 // 1
	// FuncGetContractAddress returns the address of the current contract
	FuncGetContractAddress // 2
	// FuncTransfer transfers tokens from the contract to a recipient
	FuncTransfer // 3
	// FuncCreateObject creates a new state object
	FuncCreateObject // 4
	// FuncCall calls a function on another contract
	FuncCall // 5
	// FuncGetObject retrieves a state object by ID
	FuncGetObject // 6
	// FuncGetObjectWithOwner retrieves objects owned by a specific address
	FuncGetObjectWithOwner // 7
	// FuncDeleteObject removes a state object
	FuncDeleteObject // 8
	// FuncLog logs a message to the blockchain's event system
	FuncLog // 9
	// FuncGetObjectOwner gets the owner of a state object
	FuncGetObjectOwner // 10
	// FuncSetObjectOwner changes the owner of a state object
	FuncSetObjectOwner // 11
	// FuncGetObjectField retrieves a specific field from a state object
	FuncGetObjectField // 12
	// FuncSetObjectField updates a specific field in a state object
	FuncSetObjectField // 13
	// FuncGetObjectContract gets the contract of a state object
	FuncGetObjectContract // 14
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.