sui

package
v0.0.1-gowrapper-dev Latest Latest
Warning

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

Go to latest
Published: Jul 23, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

Functions

This section is empty.

Types

type Amount

type Amount struct {
	Amount uint64 `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`
	// contains filtered or unexported fields
}

Optional amount.

func (*Amount) Descriptor deprecated

func (*Amount) Descriptor() ([]byte, []int)

Deprecated: Use Amount.ProtoReflect.Descriptor instead.

func (*Amount) GetAmount

func (x *Amount) GetAmount() uint64

func (*Amount) ProtoMessage

func (*Amount) ProtoMessage()

func (*Amount) ProtoReflect

func (x *Amount) ProtoReflect() protoreflect.Message

func (*Amount) Reset

func (x *Amount) Reset()

func (*Amount) String

func (x *Amount) String() string

type MessageSigningInput

type MessageSigningInput struct {

	// The secret private key used for signing (32 bytes).
	PrivateKey []byte `protobuf:"bytes,1,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	// A UTF-8 regular message to sign.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Message signing input.

func (*MessageSigningInput) Descriptor deprecated

func (*MessageSigningInput) Descriptor() ([]byte, []int)

Deprecated: Use MessageSigningInput.ProtoReflect.Descriptor instead.

func (*MessageSigningInput) GetMessage

func (x *MessageSigningInput) GetMessage() string

func (*MessageSigningInput) GetPrivateKey

func (x *MessageSigningInput) GetPrivateKey() []byte

func (*MessageSigningInput) ProtoMessage

func (*MessageSigningInput) ProtoMessage()

func (*MessageSigningInput) ProtoReflect

func (x *MessageSigningInput) ProtoReflect() protoreflect.Message

func (*MessageSigningInput) Reset

func (x *MessageSigningInput) Reset()

func (*MessageSigningInput) String

func (x *MessageSigningInput) String() string

type MessageSigningOutput

type MessageSigningOutput struct {

	// The signature, a 97-byte array encoded in base64.
	// The first byte indicates the signature scheme (currently set to 0x00, as we only support ED25519).
	// The following 64 bytes represent the raw ED25519 signature, while the next 32 bytes contain the public key.
	Signature string `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"`
	// error code, 0 is ok, other codes will be treated as errors
	Error common.SigningError `protobuf:"varint,2,opt,name=error,proto3,enum=TW.Common.Proto.SigningError" json:"error,omitempty"`
	// error code description
	ErrorMessage string `protobuf:"bytes,3,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Message signing output.

func (*MessageSigningOutput) Descriptor deprecated

func (*MessageSigningOutput) Descriptor() ([]byte, []int)

Deprecated: Use MessageSigningOutput.ProtoReflect.Descriptor instead.

func (*MessageSigningOutput) GetError

func (*MessageSigningOutput) GetErrorMessage

func (x *MessageSigningOutput) GetErrorMessage() string

func (*MessageSigningOutput) GetSignature

func (x *MessageSigningOutput) GetSignature() string

func (*MessageSigningOutput) ProtoMessage

func (*MessageSigningOutput) ProtoMessage()

func (*MessageSigningOutput) ProtoReflect

func (x *MessageSigningOutput) ProtoReflect() protoreflect.Message

func (*MessageSigningOutput) Reset

func (x *MessageSigningOutput) Reset()

func (*MessageSigningOutput) String

func (x *MessageSigningOutput) String() string

type MessageVerifyingInput

type MessageVerifyingInput struct {

	// The message signed.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Public key that will verify the message.
	// It must be equal to the public key encoded in the signature.
	PublicKey []byte `protobuf:"bytes,2,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// The signature, a 97-byte array encoded in base64.
	// Same as the signature field in MessageSigningOutput.
	Signature string `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Message verifying input.

func (*MessageVerifyingInput) Descriptor deprecated

func (*MessageVerifyingInput) Descriptor() ([]byte, []int)

Deprecated: Use MessageVerifyingInput.ProtoReflect.Descriptor instead.

func (*MessageVerifyingInput) GetMessage

func (x *MessageVerifyingInput) GetMessage() string

func (*MessageVerifyingInput) GetPublicKey

func (x *MessageVerifyingInput) GetPublicKey() []byte

func (*MessageVerifyingInput) GetSignature

func (x *MessageVerifyingInput) GetSignature() string

func (*MessageVerifyingInput) ProtoMessage

func (*MessageVerifyingInput) ProtoMessage()

func (*MessageVerifyingInput) ProtoReflect

func (x *MessageVerifyingInput) ProtoReflect() protoreflect.Message

func (*MessageVerifyingInput) Reset

func (x *MessageVerifyingInput) Reset()

func (*MessageVerifyingInput) String

func (x *MessageVerifyingInput) String() string

type ObjectRef

type ObjectRef struct {

	// Hex string representing the object ID.
	ObjectId string `protobuf:"bytes,1,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// Object version.
	Version uint64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Base58 string representing the object digest.
	ObjectDigest string `protobuf:"bytes,3,opt,name=object_digest,json=objectDigest,proto3" json:"object_digest,omitempty"`
	// contains filtered or unexported fields
}

