Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.10.2

Jan 7, 2025

v1.10.1

Jan 7, 2025

v1.10.0

Mar 18, 2024

v1.9.0

Mar 18, 2024

v1.8.0

Mar 15, 2024

v1.7.0

Mar 14, 2024

v1.6.0

Nov 10, 2023

v1.5.0

Oct 24, 2023

Changes in this version

type Client

+ func (c *Client) GetChainIdentifier(ctx context.Context) (*string, error)

v1.4.0

Oct 19, 2023

v1.3.0

Oct 16, 2023

v1.2.0

Oct 16, 2023

Changes in this version

type Client

+ func (c *Client) DevInspectTransactionBlockV2(ctx context.Context, senderAddress suiAddress, target string, ...) (*types.DevInspectResults, error)

+ func (c *Client) GetFunctions(target string) (*suiAddress, move_types.Identifier, move_types.Identifier, error)

+ type DevInspectArgs struct

+ Type string

+ Value any

+ Version uint64

v1.1.0

Oct 16, 2023

v1.0.0

Oct 11, 2023

Changes in this version

+ const DevNetFaucetUrl

+ const QUERY_MAX_RESULT_LIMIT

+ const SuiPrefix

+ const SuiXPrefix

+ const TestNetFaucetUrl

+ const UnsafePrefix

+ var ErrNoResult = errors.New("no result in JSON-RPC response")

+ func BCS_RequestAddStake(signer suiAddress, coins []*sui_types.ObjectRef, ...) ([]byte, error)

+ func BCS_RequestWithdrawStake(signer suiAddress, stakedSuiRef sui_types.ObjectRef, ...) ([]byte, error)

+ func FaucetFundAccount(address string, faucetUrl string) (string, error)

+ type BatchElem struct

+ Args []interface{}

+ Error error

+ Method string

+ Result interface{}

+ type Client struct

+ func Dial(rpcUrl string) (client *Client, err error)

+ func DialWithClient(rpcUrl string, c *http.Client) (client *Client, err error)

+ func (c *Client) BatchCall(b []BatchElem) error

+ func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error

+ func (c *Client) BatchGetFilteredObjectsOwnedByAddress(ctx context.Context, address suiAddress, options types.SuiObjectDataOptions, ...) ([]types.SuiObjectResponse, error)

+ func (c *Client) BatchGetObjectsOwnedByAddress(ctx context.Context, address suiAddress, options types.SuiObjectDataOptions, ...) ([]types.SuiObjectResponse, error)

+ func (c *Client) BatchTransaction(ctx context.Context, signer suiAddress, txnParams []map[string]interface{}, ...) (*types.TransactionBytes, error)

+ func (c *Client) Call(result interface{}, method Method, args ...interface{}) error

+ func (c *Client) CallContext(ctx context.Context, result interface{}, method Method, args ...interface{}) error

+ func (c *Client) DevInspectTransactionBlock(ctx context.Context, senderAddress suiAddress, txByte suiBase64Data, ...) (*types.DevInspectResults, error)

+ func (c *Client) DryRunTransaction(ctx context.Context, txBytes suiBase64Data) (*types.DryRunTransactionBlockResponse, error)

+ func (c *Client) ExecuteTransactionBlock(ctx context.Context, txBytes suiBase64Data, signatures []any, ...) (*types.SuiTransactionBlockResponse, error)

+ func (c *Client) GetAllBalances(ctx context.Context, owner suiAddress) ([]types.Balance, error)

+ func (c *Client) GetAllCoins(ctx context.Context, owner suiAddress, cursor *suiObjectID, limit uint) (*types.CoinPage, error)

+ func (c *Client) GetBalance(ctx context.Context, owner suiAddress, coinType string) (*types.Balance, error)

+ func (c *Client) GetCoinMetadata(ctx context.Context, coinType string) (*types.SuiCoinMetadata, error)

+ func (c *Client) GetCoins(ctx context.Context, owner suiAddress, coinType *string, cursor *suiObjectID, ...) (*types.CoinPage, error)

+ func (c *Client) GetDynamicFieldObject(ctx context.Context, parentObjectId suiObjectID, ...) (*types.SuiObjectResponse, error)

