Documentation
¶
Index ¶
- Variables
- type EntryFunction
- func (*EntryFunction) Descriptor() ([]byte, []int)deprecated
- func (x *EntryFunction) GetArgs() [][]byte
- func (x *EntryFunction) GetFunctionName() string
- func (x *EntryFunction) GetModuleAddress() []byte
- func (x *EntryFunction) GetModuleName() string
- func (x *EntryFunction) GetTypeArgs() [][]byte
- func (*EntryFunction) ProtoMessage()
- func (x *EntryFunction) ProtoReflect() protoreflect.Message
- func (x *EntryFunction) Reset()
- func (x *EntryFunction) String() string
- type SigningInput
- func (*SigningInput) Descriptor() ([]byte, []int)deprecated
- func (x *SigningInput) GetChainId() uint32
- func (x *SigningInput) GetEntryFunction() *EntryFunction
- func (x *SigningInput) GetExpirationTimestampSecs() uint64
- func (x *SigningInput) GetGasUnitPrice() uint64
- func (x *SigningInput) GetMaxGasAmount() uint64
- func (x *SigningInput) GetSequenceNumber() uint64
- func (x *SigningInput) GetTransfer() *TransferMessage
- 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() string
- func (x *SigningOutput) GetError() string
- func (x *SigningOutput) GetRawTxn() []byte
- func (*SigningOutput) ProtoMessage()
- func (x *SigningOutput) ProtoReflect() protoreflect.Message
- func (x *SigningOutput) Reset()
- func (x *SigningOutput) String() string
- type TransferMessage
- func (*TransferMessage) Descriptor() ([]byte, []int)deprecated
- func (x *TransferMessage) GetAmount() uint64
- func (x *TransferMessage) GetTo() string
- func (*TransferMessage) ProtoMessage()
- func (x *TransferMessage) ProtoReflect() protoreflect.Message
- func (x *TransferMessage) Reset()
- func (x *TransferMessage) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_txproto_aptos_aptos_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type EntryFunction ¶
type EntryFunction struct {
// 32-byte module address (raw bytes, not hex string).
ModuleAddress []byte `protobuf:"bytes,1,opt,name=module_address,json=moduleAddress,proto3" json:"module_address,omitempty"`
// Module name, e.g. "aptos_account".
ModuleName string `protobuf:"bytes,2,opt,name=module_name,json=moduleName,proto3" json:"module_name,omitempty"`
// Function name, e.g. "transfer".
FunctionName string `protobuf:"bytes,3,opt,name=function_name,json=functionName,proto3" json:"function_name,omitempty"`
// BCS-encoded TypeTag bytes for each type argument. Empty for most transfers.
TypeArgs [][]byte `protobuf:"bytes,4,rep,name=type_args,json=typeArgs,proto3" json:"type_args,omitempty"`
// Raw argument bytes. Each arg is already BCS-length-prefixed when it is a
// byte sequence; the signer re-wraps them with ULEB128(len) + bytes.
Args [][]byte `protobuf:"bytes,5,rep,name=args,proto3" json:"args,omitempty"`
// contains filtered or unexported fields
}
EntryFunction payload for an Aptos transaction.
func (*EntryFunction) Descriptor
deprecated
func (*EntryFunction) Descriptor() ([]byte, []int)
Deprecated: Use EntryFunction.ProtoReflect.Descriptor instead.
func (*EntryFunction) GetArgs ¶
func (x *EntryFunction) GetArgs() [][]byte
func (*EntryFunction) GetFunctionName ¶
func (x *EntryFunction) GetFunctionName() string
func (*EntryFunction) GetModuleAddress ¶
func (x *EntryFunction) GetModuleAddress() []byte
func (*EntryFunction) GetModuleName ¶
func (x *EntryFunction) GetModuleName() string
func (*EntryFunction) GetTypeArgs ¶
func (x *EntryFunction) GetTypeArgs() [][]byte
func (*EntryFunction) ProtoMessage ¶
func (*EntryFunction) ProtoMessage()
func (*EntryFunction) ProtoReflect ¶
func (x *EntryFunction) ProtoReflect() protoreflect.Message
func (*EntryFunction) Reset ¶
func (x *EntryFunction) Reset()
func (*EntryFunction) String ¶
func (x *EntryFunction) String() string
type SigningInput ¶
type SigningInput struct {
// Account sequence number (uint64 LE in BCS).
SequenceNumber uint64 `protobuf:"varint,1,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
// Gas limit.
MaxGasAmount uint64 `protobuf:"varint,2,opt,name=max_gas_amount,json=maxGasAmount,proto3" json:"max_gas_amount,omitempty"`
// Gas unit price in octas.
GasUnitPrice uint64 `protobuf:"varint,3,opt,name=gas_unit_price,json=gasUnitPrice,proto3" json:"gas_unit_price,omitempty"`
// Transaction expiration (Unix timestamp in seconds).
ExpirationTimestampSecs uint64 `` /* 133-byte string literal not displayed */
// Chain ID (u8).
ChainId uint32 `protobuf:"varint,5,opt,name=chain_id,json=chainId,proto3" json:"chain_id,omitempty"`
// The entry function payload. Mutually exclusive with transfer.
EntryFunction *EntryFunction `protobuf:"bytes,6,opt,name=entry_function,json=entryFunction,proto3" json:"entry_function,omitempty"`
// Structured native APT transfer. Mutually exclusive with entry_function.
Transfer *TransferMessage `protobuf:"bytes,7,opt,name=transfer,proto3" json:"transfer,omitempty"`
// contains filtered or unexported fields
}
SigningInput mirrors a minimal subset of TW.Aptos.Proto.SigningInput.
func (*SigningInput) Descriptor
deprecated
func (*SigningInput) Descriptor() ([]byte, []int)
Deprecated: Use SigningInput.ProtoReflect.Descriptor instead.
func (*SigningInput) GetChainId ¶
func (x *SigningInput) GetChainId() uint32
func (*SigningInput) GetEntryFunction ¶
func (x *SigningInput) GetEntryFunction() *EntryFunction
func (*SigningInput) GetExpirationTimestampSecs ¶
func (x *SigningInput) GetExpirationTimestampSecs() uint64
func (*SigningInput) GetGasUnitPrice ¶
func (x *SigningInput) GetGasUnitPrice() uint64
func (*SigningInput) GetMaxGasAmount ¶
func (x *SigningInput) GetMaxGasAmount() uint64
func (*SigningInput) GetSequenceNumber ¶
func (x *SigningInput) GetSequenceNumber() uint64
func (*SigningInput) GetTransfer ¶ added in v0.14.0
func (x *SigningInput) GetTransfer() *TransferMessage
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 {
// BCS-encoded SignedTransaction bytes.
RawTxn []byte `protobuf:"bytes,1,opt,name=raw_txn,json=rawTxn,proto3" json:"raw_txn,omitempty"`
// Hex of raw_txn.
Encoded string `protobuf:"bytes,2,opt,name=encoded,proto3" json:"encoded,omitempty"`
// Error message; empty on success.
Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
SigningOutput mirrors a minimal subset of TW.Aptos.Proto.SigningOutput.
func (*SigningOutput) Descriptor
deprecated
func (*SigningOutput) Descriptor() ([]byte, []int)
Deprecated: Use SigningOutput.ProtoReflect.Descriptor instead.
func (*SigningOutput) GetEncoded ¶
func (x *SigningOutput) GetEncoded() string
func (*SigningOutput) GetError ¶
func (x *SigningOutput) GetError() string
func (*SigningOutput) GetRawTxn ¶
func (x *SigningOutput) GetRawTxn() []byte
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 TransferMessage ¶ added in v0.14.0
type TransferMessage struct {
// 0x-prefixed 32-byte recipient account address.
To string `protobuf:"bytes,1,opt,name=to,proto3" json:"to,omitempty"`
// Amount to transfer, in octas.
Amount uint64 `protobuf:"varint,2,opt,name=amount,proto3" json:"amount,omitempty"`
// contains filtered or unexported fields
}
Structured native APT transfer (0x1::aptos_account::transfer). The library builds the EntryFunction internally — no hand-BCS'd args.
func (*TransferMessage) Descriptor
deprecated
added in
v0.14.0
func (*TransferMessage) Descriptor() ([]byte, []int)
Deprecated: Use TransferMessage.ProtoReflect.Descriptor instead.
func (*TransferMessage) GetAmount ¶ added in v0.14.0
func (x *TransferMessage) GetAmount() uint64
func (*TransferMessage) GetTo ¶ added in v0.14.0
func (x *TransferMessage) GetTo() string
func (*TransferMessage) ProtoMessage ¶ added in v0.14.0
func (*TransferMessage) ProtoMessage()
func (*TransferMessage) ProtoReflect ¶ added in v0.14.0
func (x *TransferMessage) ProtoReflect() protoreflect.Message
func (*TransferMessage) Reset ¶ added in v0.14.0
func (x *TransferMessage) Reset()
func (*TransferMessage) String ¶ added in v0.14.0
func (x *TransferMessage) String() string
Click to show internal directories.
Click to hide internal directories.