Object info (including Coins).

func (*ObjectRef) Descriptor deprecated

func (*ObjectRef) Descriptor() ([]byte, []int)

Deprecated: Use ObjectRef.ProtoReflect.Descriptor instead.

func (*ObjectRef) GetObjectDigest

func (x *ObjectRef) GetObjectDigest() string

func (*ObjectRef) GetObjectId

func (x *ObjectRef) GetObjectId() string

func (*ObjectRef) GetVersion

func (x *ObjectRef) GetVersion() uint64

func (*ObjectRef) ProtoMessage

func (*ObjectRef) ProtoMessage()

func (*ObjectRef) ProtoReflect

func (x *ObjectRef) ProtoReflect() protoreflect.Message

func (*ObjectRef) Reset

func (x *ObjectRef) Reset()

func (*ObjectRef) String

func (x *ObjectRef) String() string

type Pay

type Pay struct {

	// The Sui coins to be used in this transaction, including the coin for gas payment.
	InputCoins []*ObjectRef `protobuf:"bytes,1,rep,name=input_coins,json=inputCoins,proto3" json:"input_coins,omitempty"`
	// The recipients' addresses, the length of this vector must be the same as amounts.
	Recipients []string `protobuf:"bytes,2,rep,name=recipients,proto3" json:"recipients,omitempty"`
	// The amounts to be transferred to recipients, following the same order.
	Amounts []uint64 `protobuf:"varint,3,rep,packed,name=amounts,proto3" json:"amounts,omitempty"`
	// Gas object to be used in this transaction.
	Gas *ObjectRef `protobuf:"bytes,4,opt,name=gas,proto3" json:"gas,omitempty"`
	// contains filtered or unexported fields
}

Send `Coin<T>` to a list of addresses, where T can be any coin type, following a list of amounts. The object specified in the gas field will be used to pay the gas fee for the transaction. The gas object can not appear in input_coins. https://docs.sui.io/sui-api-ref#unsafe_pay

func (*Pay) Descriptor deprecated

func (*Pay) Descriptor() ([]byte, []int)

Deprecated: Use Pay.ProtoReflect.Descriptor instead.

func (*Pay) GetAmounts

func (x *Pay) GetAmounts() []uint64

func (*Pay) GetGas

func (x *Pay) GetGas() *ObjectRef

func (*Pay) GetInputCoins

func (x *Pay) GetInputCoins() []*ObjectRef

func (*Pay) GetRecipients

func (x *Pay) GetRecipients() []string

func (*Pay) ProtoMessage

func (*Pay) ProtoMessage()

func (*Pay) ProtoReflect

func (x *Pay) ProtoReflect() protoreflect.Message

func (*Pay) Reset

func (x *Pay) Reset()

func (*Pay) String

func (x *Pay) String() string

type PayAllSui

