@typemove/sui
Module
Classes
Interfaces
ModuleWithAddress
Properties
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
| Name | Type | Description |
|---|---|---|
arguments_decoded | T | decoded 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
| Name | Type | Description |
|---|---|---|
results_decoded? | T | Decoded 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
| Parameter | Type | Default value |
|---|---|---|
endpoint | string | DEFAULT_ENDPOINT |
Returns
getGrpcClient()
function getGrpcClient(endpoint: string): SuiGrpcClient;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
Returns
SuiGrpcClient
getGrpcFullnodeUrl()
function getGrpcFullnodeUrl(network: "mainnet" | "testnet" | "devnet" | "localnet"): string;Parameters
| Parameter | Type |
|---|---|
network | "mainnet" | "testnet" | "devnet" | "localnet" |
Returns
string
getMoveCoder()
function getMoveCoder(client: SuiGrpcClient): Promise<MoveCoder>;Parameters
| Parameter | Type |
|---|---|
client | SuiGrpcClient |
Returns
Promise<MoveCoder>
inferNetworkFromUrl()
function inferNetworkFromUrl(url: string): string;Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
string
isTransactionArgument()
function isTransactionArgument(value: any): boolean;Parameters
| Parameter | Type |
|---|---|
value | any |
Returns
boolean
transactionArgumentOrObject()
function transactionArgumentOrObject(value: TransactionObjectInput, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | TransactionObjectInput |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPure()
function transactionArgumentOrPure(value: any, transactionBlock: Transaction): any;Parameters
| Parameter | Type |
|---|---|
value | any |
transactionBlock | Transaction |
Returns
any
transactionArgumentOrPureAddress()
function transactionArgumentOrPureAddress(value: string | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | string | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureBool()
function transactionArgumentOrPureBool(value: boolean | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | boolean | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureString()
function transactionArgumentOrPureString(value: string | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | string | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU128()
function transactionArgumentOrPureU128(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | string | number | bigint | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU16()
function transactionArgumentOrPureU16(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | number | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU256()
function transactionArgumentOrPureU256(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | string | number | bigint | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU32()
function transactionArgumentOrPureU32(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | number | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU64()
function transactionArgumentOrPureU64(value: string | number | bigint | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | string | number | bigint | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrPureU8()
function transactionArgumentOrPureU8(value: number | TransactionArgument, transactionBlock: Transaction): TransactionArgument;Parameters
| Parameter | Type |
|---|---|
value | number | TransactionArgument |
transactionBlock | Transaction |
Returns
TransactionArgument
transactionArgumentOrVec()
function transactionArgumentOrVec(value: any, transactionBlock: Transaction): any;Parameters
| Parameter | Type |
|---|---|
value | any |
transactionBlock | Transaction |
Returns
any