Documentation ¶
Overview ¶
Package payload is a generated protocol buffer package.
It is generated from these files:
payload.proto
It has these top-level messages:
Any TxInput TxOutput CallTx SendTx PermsTx NameTx BondTx UnbondTx GovTx
Index ¶
- Constants
- Variables
- type Any
- func (*Any) Descriptor() ([]byte, []int)
- func (m *Any) GetBondTx() *BondTx
- func (m *Any) GetCallTx() *CallTx
- func (m *Any) GetGovTx() *GovTx
- func (m *Any) GetNameTx() *NameTx
- func (m *Any) GetPermsTx() *PermsTx
- func (m *Any) GetSendTx() *SendTx
- func (m *Any) GetUnbondTx() *UnbondTx
- func (m *Any) Marshal() (dAtA []byte, err error)
- func (m *Any) MarshalTo(dAtA []byte) (int, error)
- func (*Any) ProtoMessage()
- func (m *Any) Reset()
- func (m *Any) Size() (n int)
- func (m *Any) String() string
- func (m *Any) Unmarshal(dAtA []byte) error
- func (*Any) XXX_MessageName() string
- type BondTx
- func (tx *BondTx) AddInput(st state.AccountGetter, pubkey crypto.PublicKey, amt uint64) error
- func (tx *BondTx) AddInputWithSequence(pubkey crypto.PublicKey, amt uint64, sequence uint64) error
- func (tx *BondTx) AddOutput(addr crypto.Address, amt uint64) error
- func (tx *BondTx) Any() *Any
- func (*BondTx) Descriptor() ([]byte, []int)
- func (tx *BondTx) GetInputs() []*TxInput
- func (m *BondTx) Marshal() (dAtA []byte, err error)
- func (m *BondTx) MarshalTo(dAtA []byte) (int, error)
- func (*BondTx) ProtoMessage()
- func (m *BondTx) Reset()
- func (m *BondTx) Size() (n int)
- func (tx *BondTx) String() string
- func (tx *BondTx) Type() Type
- func (m *BondTx) Unmarshal(dAtA []byte) error
- func (*BondTx) XXX_MessageName() string
- type CallTx
- func (tx *CallTx) Any() *Any
- func (tx *CallTx) CreatesContractAddress() *crypto.Address
- func (*CallTx) Descriptor() ([]byte, []int)
- func (m *CallTx) GetFee() uint64
- func (m *CallTx) GetGasLimit() uint64
- func (m *CallTx) GetInput() *TxInput
- func (tx *CallTx) GetInputs() []*TxInput
- func (m *CallTx) Marshal() (dAtA []byte, err error)
- func (m *CallTx) MarshalTo(dAtA []byte) (int, error)
- func (*CallTx) ProtoMessage()
- func (m *CallTx) Reset()
- func (m *CallTx) Size() (n int)
- func (tx *CallTx) String() string
- func (tx *CallTx) Type() Type
- func (m *CallTx) Unmarshal(dAtA []byte) error
- func (*CallTx) XXX_MessageName() string
- type ErrTxInvalidSequence
- type GovTx
- func (tx *GovTx) Any() *Any
- func (*GovTx) Descriptor() ([]byte, []int)
- func (tx *GovTx) GetInputs() []*TxInput
- func (m *GovTx) Marshal() (dAtA []byte, err error)
- func (m *GovTx) MarshalTo(dAtA []byte) (int, error)
- func (*GovTx) ProtoMessage()
- func (m *GovTx) Reset()
- func (m *GovTx) Size() (n int)
- func (tx *GovTx) String() string
- func (tx *GovTx) Type() Type
- func (m *GovTx) Unmarshal(dAtA []byte) error
- func (*GovTx) XXX_MessageName() string
- type NameTx
- func (tx *NameTx) Any() *Any
- func (*NameTx) Descriptor() ([]byte, []int)
- func (m *NameTx) GetData() string
- func (m *NameTx) GetFee() uint64
- func (m *NameTx) GetInput() *TxInput
- func (tx *NameTx) GetInputs() []*TxInput
- func (m *NameTx) GetName() string
- func (m *NameTx) Marshal() (dAtA []byte, err error)
- func (m *NameTx) MarshalTo(dAtA []byte) (int, error)
- func (*NameTx) ProtoMessage()
- func (m *NameTx) Reset()
- func (m *NameTx) Size() (n int)
- func (tx *NameTx) String() string
- func (tx *NameTx) Type() Type
- func (m *NameTx) Unmarshal(dAtA []byte) error
- func (*NameTx) XXX_MessageName() string
- type Payload
- type PermsTx
- func (tx *PermsTx) Any() *Any
- func (*PermsTx) Descriptor() ([]byte, []int)
- func (m *PermsTx) GetInput() *TxInput
- func (tx *PermsTx) GetInputs() []*TxInput
- func (m *PermsTx) GetPermArgs() permission.PermArgs
- func (m *PermsTx) Marshal() (dAtA []byte, err error)
- func (m *PermsTx) MarshalTo(dAtA []byte) (int, error)
- func (*PermsTx) ProtoMessage()
- func (m *PermsTx) Reset()
- func (m *PermsTx) Size() (n int)
- func (tx *PermsTx) String() string
- func (tx *PermsTx) Type() Type
- func (m *PermsTx) Unmarshal(dAtA []byte) error
- func (*PermsTx) XXX_MessageName() string
- type SendTx
- func (tx *SendTx) AddInput(st state.AccountGetter, pubkey crypto.PublicKey, amt uint64) error
- func (tx *SendTx) AddInputWithSequence(pubkey crypto.PublicKey, amt uint64, sequence uint64) error
- func (tx *SendTx) AddOutput(addr crypto.Address, amt uint64) error
- func (tx *SendTx) Any() *Any
- func (*SendTx) Descriptor() ([]byte, []int)
- func (tx *SendTx) GetInputs() []*TxInput
- func (m *SendTx) Marshal() (dAtA []byte, err error)
- func (m *SendTx) MarshalTo(dAtA []byte) (int, error)
- func (*SendTx) ProtoMessage()
- func (m *SendTx) Reset()
- func (m *SendTx) Size() (n int)
- func (tx *SendTx) String() string
- func (tx *SendTx) Type() Type
- func (m *SendTx) Unmarshal(dAtA []byte) error
- func (*SendTx) XXX_MessageName() string
- type TxInput
- func (*TxInput) Descriptor() ([]byte, []int)
- func (m *TxInput) GetAmount() uint64
- func (m *TxInput) GetSequence() uint64
- func (m *TxInput) Marshal() (dAtA []byte, err error)
- func (m *TxInput) MarshalTo(dAtA []byte) (int, error)
- func (*TxInput) ProtoMessage()
- func (m *TxInput) Reset()
- func (m *TxInput) Size() (n int)
- func (txIn *TxInput) String() string
- func (m *TxInput) Unmarshal(dAtA []byte) error
- func (*TxInput) XXX_MessageName() string
- type TxOutput
- func (*TxOutput) Descriptor() ([]byte, []int)
- func (m *TxOutput) GetAmount() uint64
- func (m *TxOutput) Marshal() (dAtA []byte, err error)
- func (m *TxOutput) MarshalTo(dAtA []byte) (int, error)
- func (*TxOutput) ProtoMessage()
- func (m *TxOutput) Reset()
- func (m *TxOutput) Size() (n int)
- func (txOut *TxOutput) String() string
- func (m *TxOutput) Unmarshal(dAtA []byte) error
- func (*TxOutput) XXX_MessageName() string
- type Type
- type UnbondTx
- func (tx *UnbondTx) Any() *Any
- func (*UnbondTx) Descriptor() ([]byte, []int)
- func (tx *UnbondTx) GetInputs() []*TxInput
- func (m *UnbondTx) Marshal() (dAtA []byte, err error)
- func (m *UnbondTx) MarshalTo(dAtA []byte) (int, error)
- func (*UnbondTx) ProtoMessage()
- func (m *UnbondTx) Reset()
- func (m *UnbondTx) Size() (n int)
- func (tx *UnbondTx) String() string
- func (tx *UnbondTx) Type() Type
- func (m *UnbondTx) Unmarshal(dAtA []byte) error
- func (*UnbondTx) XXX_MessageName() string
- type UnknownTx
Constants ¶
const ( TypeUnknown = Type(0x00) // Account transactions TypeSend = Type(0x01) TypeCall = Type(0x02) TypeName = Type(0x03) // Validation transactions TypeBond = Type(0x11) TypeUnbond = Type(0x12) // Admin transactions TypePermissions = Type(0x21) TypeGovernance = Type(0x22) )
Types of Payload implementations
Variables ¶
var ( ErrInvalidLengthPayload = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowPayload = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type Any ¶ added in v0.20.0
type Any struct { CallTx *CallTx `protobuf:"bytes,1,opt,name=CallTx" json:"CallTx,omitempty"` SendTx *SendTx `protobuf:"bytes,2,opt,name=SendTx" json:"SendTx,omitempty"` NameTx *NameTx `protobuf:"bytes,3,opt,name=NameTx" json:"NameTx,omitempty"` PermsTx *PermsTx `protobuf:"bytes,4,opt,name=PermsTx" json:"PermsTx,omitempty"` GovTx *GovTx `protobuf:"bytes,5,opt,name=GovTx" json:"GovTx,omitempty"` BondTx *BondTx `protobuf:"bytes,6,opt,name=BondTx" json:"BondTx,omitempty"` UnbondTx *UnbondTx `protobuf:"bytes,7,opt,name=UnbondTx" json:"UnbondTx,omitempty"` }
func (*Any) Descriptor ¶ added in v0.20.0
func (*Any) GetPermsTx ¶ added in v0.20.0
func (*Any) GetUnbondTx ¶ added in v0.20.0
func (*Any) ProtoMessage ¶ added in v0.20.0
func (*Any) ProtoMessage()
func (*Any) XXX_MessageName ¶ added in v0.20.0
type BondTx ¶
type BondTx struct { Inputs []*TxInput `protobuf:"bytes,1,rep,name=Inputs" json:"Inputs,omitempty"` UnbondTo []*TxOutput `protobuf:"bytes,2,rep,name=UnbondTo" json:"UnbondTo,omitempty"` }
func (*BondTx) AddInputWithSequence ¶
func (*BondTx) Descriptor ¶ added in v0.20.0
func (*BondTx) ProtoMessage ¶ added in v0.20.0
func (*BondTx) ProtoMessage()
func (*BondTx) XXX_MessageName ¶ added in v0.20.0
type CallTx ¶
type CallTx struct { // The caller's input Input *TxInput `protobuf:"bytes,1,opt,name=Input" json:"Input,omitempty"` // The contract address to call or nil if we are creating a contract Address *github_com_hyperledger_burrow_crypto.Address `protobuf:"bytes,2,opt,name=Address,proto3,customtype=github.com/hyperledger/burrow/crypto.Address" json:"Address,omitempty"` // The upper bound on the amount of gas (and therefore EVM execution steps) this CallTx may generate GasLimit uint64 `protobuf:"varint,3,opt,name=GasLimit,proto3" json:"GasLimit,omitempty"` // Fee to offer validators for processing transaction Fee uint64 `protobuf:"varint,4,opt,name=Fee,proto3" json:"Fee,omitempty"` // EVM bytecode payload Data github_com_hyperledger_burrow_binary.HexBytes `protobuf:"bytes,5,opt,name=Data,proto3,customtype=github.com/hyperledger/burrow/binary.HexBytes" json:"Data"` }
A instruction to run smart contract code in the EVM
func NewCallTxWithSequence ¶
func (*CallTx) CreatesContractAddress ¶ added in v0.20.0
Returns the contract address that this CallTx would create if CallTx.Address == nil otherwise returns nil
func (*CallTx) Descriptor ¶ added in v0.20.0
func (*CallTx) GetGasLimit ¶ added in v0.20.0
func (*CallTx) ProtoMessage ¶ added in v0.20.0
func (*CallTx) ProtoMessage()
func (*CallTx) XXX_MessageName ¶ added in v0.20.0
type ErrTxInvalidSequence ¶
func (ErrTxInvalidSequence) Error ¶
func (e ErrTxInvalidSequence) Error() string
func (ErrTxInvalidSequence) ErrorCode ¶ added in v0.20.0
func (e ErrTxInvalidSequence) ErrorCode() errors.Code
type GovTx ¶ added in v0.20.0
type GovTx struct { Inputs []*TxInput `protobuf:"bytes,1,rep,name=Inputs" json:"Inputs,omitempty"` AccountUpdates []*spec.TemplateAccount `protobuf:"bytes,2,rep,name=AccountUpdates" json:"AccountUpdates,omitempty"` }
func (*GovTx) Descriptor ¶ added in v0.20.0
func (*GovTx) ProtoMessage ¶ added in v0.20.0
func (*GovTx) ProtoMessage()
func (*GovTx) XXX_MessageName ¶ added in v0.20.0
type NameTx ¶
type NameTx struct { // The name updater Input *TxInput `protobuf:"bytes,1,opt,name=Input" json:"Input,omitempty"` // The name to update or create Name string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"` // The data to store against the name Data string `protobuf:"bytes,3,opt,name=Data,proto3" json:"Data,omitempty"` // The fee to provide that will determine the lenght of the name lease Fee uint64 `protobuf:"varint,4,opt,name=Fee,proto3" json:"Fee,omitempty"` }
A request to claim a globally unique name across the entire chain with some optional data storage leased for a fee
func NewNameTxWithSequence ¶
func (*NameTx) Descriptor ¶ added in v0.20.0
func (*NameTx) ProtoMessage ¶ added in v0.20.0
func (*NameTx) ProtoMessage()
func (*NameTx) XXX_MessageName ¶ added in v0.20.0
type Payload ¶
type PermsTx ¶ added in v0.20.0
type PermsTx struct { // The permission moderator Input *TxInput `protobuf:"bytes,1,opt,name=Input" json:"Input,omitempty"` // The modified permissions PermArgs permission.PermArgs `protobuf:"bytes,2,opt,name=PermArgs" json:"PermArgs"` }
An update to the on-chain permissions
func NewPermsTx ¶ added in v0.20.0
func NewPermsTx(st state.AccountGetter, from crypto.PublicKey, args permission.PermArgs) (*PermsTx, error)
func NewPermsTxWithSequence ¶ added in v0.20.0
func (*PermsTx) Descriptor ¶ added in v0.20.0
func (*PermsTx) GetPermArgs ¶ added in v0.20.0
func (m *PermsTx) GetPermArgs() permission.PermArgs
func (*PermsTx) ProtoMessage ¶ added in v0.20.0
func (*PermsTx) ProtoMessage()
func (*PermsTx) XXX_MessageName ¶ added in v0.20.0
type SendTx ¶
type SendTx struct { // The payers Inputs []*TxInput `protobuf:"bytes,1,rep,name=Inputs" json:"Inputs,omitempty"` // The payees Outputs []*TxOutput `protobuf:"bytes,2,rep,name=Outputs" json:"Outputs,omitempty"` }
A payment between two sets of parties
func (*SendTx) AddInputWithSequence ¶
func (*SendTx) Descriptor ¶ added in v0.20.0
func (*SendTx) ProtoMessage ¶ added in v0.20.0
func (*SendTx) ProtoMessage()
func (*SendTx) XXX_MessageName ¶ added in v0.20.0
type TxInput ¶
type TxInput struct { // The address from which this input flows Address github_com_hyperledger_burrow_crypto.Address `protobuf:"bytes,1,opt,name=Address,proto3,customtype=github.com/hyperledger/burrow/crypto.Address" json:"Address"` // The amount of native token to transfer from the input address Amount uint64 `protobuf:"varint,2,opt,name=Amount,proto3" json:"Amount,omitempty"` // The sequence number that this transaction will induce (i.e. one greater than the input account's current sequence) Sequence uint64 `protobuf:"varint,3,opt,name=Sequence,proto3" json:"Sequence,omitempty"` }
An input to a transaction that may carry an Amount as a charge and whose sequence number must be one greater than that associated with the account at Address at the time of being received
func (*TxInput) Descriptor ¶ added in v0.20.0
func (*TxInput) GetSequence ¶ added in v0.20.0
func (*TxInput) ProtoMessage ¶ added in v0.20.0
func (*TxInput) ProtoMessage()
func (*TxInput) XXX_MessageName ¶ added in v0.20.0
type TxOutput ¶
type TxOutput struct { // The address to which this output flows Address github_com_hyperledger_burrow_crypto.Address `protobuf:"bytes,1,opt,name=Address,proto3,customtype=github.com/hyperledger/burrow/crypto.Address" json:"Address"` // The amount of native token to transfer to the output address Amount uint64 `protobuf:"varint,2,opt,name=Amount,proto3" json:"Amount,omitempty"` }
An output from a transaction that may carry an amount as a charge
func (*TxOutput) Descriptor ¶ added in v0.20.0
func (*TxOutput) ProtoMessage ¶ added in v0.20.0
func (*TxOutput) ProtoMessage()
func (*TxOutput) XXX_MessageName ¶ added in v0.20.0
type Type ¶
type Type uint32
func TxTypeFromString ¶
func (Type) MarshalText ¶
func (*Type) UnmarshalText ¶
type UnbondTx ¶
type UnbondTx struct { Input *TxInput `protobuf:"bytes,1,opt,name=Input" json:"Input,omitempty"` Address github_com_hyperledger_burrow_crypto.Address `protobuf:"bytes,2,opt,name=Address,proto3,customtype=github.com/hyperledger/burrow/crypto.Address" json:"Address"` Height uint64 `protobuf:"varint,3,opt,name=Height,proto3" json:"Height,omitempty"` }
func (*UnbondTx) Descriptor ¶ added in v0.20.0
func (*UnbondTx) ProtoMessage ¶ added in v0.20.0
func (*UnbondTx) ProtoMessage()