client

package
v0.0.24 Latest Latest
Warning

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

Go to latest
Published: Aug 15, 2024 License: GPL-2.0, GPL-3.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetFullNodeURL

func GetFullNodeURL(network string) string

Types

type SuiClient

type SuiClient struct {
	// contains filtered or unexported fields
}

func NewSuiClient

func NewSuiClient(ctx context.Context, rpc string) (*SuiClient, error)

func (*SuiClient) Call

func (client *SuiClient) Call(method string, params []any, response any) error

Invoke any RPC method

func (*SuiClient) Context

func (client *SuiClient) Context() context.Context

func (*SuiClient) DevInspectTransactionBlock

func (client *SuiClient) DevInspectTransactionBlock(input types.DevInspectTransactionBlockParams) (response *types.DevInspectResults, err error)

Runs the transaction block in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.

func (*SuiClient) DryRunTransactionBlock

func (client *SuiClient) DryRunTransactionBlock(input types.DryRunTransactionBlockParams) (response *types.DryRunTransactionBlockResponse, err error)

Dry run a transaction block and return the result.

func (*SuiClient) ExecuteTransactionBlock

func (client *SuiClient) ExecuteTransactionBlock(input types.ExecuteTransactionBlockParams) (response *types.SuiTransactionBlockResponse, err error)

func (*SuiClient) GetAllBalances

func (client *SuiClient) GetAllBalances(input types.GetAllBalancesParams) (response *[]types.Balance, err error)

Get the total coin balance for all coin types, owned by the address owner.

func (*SuiClient) GetAllCoins

func (client *SuiClient) GetAllCoins(input types.GetAllCoinsParams) (response *types.PaginatedCoins, err error)

Get all Coin objects owned by an address.

func (*SuiClient) GetBalance

func (client *SuiClient) GetBalance(input types.GetBalanceParams) (response *types.Balance, err error)

Get the total coin balance for one coin type, owned by the address owner.

func (*SuiClient) GetChainIdentifier

func (client *SuiClient) GetChainIdentifier() (response string, err error)

func (*SuiClient) GetCheckpoint

func (client *SuiClient) GetCheckpoint(input types.GetCheckpointParams) (response *types.Checkpoint, err error)

Returns information about a given checkpoint

func (*SuiClient) GetCheckpoints

func (client *SuiClient) GetCheckpoints(input types.GetCheckpointsParams) (response *types.CheckpointPage, err error)

Returns historical checkpoints paginated

func (*SuiClient) GetCoinMetadata

func (client *SuiClient) GetCoinMetadata(input types.GetCoinMetadataParams) (response *types.CoinMetadata, err error)

Fetch CoinMetadata for a given coin type

func (*SuiClient) GetCoins

func (client *SuiClient) GetCoins(input types.GetCoinsParams) (response *types.PaginatedCoins, err error)

Get all Coin<`coin_type`> objects owned by an address.

func (*SuiClient) GetCommitteeInfo

func (client *SuiClient) GetCommitteeInfo(input types.GetCommitteeInfoParams) (response *types.CommitteeInfo, err error)

Return the committee information for the asked epoch

func (*SuiClient) GetDynamicFieldObject

func (client *SuiClient) GetDynamicFieldObject(input types.GetDynamicFieldObjectParams) (response *types.SuiObjectResponse, err error)

Return the dynamic field object information for a specified object

func (*SuiClient) GetDynamicFields

func (client *SuiClient) GetDynamicFields(input types.GetDynamicFieldsParams) (response *types.DynamicFieldPage, err error)

Return the list of dynamic field objects owned by an object

func (*SuiClient) GetLatestCheckpointSequenceNumber

func (client *SuiClient) GetLatestCheckpointSequenceNumber() (response string, err error)

Get the sequence number of the latest checkpoint that has been executed

func (*SuiClient) GetLatestSuiSystemState

func (client *SuiClient) GetLatestSuiSystemState() (response *types.SuiSystemStateSummary, err error)

Return the latest system state content.

func (*SuiClient) GetMoveFunctionArgTypes

func (client *SuiClient) GetMoveFunctionArgTypes(input types.GetMoveFunctionArgTypesParams) (response []interface{}, err error)

Get Move function argument types like read, write and full access The native response type is []types.SuiMoveFunctionArgType, It contains two different types: string and types.SuiMoveFunctionArgType_Object

func (*SuiClient) GetNormalizedMoveFunction

func (client *SuiClient) GetNormalizedMoveFunction(input types.GetNormalizedMoveFunctionParams) (response *types.SuiMoveNormalizedFunction, err error)

Get a structured representation of Move function

func (*SuiClient) GetNormalizedMoveModule

func (client *SuiClient) GetNormalizedMoveModule(input types.GetNormalizedMoveModuleParams) (response *types.SuiMoveNormalizedModule, err error)

Get a structured representation of Move module

func (*SuiClient) GetNormalizedMoveModulesByPackage

