gmsui

Documentation

Index

• Variables
• func B64PublicKeyToSuiAddress(b64 string) (string, error)
• func B64ToSuiPrivateKey(b64 string) (string, error)
• func DevInspect(suiClient *client.SuiClient, target string, args []interface{}, ...) (*types.DevInspectResults, error)
• func Ed25519PublicKeyToB64PublicKey(ed25519PubKey ed25519.PublicKey) string
• func GetAllCoins(client *client.SuiClient, owner string, coinType string) (data []types.CoinStruct, err error)
• func GetMaxCoinObject(client *client.SuiClient, owner, coinType string) (*types.CoinStruct, error)
• func GetObjectAndUnmarshal[T any](client *client.SuiClient, id string) (raw *types.SuiObjectResponse, value *T, err error)
• func GetObjectsAndUnmarshal[T any](client *client.SuiClient, ids []string) (raw []*types.SuiObjectResponse, values []*T, err error)
• func ParseDevInspectReturnValue(v [2]interface{}) ([]byte, error)
• func ParseEvent[T any](event types.SuiEvent) (*T, error)
• func ParseFunctionTypeArguments(typeArgs []string) (typeArguments []move_types.TypeTag, err error)
• func SuiPrivateKeyToB64(pk string) (string, error)
• type MoveEventModuleConfig
  • func (ec *MoveEventModuleConfig) Join() string
  • func (ec *MoveEventModuleConfig) JoinEventName(name string) string
• type ProgrammableTransactionBlock
  • func NewProgrammableTransactionBlock(client *client.SuiClient) *ProgrammableTransactionBlock
  • func (ptb *ProgrammableTransactionBlock) Builder() *sui_types.ProgrammableTransactionBuilder
  • func (ptb *ProgrammableTransactionBlock) Client() *client.SuiClient
  • func (ptb *ProgrammableTransactionBlock) Context() context.Context
  • func (ptb *ProgrammableTransactionBlock) Finish(sender string, gasObject *string, gasBudget uint64, gasPrice *uint64) (*sui_types.TransactionData, []byte, error)
  • func (ptb *ProgrammableTransactionBlock) NewMoveCall(target string, args []interface{}, typeArgs []string) (*sui_types.Argument, error)
  • func (ptb *ProgrammableTransactionBlock) ParseFunctionArguments(target string, args []interface{}) (arguments []sui_types.Argument, err error)
• type SuiMoveDynamicField
  • func GetDynamicFieldObjectAndUnmarshal[T any, NameType any](client *client.SuiClient, parentId string, name types.DynamicFieldName) (raw *types.SuiObjectResponse, value *SuiMoveDynamicField[T, NameType], ...)
• type SuiMoveDynamicFieldValue
• type SuiMoveId
• type SuiMoveString
• type SuiMoveStringFields
• type SuiMoveTable
• type SuiMoveTableFields

Variables

var (
	SuiGasCoinType string = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI"

	SuiZeroAddress   string = "0x0000000000000000000000000000000000000000000000000000000000000000"
	SuiClockObjectId string = "0x0000000000000000000000000000000000000000000000000000000000000006"
	SuiPackageId     string = "0x0000000000000000000000000000000000000000000000000000000000000002"
)

Functions

func B64PublicKeyToSuiAddress

func B64PublicKeyToSuiAddress(b64 string) (string, error)

func B64ToSuiPrivateKey

func B64ToSuiPrivateKey(b64 string) (string, error)

Utils

func DevInspect

func DevInspect(suiClient *client.SuiClient, target string, args []interface{}, typeArgs []string) (*types.DevInspectResults, error)

func Ed25519PublicKeyToB64PublicKey

func Ed25519PublicKeyToB64PublicKey(ed25519PubKey ed25519.PublicKey) string

func GetAllCoins

func GetAllCoins(client *client.SuiClient, owner string, coinType string) (data []types.CoinStruct, err error)

Instance Get All Sui Coins

func GetMaxCoinObject

func GetMaxCoinObject(client *client.SuiClient, owner, coinType string) (*types.CoinStruct, error)

func GetObjectAndUnmarshal

func GetObjectAndUnmarshal[T any](client *client.SuiClient, id string) (raw *types.SuiObjectResponse, value *T, err error)

func GetObjectsAndUnmarshal

func GetObjectsAndUnmarshal[T any](client *client.SuiClient, ids []string) (raw []*types.SuiObjectResponse, values []*T, err error)

func ParseDevInspectReturnValue

func ParseDevInspectReturnValue(v [2]interface{}) ([]byte, error)

func ParseEvent

func ParseEvent[T any](event types.SuiEvent) (*T, error)

Parsing custom event json Reference: https://docs.sui.io/guides/developer/sui-101/using-events#move-event-structure

func ParseFunctionTypeArguments

func ParseFunctionTypeArguments(typeArgs []string) (typeArguments []move_types.TypeTag, err error)

func SuiPrivateKeyToB64

func SuiPrivateKeyToB64(pk string) (string, error)

Types

type MoveEventModuleConfig

type MoveEventModuleConfig struct {
	Package string `toml:"Package,omitempty"`
	Module  string `toml:"Module,omitempty"`
}

Define the type as MoveModule/MoveEventModule. Events emitted, defined on the specified Move module. Reference: https://docs.sui.io/guides/developer/sui-101/using-events#filtering-event-queries

func (*MoveEventModuleConfig) Join

func (ec *MoveEventModuleConfig) Join() string

func (*MoveEventModuleConfig) JoinEventName

func (ec *MoveEventModuleConfig) JoinEventName(name string) string

type ProgrammableTransactionBlock

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

func NewProgrammableTransactionBlock

func NewProgrammableTransactionBlock(client *client.SuiClient) *ProgrammableTransactionBlock

func (*ProgrammableTransactionBlock) Builder

func (ptb *ProgrammableTransactionBlock) Builder() *sui_types.ProgrammableTransactionBuilder

func (*ProgrammableTransactionBlock) Client

func (ptb *ProgrammableTransactionBlock) Client() *client.SuiClient

func (*ProgrammableTransactionBlock) Context

func (ptb *ProgrammableTransactionBlock) Context() context.Context

func (*ProgrammableTransactionBlock) Finish

func (ptb *ProgrammableTransactionBlock) Finish(sender string, gasObject *string, gasBudget uint64, gasPrice *uint64) (*sui_types.TransactionData, []byte, error)

func (*ProgrammableTransactionBlock) NewMoveCall

func (ptb *ProgrammableTransactionBlock) NewMoveCall(target string, args []interface{}, typeArgs []string) (*sui_types.Argument, error)

func (*ProgrammableTransactionBlock) ParseFunctionArguments

func (ptb *ProgrammableTransactionBlock) ParseFunctionArguments(target string, args []interface{}) (arguments []sui_types.Argument, err error)

txContext should be nil

type SuiMoveDynamicField

type SuiMoveDynamicField[TypeFields any, TypeName any] struct {
	Id    SuiMoveId                            `json:"id"`
	Name  TypeName                             `json:"name"`
	Value SuiMoveDynamicFieldValue[TypeFields] `json:"value"`
}

func GetDynamicFieldObjectAndUnmarshal

func GetDynamicFieldObjectAndUnmarshal[T any, NameType any](client *client.SuiClient, parentId string, name types.DynamicFieldName) (raw *types.SuiObjectResponse, value *SuiMoveDynamicField[T, NameType], err error)

type SuiMoveDynamicFieldValue

type SuiMoveDynamicFieldValue[TypeFields any] struct {
	Fields TypeFields `json:"fields"`
	Type   string     `json:"type"`
}

type SuiMoveId

type SuiMoveId struct {
	Id string `json:"id"`
}

type SuiMoveString

type SuiMoveString struct {
	Type   string              `json:"type"`
	Fields SuiMoveStringFields `json:"fields"`
}

type SuiMoveStringFields

type SuiMoveStringFields struct {
	Name string `json:"name"`
}

type SuiMoveTable

type SuiMoveTable struct {
	Fields SuiMoveTableFields `json:"fields"`
	Type   string             `json:"type"`
}

type SuiMoveTableFields

type SuiMoveTableFields struct {
	Id   SuiMoveId `json:"id"`
	Size string    `json:"size"`
}