type PayAllSui struct {

	// The Sui coins to be used in this transaction, including the coin for gas payment.
	InputCoins []*ObjectRef `protobuf:"bytes,1,rep,name=input_coins,json=inputCoins,proto3" json:"input_coins,omitempty"`
	// The recipient address.
	Recipient string `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// contains filtered or unexported fields
}

Send all SUI coins to one recipient. This is for SUI coin only and does not require a separate gas coin object. https://docs.sui.io/sui-api-ref#unsafe_payallsui

func (*PayAllSui) Descriptor deprecated

func (*PayAllSui) Descriptor() ([]byte, []int)

Deprecated: Use PayAllSui.ProtoReflect.Descriptor instead.

func (*PayAllSui) GetInputCoins

func (x *PayAllSui) GetInputCoins() []*ObjectRef

func (*PayAllSui) GetRecipient

func (x *PayAllSui) GetRecipient() string

func (*PayAllSui) ProtoMessage

func (*PayAllSui) ProtoMessage()

func (*PayAllSui) ProtoReflect

func (x *PayAllSui) ProtoReflect() protoreflect.Message

func (*PayAllSui) Reset

func (x *PayAllSui) Reset()

func (*PayAllSui) String

func (x *PayAllSui) String() string

type PaySui

type PaySui struct {

	// The Sui coins to be used in this transaction, including the coin for gas payment.
	InputCoins []*ObjectRef `protobuf:"bytes,1,rep,name=input_coins,json=inputCoins,proto3" json:"input_coins,omitempty"`
	// The recipients' addresses, the length of this vector must be the same as amounts.
	Recipients []string `protobuf:"bytes,2,rep,name=recipients,proto3" json:"recipients,omitempty"`
	// The amounts to be transferred to recipients, following the same order.
	Amounts []uint64 `protobuf:"varint,3,rep,packed,name=amounts,proto3" json:"amounts,omitempty"`
	// contains filtered or unexported fields
}

Send SUI coins to a list of addresses, following a list of amounts. This is for SUI coin only and does not require a separate gas coin object. https://docs.sui.io/sui-api-ref#unsafe_paysui

func (*PaySui) Descriptor deprecated

func (*PaySui) Descriptor() ([]byte, []int)

Deprecated: Use PaySui.ProtoReflect.Descriptor instead.

func (*PaySui) GetAmounts

func (x *PaySui) GetAmounts() []uint64

func (*PaySui) GetInputCoins

func (x *PaySui) GetInputCoins() []*ObjectRef

func (*PaySui) GetRecipients

func (x *PaySui) GetRecipients() []string

func (*PaySui) ProtoMessage

func (*PaySui) ProtoMessage()

func (*PaySui) ProtoReflect

func (x *PaySui) ProtoReflect() protoreflect.Message

func (*PaySui) Reset

func (x *PaySui) Reset()

func (*PaySui) String

func (x *PaySui) String() string

type RequestAddStake

type RequestAddStake struct {

	// Coin<SUI> objects to stake.
	Coins []*ObjectRef `protobuf:"bytes,1,rep,name=coins,proto3" json:"coins,omitempty"`
	// Optional stake amount.
	Amount *Amount `protobuf:"bytes,2,opt,name=amount,proto3" json:"amount,omitempty"`
	// The validator's Sui address.
	Validator string `protobuf:"bytes,3,opt,name=validator,proto3" json:"validator,omitempty"`
	// Gas object to be used in this transaction.
	Gas *ObjectRef `protobuf:"bytes,4,opt,name=gas,proto3" json:"gas,omitempty"`
	// contains filtered or unexported fields
}

Add stake to a validator's staking pool using multiple coins and amount. https://docs.sui.io/sui-api-ref#unsafe_requestaddstake

func (*RequestAddStake) Descriptor deprecated

func (*RequestAddStake) Descriptor() ([]byte, []int)

Deprecated: Use RequestAddStake.ProtoReflect.Descriptor instead.

func (*RequestAddStake) GetAmount

func (x *RequestAddStake) GetAmount() *Amount

func (*RequestAddStake) GetCoins

func (x *RequestAddStake) GetCoins() []*ObjectRef

func (*RequestAddStake) GetGas

func (x *RequestAddStake) GetGas() *ObjectRef

func (*RequestAddStake) GetValidator

func (x *RequestAddStake) GetValidator() string

func (*RequestAddStake) ProtoMessage

func (*RequestAddStake) ProtoMessage()

func (*RequestAddStake) ProtoReflect

func (x *RequestAddStake) ProtoReflect() protoreflect.Message

func (*RequestAddStake) Reset

func (x *RequestAddStake) Reset()

func (*RequestAddStake) String

func (x *RequestAddStake) String() string

type RequestWithdrawStake

type RequestWithdrawStake struct {

	// StakedSui object ID.
	StakedSui *ObjectRef `protobuf:"bytes,1,opt,name=staked_sui,json=stakedSui,proto3" json:"staked_sui,omitempty"`
	// Gas object to be used in this transaction.
	Gas *ObjectRef `protobuf:"bytes,2,opt,name=gas,proto3" json:"gas,omitempty"`
	// contains filtered or unexported fields
}

Withdraw stake from a validator's staking pool. https://docs.sui.io/sui-api-ref#unsafe_requestwithdrawstake

func (*RequestWithdrawStake) Descriptor deprecated

func (*RequestWithdrawStake) Descriptor() ([]byte, []int)

Deprecated: Use RequestWithdrawStake.ProtoReflect.Descriptor instead.

func (*RequestWithdrawStake) GetGas

func (x *RequestWithdrawStake) GetGas() *ObjectRef

func (*RequestWithdrawStake) GetStakedSui

func (x *RequestWithdrawStake) GetStakedSui() *ObjectRef

func (*RequestWithdrawStake) ProtoMessage

func (*RequestWithdrawStake) ProtoMessage()

func (*RequestWithdrawStake) ProtoReflect

func (x *RequestWithdrawStake) ProtoReflect() protoreflect.Message

func (*RequestWithdrawStake) Reset

func (x *RequestWithdrawStake) Reset()

func (*RequestWithdrawStake) String

func (x *RequestWithdrawStake) String() string

type SignDirect

type SignDirect struct {

	// Obtain by calling any write RpcJson on SUI
	UnsignedTxMsg string `protobuf:"bytes,1,opt,name=unsigned_tx_msg,json=unsignedTxMsg,proto3" json:"unsigned_tx_msg,omitempty"`
	// contains filtered or unexported fields
}

Base64 encoded msg to sign (string)

func (*SignDirect) Descriptor deprecated

func (*SignDirect) Descriptor() ([]byte, []int)

Deprecated: Use SignDirect.ProtoReflect.Descriptor instead.

func (*SignDirect) GetUnsignedTxMsg

func (x *SignDirect) GetUnsignedTxMsg() string

func (*SignDirect) ProtoMessage

func (*SignDirect) ProtoMessage()

func (*SignDirect) ProtoReflect

func (x *SignDirect) ProtoReflect() protoreflect.Message

func (*SignDirect) Reset

func (x *SignDirect) Reset()

func (*SignDirect) String

func (x *SignDirect) String() string

type SigningInput

type SigningInput struct {

	// Private key to sign the transaction (bytes).
	PrivateKey []byte `protobuf:"bytes,1,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	// Optional transaction signer.
	// Needs to be set if no private key provided at `TransactionCompiler` module.
	Signer string `protobuf:"bytes,2,opt,name=signer,proto3" json:"signer,omitempty"`
	// Types that are valid to be assigned to TransactionPayload:
	//
	//	*SigningInput_SignDirectMessage
	//	*SigningInput_Pay
	//	*SigningInput_PaySui
	//	*SigningInput_PayAllSui
	//	*SigningInput_RequestAddStake
	//	*SigningInput_RequestWithdrawStake
	//	*SigningInput_TransferObject
	//	*SigningInput_RawJson
	TransactionPayload isSigningInput_TransactionPayload `protobuf_oneof:"transaction_payload"`
	// The gas budget, the transaction will fail if the gas cost exceed the budget.
	GasBudget uint64 `protobuf:"varint,12,opt,name=gas_budget,json=gasBudget,proto3" json:"gas_budget,omitempty"`
	// Reference gas price.
	ReferenceGasPrice uint64 `protobuf:"varint,13,opt,name=reference_gas_price,json=referenceGasPrice,proto3" json:"reference_gas_price,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) GetGasBudget

func (x *SigningInput) GetGasBudget() uint64

func (*SigningInput) GetPay

func (x *SigningInput) GetPay() *Pay

func (*SigningInput) GetPayAllSui

func (x *SigningInput) GetPayAllSui() *PayAllSui

func (*SigningInput) GetPaySui

func (x *SigningInput) GetPaySui() *PaySui

func (*SigningInput) GetPrivateKey

func (x *SigningInput) GetPrivateKey() []byte

func (*SigningInput) GetRawJson

func (x *SigningInput) GetRawJson() string

func (*SigningInput) GetReferenceGasPrice

func (x *SigningInput) GetReferenceGasPrice() uint64

func (*SigningInput) GetRequestAddStake

func (x *SigningInput) GetRequestAddStake() *RequestAddStake

func (*SigningInput) GetRequestWithdrawStake

func (x *SigningInput) GetRequestWithdrawStake() *RequestWithdrawStake

func (*SigningInput) GetSignDirectMessage

func (x *SigningInput) GetSignDirectMessage() *SignDirect

func (*SigningInput) GetSigner

func (x *SigningInput) GetSigner() string

func (*SigningInput) GetTransactionPayload

func (x *SigningInput) GetTransactionPayload() isSigningInput_TransactionPayload

func (*SigningInput) GetTransferObject

func (x *SigningInput) GetTransferObject() *TransferObject

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 SigningInput_Pay

type SigningInput_Pay struct {
	Pay *Pay `protobuf:"bytes,4,opt,name=pay,proto3,oneof"`
}

type SigningInput_PayAllSui

type SigningInput_PayAllSui struct {
	PayAllSui *PayAllSui `protobuf:"bytes,6,opt,name=pay_all_sui,json=payAllSui,proto3,oneof"`
}

type SigningInput_PaySui

type SigningInput_PaySui struct {
	PaySui *PaySui `protobuf:"bytes,5,opt,name=pay_sui,json=paySui,proto3,oneof"`
}

type SigningInput_RawJson

type SigningInput_RawJson struct {
	RawJson string `protobuf:"bytes,10,opt,name=raw_json,json=rawJson,proto3,oneof"`
}

type SigningInput_RequestAddStake

type SigningInput_RequestAddStake struct {
	RequestAddStake *RequestAddStake `protobuf:"bytes,7,opt,name=request_add_stake,json=requestAddStake,proto3,oneof"`
}

type SigningInput_RequestWithdrawStake

type SigningInput_RequestWithdrawStake struct {
	RequestWithdrawStake *RequestWithdrawStake `protobuf:"bytes,8,opt,name=request_withdraw_stake,json=requestWithdrawStake,proto3,oneof"`
}

type SigningInput_SignDirectMessage

type SigningInput_SignDirectMessage struct {
	SignDirectMessage *SignDirect `protobuf:"bytes,3,opt,name=sign_direct_message,json=signDirectMessage,proto3,oneof"`
}

type SigningInput_TransferObject

type SigningInput_TransferObject struct {
	TransferObject *TransferObject `protobuf:"bytes,9,opt,name=transfer_object,json=transferObject,proto3,oneof"`
}

type SigningOutput

type SigningOutput struct {

	// / The raw transaction without indent in base64
	UnsignedTx string `protobuf:"bytes,1,opt,name=unsigned_tx,json=unsignedTx,proto3" json:"unsigned_tx,omitempty"`
	// / The signature encoded in base64
	Signature string `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,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 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) GetError

