Skip to content

Sui.ts

This module handles Sui related functionality.

Added in v2.0.0

Signature

export declare class ChannelDestination

Added in v2.0.0

Source: src/Sui.ts:73

Signature

export declare class ChannelSource

Added in v2.0.0

Source: src/Sui.ts:87

Signature

export declare class FungibleAssetOrderDetails

Added in v2.0.0

Source: src/Sui.ts:56

Signature

export declare class PublicClient

Added in v2.0.0

Source: src/Sui.ts:101

Signature

export declare class PublicClientDestination

Added in v2.0.0

Source: src/Sui.ts:131

Signature

export declare class PublicClientSource

Added in v2.0.0

Source: src/Sui.ts:116

A wallet client that can be used for signing transactions

Signature

export declare class WalletClient

Added in v2.0.0

Source: src/Sui.ts:150

Signature

export declare class CreatePublicClientError

Added in v2.0.0

Source: src/Sui.ts:220

Signature

export declare class CreatePublicClientErrorType

Added in v2.0.0

Source: src/Sui.ts:210

Signature

export declare class CreateWalletClientError

Added in v2.0.0

Source: src/Sui.ts:230

Signature

export declare class CreateWalletClientErrorType

Added in v2.0.0

Source: src/Sui.ts:200

Signature

export declare class ReadCoinError

Added in v2.0.0

Source: src/Sui.ts:176

Signature

export declare class ReadContractError

Added in v2.0.0

Source: src/Sui.ts:184

Signature

export declare class WriteContractError

Added in v2.0.0

Source: src/Sui.ts:192

Interface for FA token metadata

Signature

export interface FaTokenInfo {
decimals: number
icon_uri: string
name: string
project_uri: string
symbol: string
}

Source: src/Sui.ts:164

Added in v2.0.0

Added in v2.0.0

Signature

export interface Channel {
readonly ucs03address: Address
readonly channelId: number
}

Source: src/Sui.ts:46

Added in v2.0.0

Signature

export interface PublicClient {
readonly client: SuiClient
}

Source: src/Sui.ts:29

Added in v2.0.0

Signature

export interface WalletClient {
readonly client: SuiClient
readonly signer: Ed25519Keypair
}

Source: src/Sui.ts:37

Added in v2.0.0

Signature

export declare const channelBalance: (
path: number,
token: Hex,
relayStore: Hex
) => Effect.Effect<string, ReadContractError | TimeoutException, PublicClientDestination | ChannelDestination>

Source: src/Sui.ts:240

Added in v2.0.0

Signature

export declare const getAllCoins: (address: string) => Effect.Effect<CoinStruct[], ReadCoinError, PublicClient>

Source: src/Sui.ts:398

Added in v2.0.0

Signature

export declare const getAllCoinsUnique: (
address: string
) => Effect.Effect<{ coinType: string; balance: string }[], ReadCoinError, PublicClient>

Source: src/Sui.ts:422

Added in v2.0.0

Signature

export declare const getCoinDecimals: (
address: string
) => Effect.Effect<number | undefined, ReadCoinError, PublicClient>

Source: src/Sui.ts:489

Added in v2.0.0

Signature

export declare const getCoinName: (address: string) => Effect.Effect<string | undefined, ReadCoinError, PublicClient>

Source: src/Sui.ts:468

Added in v2.0.0

Signature

export declare const predictQuoteToken: (
baseToken: Hex
) => Effect.Effect<string, ReadContractError | TimeoutException, PublicClientDestination | ChannelDestination>

Source: src/Sui.ts:302

Added in v2.0.0

Signature

export declare const readCoinBalances: (
contractAddress: string,
address: string
) => Effect.Effect<CoinStruct[], ReadCoinError, PublicClient>

Source: src/Sui.ts:345

Added in v2.0.0

Signature

export declare const readCoinMetadata: (
address: string
) => Effect.Effect<CoinMetadata | null, ReadCoinError, PublicClient>

Source: src/Sui.ts:531

Added in v2.0.0

Signature

export declare const readCoinSymbol: (address: string) => Effect.Effect<string | undefined, ReadCoinError, PublicClient>

Source: src/Sui.ts:510

Added in v2.0.0

Signature

export declare const readContract: (
client: SuiClient,
sender: string,
packageId: string,
module: string,
fn: string,
typeArgs: string[],
args: any[],
tx: Transaction
) => Effect.Effect<SuiExecutionResult[] | null | undefined, ReadContractError | TimeoutException, never>

Source: src/Sui.ts:552

Added in v2.0.0

Signature

export declare const readTotalCoinBalance: (
contractAddress: string,
address: string
) => Effect.Effect<bigint, ReadCoinError, PublicClient>

Source: src/Sui.ts:370

Added in v2.0.0

Signature

export declare const writeContract: (
client: SuiClient,
signer: Ed25519Keypair,
packageId: string,
module: string,
fn: string,
typeArgs: string[],
args: any[],
tx: Transaction
) => Effect.Effect<SuiTransactionBlockResponse, WriteContractError, never>

Source: src/Sui.ts:587

Added in v2.0.0