The highest tagged major version is
README
¶
Payload
An Lux Unsigned Warp Message already includes a networkID, sourceChainID, and payload field. The payload field can be parsed into one of the types included in this package to be further handled by the VM.
Hash
Hash:
+-----------------+----------+-----------+
| codecID : uint16 | 2 bytes |
+-----------------+----------+-----------+
| typeID : uint32 | 4 bytes |
+-----------------+----------+-----------+
| hash : [32]byte | 32 bytes |
+-----------------+----------+-----------+
| 38 bytes |
+-----------+
codecIDis the codec version used to serialize the payload and is hardcoded to0x0000typeIDis the payload type identifier and is0x00000000forHashhashis a hash from thesourceChainID. The format of the expected preimage is chain specific. Some examples for valid hash values are:- root of a merkle tree
- accepted block hash on the source chain
- accepted transaction hash on the source chain
AddressedCall
AddressedCall:
+---------------------+--------+----------------------------------+
| codecID : uint16 | 2 bytes |
+---------------------+--------+----------------------------------+
| typeID : uint32 | 4 bytes |
+---------------------+--------+----------------------------------+
| sourceAddress : []byte | 4 + len(address) |
+---------------------+--------+----------------------------------+
| payload : []byte | 4 + len(payload) |
+---------------------+--------+----------------------------------+
| 14 + len(payload) + len(address) |
+----------------------------------+
codecIDis the codec version used to serialize the payload and is hardcoded to0x0000typeIDis the payload type identifier and is0x00000001forAddressedCallsourceAddressis the address that sent this message from the source chainpayloadis an arbitrary byte array payload
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrWrongType = errors.New("wrong payload type")
Functions ¶
This section is empty.
Types ¶
type AddressedCall ¶
type AddressedCall struct {
SourceAddress []byte `json:"sourceAddress"`
Payload []byte `json:"payload"`
// contains filtered or unexported fields
}
AddressedCall defines the format for delivering a call across VMs including a source address and a payload.
Note: If a destination address is expected, it should be encoded in the payload.
func NewAddressedCall ¶
func NewAddressedCall(sourceAddress []byte, payload []byte) (*AddressedCall, error)
NewAddressedCall creates a new *AddressedCall and initializes it.
func ParseAddressedCall ¶
func ParseAddressedCall(b []byte) (*AddressedCall, error)
ParseAddressedCall converts a slice of bytes into an initialized AddressedCall.
func (*AddressedCall) Bytes ¶
func (a *AddressedCall) Bytes() []byte
Bytes returns the binary representation of this payload. It assumes that the payload is initialized from either NewAddressedCall or Parse.
type Hash ¶
type Payload ¶
type Payload interface {
// Bytes returns the binary representation of this payload.
Bytes() []byte
// contains filtered or unexported methods
}
Payload provides a common interface for all payloads implemented by this package. Each payload is a native-ZAP struct-is-wire object whose first byte is a pkind discriminator (the struct IS the buffer; no codec).
Source Files