func (x *SigningOutput) GetError() common.SigningError

func (*SigningOutput) GetErrorMessage

func (x *SigningOutput) GetErrorMessage() string

func (*SigningOutput) GetSignature

func (x *SigningOutput) GetSignature() string

func (*SigningOutput) GetUnsignedTx

func (x *SigningOutput) GetUnsignedTx() string

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 TransferObject

type TransferObject struct {

	// Object ID to be transferred.
	Object *ObjectRef `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// The recipient address.
	Recipient string `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// Gas object to be used in this transaction.
	Gas *ObjectRef `protobuf:"bytes,3,opt,name=gas,proto3" json:"gas,omitempty"`
	// contains filtered or unexported fields
}

/ Transfer an object from one address to another. The object's type must allow public transfers. / https://docs.sui.io/sui-api-ref#unsafe_transferobject

func (*TransferObject) Descriptor deprecated

func (*TransferObject) Descriptor() ([]byte, []int)

Deprecated: Use TransferObject.ProtoReflect.Descriptor instead.

func (*TransferObject) GetGas

func (x *TransferObject) GetGas() *ObjectRef

func (*TransferObject) GetObject

func (x *TransferObject) GetObject() *ObjectRef

func (*TransferObject) GetRecipient

func (x *TransferObject) GetRecipient() string

func (*TransferObject) ProtoMessage

func (*TransferObject) ProtoMessage()

func (*TransferObject) ProtoReflect

func (x *TransferObject) ProtoReflect() protoreflect.Message

func (*TransferObject) Reset

func (x *TransferObject) Reset()

func (*TransferObject) String

func (x *TransferObject) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL