Documentation
¶
Index ¶
- Variables
- type AccountInfo
- func (*AccountInfo) Descriptor() ([]byte, []int)deprecated
- func (x *AccountInfo) GetActiveKey() []byte
- func (x *AccountInfo) GetName() string
- func (x *AccountInfo) GetOwnerKey() []byte
- func (*AccountInfo) ProtoMessage()
- func (x *AccountInfo) ProtoReflect() protoreflect.Message
- func (x *AccountInfo) Reset()
- func (x *AccountInfo) String() string
- type Action
- func (*Action) Descriptor() ([]byte, []int)deprecated
- func (x *Action) GetActionName() string
- func (x *Action) GetContract() string
- func (x *Action) GetData() string
- func (*Action) ProtoMessage()
- func (x *Action) ProtoReflect() protoreflect.Message
- func (x *Action) Reset()
- func (x *Action) String() string
- type Algorithm
- type AmountLimit
- type Signature
- func (*Signature) Descriptor() ([]byte, []int)deprecated
- func (x *Signature) GetAlgorithm() Algorithm
- func (x *Signature) GetPublicKey() []byte
- func (x *Signature) GetSignature() []byte
- func (*Signature) ProtoMessage()
- func (x *Signature) ProtoReflect() protoreflect.Message
- func (x *Signature) Reset()
- func (x *Signature) String() string
- type SigningInput
- func (*SigningInput) Descriptor() ([]byte, []int)deprecated
- func (x *SigningInput) GetAccount() *AccountInfo
- func (x *SigningInput) GetTransactionTemplate() *Transaction
- func (x *SigningInput) GetTransferAmount() string
- func (x *SigningInput) GetTransferDestination() string
- func (x *SigningInput) GetTransferMemo() string
- func (*SigningInput) ProtoMessage()
- func (x *SigningInput) ProtoReflect() protoreflect.Message
- func (x *SigningInput) Reset()
- func (x *SigningInput) String() string
- type SigningOutput
- func (*SigningOutput) Descriptor() ([]byte, []int)deprecated
- func (x *SigningOutput) GetEncoded() []byte
- func (x *SigningOutput) GetError() common.SigningError
- func (x *SigningOutput) GetErrorMessage() string
- func (x *SigningOutput) GetTransaction() *Transaction
- func (*SigningOutput) ProtoMessage()
- func (x *SigningOutput) ProtoReflect() protoreflect.Message
- func (x *SigningOutput) Reset()
- func (x *SigningOutput) String() string
- type Transaction
- func (*Transaction) Descriptor() ([]byte, []int)deprecated
- func (x *Transaction) GetActions() []*Action
- func (x *Transaction) GetAmountLimit() []*AmountLimit
- func (x *Transaction) GetChainId() uint32
- func (x *Transaction) GetDelay() int64
- func (x *Transaction) GetExpiration() int64
- func (x *Transaction) GetGasLimit() float64
- func (x *Transaction) GetGasRatio() float64
- func (x *Transaction) GetPublisher() string
- func (x *Transaction) GetPublisherSigs() []*Signature
- func (x *Transaction) GetSignatures() []*Signature
- func (x *Transaction) GetSigners() []string
- func (x *Transaction) GetTime() int64
- func (*Transaction) ProtoMessage()
- func (x *Transaction) ProtoReflect() protoreflect.Message
- func (x *Transaction) Reset()
- func (x *Transaction) String() string
Constants ¶
This section is empty.
Variables ¶
var ( Algorithm_name = map[int32]string{ 0: "UNKNOWN", 1: "SECP256K1", 2: "ED25519", } Algorithm_value = map[string]int32{ "UNKNOWN": 0, "SECP256K1": 1, "ED25519": 2, } )
Enum value maps for Algorithm.
var File_IOST_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AccountInfo ¶
type AccountInfo struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` ActiveKey []byte `protobuf:"bytes,2,opt,name=active_key,json=activeKey,proto3" json:"active_key,omitempty"` OwnerKey []byte `protobuf:"bytes,3,opt,name=owner_key,json=ownerKey,proto3" json:"owner_key,omitempty"` // contains filtered or unexported fields }
func (*AccountInfo) Descriptor
deprecated
func (*AccountInfo) Descriptor() ([]byte, []int)
Deprecated: Use AccountInfo.ProtoReflect.Descriptor instead.
func (*AccountInfo) GetActiveKey ¶
func (x *AccountInfo) GetActiveKey() []byte
func (*AccountInfo) GetName ¶
func (x *AccountInfo) GetName() string
func (*AccountInfo) GetOwnerKey ¶
func (x *AccountInfo) GetOwnerKey() []byte
func (*AccountInfo) ProtoMessage ¶
func (*AccountInfo) ProtoMessage()
func (*AccountInfo) ProtoReflect ¶
func (x *AccountInfo) ProtoReflect() protoreflect.Message
func (*AccountInfo) Reset ¶
func (x *AccountInfo) Reset()
func (*AccountInfo) String ¶
func (x *AccountInfo) String() string
type Action ¶
type Action struct { // contract name Contract string `protobuf:"bytes,1,opt,name=contract,proto3" json:"contract,omitempty"` // action name ActionName string `protobuf:"bytes,2,opt,name=action_name,json=actionName,proto3" json:"action_name,omitempty"` // data Data string `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
The message defines transaction action struct.
func (*Action) Descriptor
deprecated
func (*Action) GetActionName ¶
func (*Action) GetContract ¶
func (*Action) ProtoMessage ¶
func (*Action) ProtoMessage()
func (*Action) ProtoReflect ¶
func (x *Action) ProtoReflect() protoreflect.Message
type Algorithm ¶
type Algorithm int32
The enumeration defines the signature algorithm.
func (Algorithm) Descriptor ¶
func (Algorithm) Descriptor() protoreflect.EnumDescriptor
func (Algorithm) EnumDescriptor
deprecated
func (Algorithm) Number ¶
func (x Algorithm) Number() protoreflect.EnumNumber
func (Algorithm) Type ¶
func (Algorithm) Type() protoreflect.EnumType
type AmountLimit ¶
type AmountLimit struct { // token name Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` // limit value Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
The message defines transaction amount limit struct.
func (*AmountLimit) Descriptor
deprecated
func (*AmountLimit) Descriptor() ([]byte, []int)
Deprecated: Use AmountLimit.ProtoReflect.Descriptor instead.
func (*AmountLimit) GetToken ¶
func (x *AmountLimit) GetToken() string
func (*AmountLimit) GetValue ¶
func (x *AmountLimit) GetValue() string
func (*AmountLimit) ProtoMessage ¶
func (*AmountLimit) ProtoMessage()
func (*AmountLimit) ProtoReflect ¶
func (x *AmountLimit) ProtoReflect() protoreflect.Message
func (*AmountLimit) Reset ¶
func (x *AmountLimit) Reset()
func (*AmountLimit) String ¶
func (x *AmountLimit) String() string
type Signature ¶
type Signature struct { // signature algorithm Algorithm Algorithm `protobuf:"varint,1,opt,name=algorithm,proto3,enum=TW.IOST.Proto.Algorithm" json:"algorithm,omitempty"` // signature bytes Signature []byte `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"` // public key PublicKey []byte `protobuf:"bytes,3,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"` // contains filtered or unexported fields }
The message defines signature struct.
func (*Signature) Descriptor
deprecated
func (*Signature) GetAlgorithm ¶
func (*Signature) GetPublicKey ¶
func (*Signature) GetSignature ¶
func (*Signature) ProtoMessage ¶
func (*Signature) ProtoMessage()
func (*Signature) ProtoReflect ¶
func (x *Signature) ProtoReflect() protoreflect.Message
type SigningInput ¶
type SigningInput struct { Account *AccountInfo `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"` TransactionTemplate *Transaction `protobuf:"bytes,2,opt,name=transaction_template,json=transactionTemplate,proto3" json:"transaction_template,omitempty"` TransferDestination string `protobuf:"bytes,3,opt,name=transfer_destination,json=transferDestination,proto3" json:"transfer_destination,omitempty"` TransferAmount string `protobuf:"bytes,4,opt,name=transfer_amount,json=transferAmount,proto3" json:"transfer_amount,omitempty"` TransferMemo string `protobuf:"bytes,5,opt,name=transfer_memo,json=transferMemo,proto3" json:"transfer_memo,omitempty"` // contains filtered or unexported fields }
Input data necessary to create a signed transaction.
func (*SigningInput) Descriptor
deprecated
func (*SigningInput) Descriptor() ([]byte, []int)
Deprecated: Use SigningInput.ProtoReflect.Descriptor instead.
func (*SigningInput) GetAccount ¶
func (x *SigningInput) GetAccount() *AccountInfo
func (*SigningInput) GetTransactionTemplate ¶
func (x *SigningInput) GetTransactionTemplate() *Transaction
func (*SigningInput) GetTransferAmount ¶
func (x *SigningInput) GetTransferAmount() string
func (*SigningInput) GetTransferDestination ¶
func (x *SigningInput) GetTransferDestination() string
func (*SigningInput) GetTransferMemo ¶
func (x *SigningInput) GetTransferMemo() string
func (*SigningInput) ProtoMessage ¶
func (*SigningInput) ProtoMessage()
func (*SigningInput) ProtoReflect ¶
func (x *SigningInput) ProtoReflect() protoreflect.Message
func (*SigningInput) Reset ¶
func (x *SigningInput) Reset()
func (*SigningInput) String ¶
func (x *SigningInput) String() string
type SigningOutput ¶
type SigningOutput struct { // Signed transaction Transaction *Transaction `protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"` // Signed and encoded transaction bytes. Encoded []byte `protobuf:"bytes,2,opt,name=encoded,proto3" json:"encoded,omitempty"` // error code, 0 is ok, other codes will be treated as errors Error common.SigningError `protobuf:"varint,3,opt,name=error,proto3,enum=TW.Common.Proto.SigningError" json:"error,omitempty"` // error code description ErrorMessage string `protobuf:"bytes,4,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"` // contains filtered or unexported fields }
Transaction signing output.
func (*SigningOutput) Descriptor
deprecated
func (*SigningOutput) Descriptor() ([]byte, []int)
Deprecated: Use SigningOutput.ProtoReflect.Descriptor instead.
func (*SigningOutput) GetEncoded ¶
func (x *SigningOutput) GetEncoded() []byte
func (*SigningOutput) GetError ¶
func (x *SigningOutput) GetError() common.SigningError
func (*SigningOutput) GetErrorMessage ¶
func (x *SigningOutput) GetErrorMessage() string
func (*SigningOutput) GetTransaction ¶
func (x *SigningOutput) GetTransaction() *Transaction
func (*SigningOutput) ProtoMessage ¶
func (*SigningOutput) ProtoMessage()
func (*SigningOutput) ProtoReflect ¶
func (x *SigningOutput) ProtoReflect() protoreflect.Message
func (*SigningOutput) Reset ¶
func (x *SigningOutput) Reset()
func (*SigningOutput) String ¶
func (x *SigningOutput) String() string
type Transaction ¶
type Transaction struct { // transaction timestamp Time int64 `protobuf:"varint,1,opt,name=time,proto3" json:"time,omitempty"` // expiration timestamp Expiration int64 `protobuf:"varint,2,opt,name=expiration,proto3" json:"expiration,omitempty"` // gas price GasRatio float64 `protobuf:"fixed64,3,opt,name=gas_ratio,json=gasRatio,proto3" json:"gas_ratio,omitempty"` // gas limit GasLimit float64 `protobuf:"fixed64,4,opt,name=gas_limit,json=gasLimit,proto3" json:"gas_limit,omitempty"` // delay nanoseconds Delay int64 `protobuf:"varint,5,opt,name=delay,proto3" json:"delay,omitempty"` // chain id ChainId uint32 `protobuf:"varint,6,opt,name=chain_id,json=chainId,proto3" json:"chain_id,omitempty"` // action list Actions []*Action `protobuf:"bytes,7,rep,name=actions,proto3" json:"actions,omitempty"` // amount limit AmountLimit []*AmountLimit `protobuf:"bytes,8,rep,name=amount_limit,json=amountLimit,proto3" json:"amount_limit,omitempty"` // signer list Signers []string `protobuf:"bytes,9,rep,name=signers,proto3" json:"signers,omitempty"` // signatures of signers Signatures []*Signature `protobuf:"bytes,10,rep,name=signatures,proto3" json:"signatures,omitempty"` // publisher Publisher string `protobuf:"bytes,11,opt,name=publisher,proto3" json:"publisher,omitempty"` // signatures of publisher PublisherSigs []*Signature `protobuf:"bytes,12,rep,name=publisher_sigs,json=publisherSigs,proto3" json:"publisher_sigs,omitempty"` // contains filtered or unexported fields }
The message defines the transaction request.
func (*Transaction) Descriptor
deprecated
func (*Transaction) Descriptor() ([]byte, []int)
Deprecated: Use Transaction.ProtoReflect.Descriptor instead.
func (*Transaction) GetActions ¶
func (x *Transaction) GetActions() []*Action
func (*Transaction) GetAmountLimit ¶
func (x *Transaction) GetAmountLimit() []*AmountLimit
func (*Transaction) GetChainId ¶
func (x *Transaction) GetChainId() uint32
func (*Transaction) GetDelay ¶
func (x *Transaction) GetDelay() int64
func (*Transaction) GetExpiration ¶
func (x *Transaction) GetExpiration() int64
func (*Transaction) GetGasLimit ¶
func (x *Transaction) GetGasLimit() float64
func (*Transaction) GetGasRatio ¶
func (x *Transaction) GetGasRatio() float64
func (*Transaction) GetPublisher ¶
func (x *Transaction) GetPublisher() string
func (*Transaction) GetPublisherSigs ¶
func (x *Transaction) GetPublisherSigs() []*Signature
func (*Transaction) GetSignatures ¶
func (x *Transaction) GetSignatures() []*Signature
func (*Transaction) GetSigners ¶
func (x *Transaction) GetSigners() []string
func (*Transaction) GetTime ¶
func (x *Transaction) GetTime() int64
func (*Transaction) ProtoMessage ¶
func (*Transaction) ProtoMessage()
func (*Transaction) ProtoReflect ¶
func (x *Transaction) ProtoReflect() protoreflect.Message
func (*Transaction) Reset ¶
func (x *Transaction) Reset()
func (*Transaction) String ¶
func (x *Transaction) String() string