+ func (c *Client) GetDynamicFields(ctx context.Context, parentObjectId suiObjectID, cursor *suiObjectID, ...) (*types.DynamicFieldPage, error)

+ func (c *Client) GetEvents(ctx context.Context, digest suiDigest) ([]types.SuiEvent, error)

+ func (c *Client) GetLatestCheckpointSequenceNumber(ctx context.Context) (string, error)

+ func (c *Client) GetLatestSuiSystemState(ctx context.Context) (*types.SuiSystemStateSummary, error)

+ func (c *Client) GetNFTsOwnedByAddress(ctx context.Context, address suiAddress) ([]types.SuiObjectResponse, error)

+ func (c *Client) GetObject(ctx context.Context, objID suiObjectID, options *types.SuiObjectDataOptions) (*types.SuiObjectResponse, error)

+ func (c *Client) GetOwnedObjects(ctx context.Context, address suiAddress, query *types.SuiObjectResponseQuery, ...) (*types.ObjectsPage, error)

+ func (c *Client) GetReferenceGasPrice(ctx context.Context) (*types.SafeSuiBigInt[uint64], error)

+ func (c *Client) GetStakes(ctx context.Context, owner suiAddress) ([]types.DelegatedStake, error)

+ func (c *Client) GetStakesByIds(ctx context.Context, stakedSuiIds []suiObjectID) ([]types.DelegatedStake, error)

+ func (c *Client) GetSuiCoinsOwnedByAddress(ctx context.Context, address suiAddress) (types.Coins, error)

+ func (c *Client) GetTotalSupply(ctx context.Context, coinType string) (*types.Supply, error)

+ func (c *Client) GetTotalTransactionBlocks(ctx context.Context) (string, error)

+ func (c *Client) GetTransactionBlock(ctx context.Context, digest suiDigest, ...) (*types.SuiTransactionBlockResponse, error)

+ func (c *Client) GetValidatorsApy(ctx context.Context) (*types.ValidatorsApy, error)

+ func (c *Client) MergeCoins(ctx context.Context, signer suiAddress, primaryCoin, coinToMerge suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) MintNFT(ctx context.Context, signer suiAddress, nftName, nftDescription, nftUri string, ...) (*types.TransactionBytes, error)

+ func (c *Client) MoveCall(ctx context.Context, signer suiAddress, packageId suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) MultiGetObjects(ctx context.Context, objIDs []suiObjectID, options *types.SuiObjectDataOptions) ([]types.SuiObjectResponse, error)

+ func (c *Client) Pay(ctx context.Context, signer suiAddress, inputCoins []suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) PayAllSui(ctx context.Context, signer, recipient suiAddress, inputCoins []suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) PaySui(ctx context.Context, signer suiAddress, inputCoins []suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) Publish(ctx context.Context, sender suiAddress, compiledModules []*suiBase64Data, ...) (*types.TransactionBytes, error)

+ func (c *Client) QueryEvents(ctx context.Context, query types.EventFilter, cursor *types.EventId, ...) (*types.EventPage, error)

+ func (c *Client) QueryTransactionBlocks(ctx context.Context, query types.SuiTransactionBlockResponseQuery, ...) (*types.TransactionBlocksPage, error)

+ func (c *Client) RequestAddStake(ctx context.Context, signer suiAddress, coins []suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) RequestWithdrawStake(ctx context.Context, signer suiAddress, stakedSuiId suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) SplitCoin(ctx context.Context, signer suiAddress, Coin suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) SplitCoinEqual(ctx context.Context, signer suiAddress, Coin suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) TransferObject(ctx context.Context, signer, recipient suiAddress, objID suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) TransferSui(ctx context.Context, signer, recipient suiAddress, suiObjID suiObjectID, ...) (*types.TransactionBytes, error)

+ func (c *Client) TryGetPastObject(ctx context.Context, objectId suiObjectID, version uint64, ...) (*types.SuiPastObjectResponse, error)

+ type HTTPError struct

+ Body []byte

+ Status string

+ StatusCode int

+ func (err HTTPError) Error() string

+ type Method interface

+ String func() string

+ type SuiMethod string

+ func (s SuiMethod) String() string

+ type SuiXMethod string

+ func (s SuiXMethod) String() string

+ type UnsafeMethod string

+ func (u UnsafeMethod) String() string