func (client *SuiClient) GetNormalizedMoveModulesByPackage(input types.GetNormalizedMoveModulesByPackageParams) (response *types.SuiMoveNormalizedModules, err error)

Get a map from module name to structured representations of Move modules

func (*SuiClient) GetNormalizedMoveStruct

func (client *SuiClient) GetNormalizedMoveStruct(input types.GetNormalizedMoveStructParams) (response *types.SuiMoveNormalizedStruct, err error)

Get a structured representation of Move struct

func (*SuiClient) GetObject

func (client *SuiClient) GetObject(input types.GetObjectParams) (response *types.SuiObjectResponse, err error)

Get details about an object

func (*SuiClient) GetOwnedObjects

func (client *SuiClient) GetOwnedObjects(input types.GetOwnedObjectsParams) (response *types.PaginatedObjectsResponse, err error)

Get all objects owned by an address

func (*SuiClient) GetProtocolConfig

func (client *SuiClient) GetProtocolConfig(input types.GetProtocolConfigParams) (response *types.ProtocolConfig, err error)

func (*SuiClient) GetReferenceGasPrice

func (client *SuiClient) GetReferenceGasPrice() (response *big.Int, err error)

Getting the reference gas price for the network

func (*SuiClient) GetRpcApiVersion

func (client *SuiClient) GetRpcApiVersion() (string, error)

func (*SuiClient) GetStakes

func (client *SuiClient) GetStakes(input types.GetStakesParams) (response *[]types.DelegatedStake, err error)

Return the delegated stakes for an address

func (*SuiClient) GetStakesByIds

func (client *SuiClient) GetStakesByIds(input types.GetStakesByIdsParams) (response *[]types.DelegatedStake, err error)

Return the delegated stakes queried by id.

func (*SuiClient) GetTotalSupply

func (client *SuiClient) GetTotalSupply(input types.GetTotalSupplyParams) (response *types.CoinSupply, err error)

Fetch total supply for a coin

func (*SuiClient) GetTotalTransactionBlocks

func (client *SuiClient) GetTotalTransactionBlocks() (response *big.Int, err error)

Get total number of transactions

func (*SuiClient) GetTransactionBlock

func (client *SuiClient) GetTransactionBlock(input types.GetTransactionBlockParams) (response *types.SuiTransactionBlockResponse, err error)

func (*SuiClient) GetValidatorsApy

func (client *SuiClient) GetValidatorsApy() (response *types.ValidatorsApy, err error)

Return the Validators APYs

func (*SuiClient) MultiGetObjects

func (client *SuiClient) MultiGetObjects(input types.MultiGetObjectsParams) (response *[]types.SuiObjectResponse, err error)

Batch get details about a list of objects. If any of the object ids are duplicates the call will fail

func (*SuiClient) MultiGetTransactionBlocks

func (client *SuiClient) MultiGetTransactionBlocks(input types.MultiGetTransactionBlocksParams) (response *[]types.SuiTransactionBlockResponse, err error)

func (*SuiClient) QueryEvents

func (client *SuiClient) QueryEvents(input types.QueryEventsParams) (response *types.PaginatedEvents, err error)

Get events for a given query criteria

func (*SuiClient) QueryTransactionBlocks

func (client *SuiClient) QueryTransactionBlocks(input types.QueryTransactionBlocksParams) (response *types.PaginatedTransactionResponse, err error)

Get transaction blocks for a given query criteria

func (*SuiClient) RPC

func (client *SuiClient) RPC() string

func (*SuiClient) ResolveNameServiceAddress

func (client *SuiClient) ResolveNameServiceAddress(input types.ResolveNameServiceAddressParams) (response string, err error)

func (*SuiClient) ResolveNameServiceNames

func (client *SuiClient) ResolveNameServiceNames(input types.ResolveNameServiceNamesParams) (response *types.ResolvedNameServiceNames, err error)

func (*SuiClient) SignAndExecuteTransactionBlock

func (client *SuiClient) SignAndExecuteTransactionBlock(input types.SignAndExecuteTransactionBlockParams) (response *types.SuiTransactionBlockResponse, err error)

func (*SuiClient) SubscribeEvent

func (client *SuiClient) SubscribeEvent(input types.SubscribeEventParams) (response any, err error)

Subscribe to get notifications whenever an event matching the filter occurs

func (*SuiClient) SubscribeTransaction

func (client *SuiClient) SubscribeTransaction(input types.SubscribeTransactionParams) (response any, err error)

func (*SuiClient) TryGetPastObject

func (client *SuiClient) TryGetPastObject(input types.TryGetPastObjectParams) (response *types.ObjectRead, err error)

Return the object information for a specified version

type SuiClientOptions

type SuiClientOptions struct {
	URL string
}

type SuiTransportRequestOptions

type SuiTransportRequestOptions struct {
	Method string `json:"method"`
	Params []any  `json:"params"`
}

Jump to

Keyboard shortcuts

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