@typemove/sui

Module

Classes

Interfaces

ModuleWithAddress

Properties

PropertyType
addressstring
moduleModule

Type Aliases

SuiEventInput

type SuiEventInput = SuiClientTypes.Event;

SuiMoveObjectInput

type SuiMoveObjectInput = SuiClientTypes.Object<{
  json: true;
}>;

TypedEventInstance

type TypedEventInstance<T> = DecodedStruct<SuiClientTypes.Event, T>;

Type Parameters

Type Parameter
T

TypedFunctionPayload

type TypedFunctionPayload<T extends any[]> = GrpcTypes.MoveCall & object;

Type Declaration

NameTypeDescription
arguments_decodedTdecoded argument data using ABI, undefined if there is decoding error, usually because the ABI/data mismatch

Type Parameters

Type Parameter
T extends any[]

TypedSimulateResults

type TypedSimulateResults<T extends any[]> = object & Record<string, any>;

Type Declaration

NameTypeDescription
results_decoded?TDecoded return values using ABI, undefined if there is decoding error, usually because the ABI/data mismatch

Type Parameters

Type Parameter
T extends any[]

TypedSuiMoveObject

type TypedSuiMoveObject<T> = DecodedStruct<SuiClientTypes.Object<{
  json: true;
}>, T>;

Type Parameters

Type Parameter
T

Variables

ZERO_ADDRESS

const ZERO_ADDRESS: "0x0000000000000000000000000000000000000000000000000000000000000000" = '0x0000000000000000000000000000000000000000000000000000000000000000';

Functions

defaultMoveCoder()

function defaultMoveCoder(endpoint?: string): MoveCoder;

Parameters

ParameterTypeDefault value
endpointstringDEFAULT_ENDPOINT

Returns

MoveCoder


getGrpcClient()

function getGrpcClient(endpoint: string): SuiGrpcClient;

Parameters

ParameterType
endpointstring

Returns

SuiGrpcClient


getGrpcFullnodeUrl()

function getGrpcFullnodeUrl(network: "mainnet" | "testnet" | "devnet" | "localnet"): string;

Parameters

ParameterType
network"mainnet" | "testnet" | "devnet" | "localnet"

Returns

string


getMoveCoder()

function getMoveCoder(client: SuiGrpcClient): Promise<MoveCoder>;

Parameters

ParameterType
clientSuiGrpcClient

Returns

Promise<MoveCoder>


inferNetworkFromUrl()

function inferNetworkFromUrl(url: string): string;

Parameters

ParameterType
urlstring

Returns

string


isTransactionArgument()

function isTransactionArgument(value: any): boolean;

Parameters

ParameterType
valueany

Returns

boolean


transactionArgumentOrObject()

function transactionArgumentOrObject(value: TransactionObjectInput, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valueTransactionObjectInput
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPure()

function transactionArgumentOrPure(value: any, transactionBlock: Transaction): any;

Parameters

ParameterType
valueany
transactionBlockTransaction

Returns

any


transactionArgumentOrPureAddress()

function transactionArgumentOrPureAddress(value: string | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuestring | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureBool()

function transactionArgumentOrPureBool(value: boolean | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valueboolean | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureString()

function transactionArgumentOrPureString(value: string | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuestring | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU128()

function transactionArgumentOrPureU128(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuestring | number | bigint | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU16()

function transactionArgumentOrPureU16(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuenumber | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU256()

function transactionArgumentOrPureU256(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuestring | number | bigint | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU32()

function transactionArgumentOrPureU32(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuenumber | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU64()

function transactionArgumentOrPureU64(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuestring | number | bigint | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrPureU8()

function transactionArgumentOrPureU8(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;

Parameters

ParameterType
valuenumber | TransactionArgument
transactionBlockTransaction

Returns

TransactionArgument


transactionArgumentOrVec()

function transactionArgumentOrVec(value: any, transactionBlock: Transaction): any;

Parameters

ParameterType
valueany
transactionBlockTransaction

Returns

any

On this page