@0xobelisk/sui-client 0.5.18 → 0.5.20

package/dist/libs/suiTxBuilder/index.d.ts

@@ -0,0 +1,538 @@
+import { Transaction } from '@mysten/sui/transactions';
+import type { SuiClient, SuiObjectRef } from '@mysten/sui/client';
+import type { TransactionObjectArgument, TransactionObjectInput } from '@mysten/sui/transactions';
+import type { Keypair } from '@mysten/sui/cryptography';
+import { SerializedBcs } from '@mysten/bcs';
+import type { SuiTxArg, SuiAddressArg, SuiObjectArg, SuiVecTxArg, SuiAmountsArg } from '../../types';
+import type { bcs } from '@mysten/sui/bcs';
+export declare class SuiTx {
+    tx: Transaction;
+    constructor(transaction?: Transaction);
+    get gas(): {
+        $kind: "GasCoin";
+        GasCoin: true;
+    };
+    get blockData(): {
+        version: 1;
+        inputs: ({
+            kind: "Input";
+            value: unknown;
+            index: number;
+            type?: "object" | undefined;
+        } | {
+            type: "pure";
+            kind: "Input";
+            value: unknown;
+            index: number;
+        })[];
+        expiration: {
+            Epoch: number;
+        } | {
+            None: true | null;
+        } | null | undefined;
+        gasConfig: {
+            payment?: {
+                objectId: string;
+                version: string | number | bigint;
+                digest: string;
+            }[] | undefined;
+            owner?: string | undefined;
+            price?: string | number | bigint | undefined;
+            budget?: string | number | bigint | undefined;
+        };
+        transactions: ({
+            typeArguments: string[];
+            arguments: ({
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "MoveCall";
+            target: `${string}::${string}::${string}`;
+        } | {
+            address: {
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            objects: ({
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "TransferObjects";
+        } | {
+            coin: {
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            amounts: ({
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "SplitCoins";
+        } | {
+            destination: {
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            sources: ({
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "MergeCoins";
+        } | {
+            objects: ({
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            type: {
+                Some: import("@mysten/sui/bcs").TypeTag;
+            } | {
+                None: true | null;
+            };
+            kind: "MakeMoveVec";
+        } | {
+            modules: number[][];
+            dependencies: string[];
+            kind: "Publish";
+        } | {
+            modules: number[][];
+            dependencies: string[];
+            ticket: {
+                kind: "Input";
+                value: unknown;
+                index: number;
+                type?: "object" | undefined;
+            } | {
+                type: "pure";
+                kind: "Input";
+                value: unknown;
+                index: number;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            kind: "Upgrade";
+            packageId: string;
+        })[];
+        sender?: string | undefined;
+    };
+    autoPure(value: SuiTxArg, type?: string): import("@mysten/sui/transactions").TransactionArgument[] | undefined;
+    address(value: string): {
+        $kind: "GasCoin";
+        GasCoin: true;
+    } | {
+        $kind: "Input";
+        Input: number;
+        type?: "pure" | undefined;
+    } | {
+        $kind: "Input";
+        Input: number;
+        type?: "object" | undefined;
+    } | {
+        $kind: "Result";
+        Result: number;
+    } | {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    };
+    get pure(): {
+        (value: SerializedBcs<any, any> | Uint8Array): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u8(value: number): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u16(value: number): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u32(value: number): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u64(value: string | number | bigint): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u128(value: string | number | bigint): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        u256(value: string | number | bigint): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        bool(value: boolean): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        string(value: string): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        address(value: string): {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        id: (value: string) => {
+            $kind: "GasCoin";
+            GasCoin: true;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "pure" | undefined;
+        } | {
+            $kind: "Input";
+            Input: number;
+            type?: "object" | undefined;
+        } | {
+            $kind: "Result";
+            Result: number;
+        } | {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+    };
+    object(value: string | TransactionObjectInput): {
+        $kind: "Input";
+        Input: number;
+        type?: "object" | undefined;
+    };
+    objectRef(ref: SuiObjectRef): {
+        $kind: "Input";
+        Input: number;
+        type?: "object" | undefined;
+    };
+    sharedObjectRef(ref: typeof bcs.SharedObjectRef.$inferType): {
+        $kind: "Input";
+        Input: number;
+        type?: "object" | undefined;
+    };
+    setSender(sender: string): void;
+    setSenderIfNotSet(sender: string): void;
+    setExpiration(expiration?: Parameters<typeof this.tx.setExpiration>[0]): void;
+    setGasPrice(price: number | bigint): void;
+    setGasBudget(budget: number | bigint): void;
+    setGasOwner(owner: string): void;
+    setGasPayment(payments: SuiObjectRef[]): void;
+    serialize(): string;
+    toJSON(): Promise<string>;
+    sign(params: {
+        signer: Keypair;
+        client?: SuiClient;
+        onlyTransactionKind?: boolean;
+    }): Promise<import("@mysten/sui/cryptography").SignatureWithBytes>;
+    build(params?: {
+        client?: SuiClient;
+        onlyTransactionKind?: boolean;
+    }): Promise<Uint8Array>;
+    getDigest(params?: {
+        client?: SuiClient;
+    }): Promise<string>;
+    add(...args: Parameters<typeof this.tx.add>): import("@mysten/sui/transactions").TransactionResult;
+    publish({ modules, dependencies, }: {
+        modules: number[][] | string[];
+        dependencies: string[];
+    }): import("@mysten/sui/transactions").TransactionResult;
+    upgrade(...args: Parameters<typeof this.tx.upgrade>): import("@mysten/sui/transactions").TransactionResult;
+    makeMoveVec(...args: Parameters<typeof this.tx.makeMoveVec>): import("@mysten/sui/transactions").TransactionResult;
+    transferObjects(objects: SuiObjectArg[], address: SuiAddressArg): import("@mysten/sui/transactions").TransactionResult;
+    splitCoins(coin: SuiObjectArg, amounts: SuiTxArg[]): {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }[];
+    mergeCoins(destination: SuiObjectArg, sources: SuiObjectArg[]): import("@mysten/sui/transactions").TransactionResult;
+    /**
+     * @description Move call
+     * @param target `${string}::${string}::${string}`, e.g. `0x3::sui_system::request_add_stake`
+     * @param args the arguments of the move call, such as `['0x1', '0x2']`
+     * @param typeArgs the type arguments of the move call, such as `['0x2::sui::SUI']`
+     */
+    moveCall(target: string, args?: (SuiTxArg | SuiVecTxArg)[], typeArgs?: string[]): import("@mysten/sui/transactions").TransactionResult;
+    transferSuiToMany(recipients: SuiAddressArg[], amounts: (SuiTxArg | number | bigint)[]): this;
+    transferSui(address: SuiAddressArg, amount: SuiTxArg | number | bigint): this;
+    takeAmountFromCoins(coins: SuiObjectArg[], amount: SuiTxArg | number | bigint): TransactionObjectArgument[];
+    splitSUIFromGas(amounts: SuiTxArg[]): import("@mysten/sui/transactions").TransactionResult;
+    splitMultiCoins(coins: SuiObjectArg[], amounts: SuiAmountsArg[]): {
+        splitedCoins: import("@mysten/sui/transactions").TransactionResult;
+        mergedCoin: TransactionObjectArgument;
+    };
+    transferCoinToMany(coins: SuiObjectArg[], sender: SuiAddressArg, recipients: SuiAddressArg[], amounts: SuiAmountsArg[]): this;
+    transferCoin(coins: SuiObjectArg[], sender: SuiAddressArg, recipient: SuiAddressArg, amount: SuiTxArg): this;
+    stakeSui(amount: SuiTxArg | number | bigint, validatorAddr: SuiAddressArg): import("@mysten/sui/transactions").TransactionResult;
+}

package/dist/libs/suiTxBuilder/util.d.ts

@@ -0,0 +1,49 @@
+import type { TransactionArgument, Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
+import type { SuiObjectArg, SuiAddressArg, SuiTxArg, SuiVecTxArg, SuiInputTypes } from 'src/types';
+export declare const getDefaultSuiInputType: (value: SuiTxArg) => 'u64' | 'bool' | 'object' | undefined;
+/**
+ * Since we know the elements in the array are the same type
+ * If type is not provided, we will try to infer the type from the first element
+ * By default,
+ *
+ * string is hex and its length equal to 32 =====> object id
+ * number, bigint ====> u64
+ * boolean =====> bool
+ *
+ * If type is provided, we will use the type to convert the array
+ * @param args
+ * @param type 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256' | 'signer' | 'object' | string
+ */
+export declare function makeVecParam(txBlock: Transaction, args: SuiTxArg[], type?: SuiInputTypes): TransactionArgument;
+/**
+ * Check whether it is an valid move vec input.
+ *
+ * @param arg The argument to check.
+ * @returns boolean.
+ */
+export declare function isMoveVecArg(arg: SuiTxArg | SuiVecTxArg): arg is SuiVecTxArg;
+/**
+ * Convert any valid input into array of TransactionArgument.
+ *
+ * @param txb The Transaction Block
+ * @param args The array of argument to convert.
+ * @returns The converted array of TransactionArgument.
+ */
+export declare function convertArgs(txBlock: Transaction, args: (SuiTxArg | SuiVecTxArg)[]): TransactionArgument[];
+/**
+ * Convert any valid address input into a TransactionArgument.
+ *
+ * @param txb The Transaction Block
+ * @param arg The address argument to convert.
+ * @returns The converted TransactionArgument.
+ */
+export declare function convertAddressArg(txBlock: Transaction, arg: SuiAddressArg): TransactionArgument;
+/**
+ * Convert any valid object input into a TransactionArgument.
+ *
+ * @param txb The Transaction Block
+ * @param arg The object argument to convert.
+ * @returns The converted TransactionArgument.
+ */
+export declare function convertObjArg(txb: Transaction, arg: SuiObjectArg): TransactionObjectArgument;
+export declare function convertAmounts(txBlock: Transaction, amounts: (SuiTxArg | number | bigint)[]): (TransactionArgument | number | bigint)[];

package/dist/metadata/index.d.ts

@@ -0,0 +1,3 @@
+import { SuiMoveNormalizedModules } from '@mysten/sui/client';
+import { NetworkType } from '../types';
+export declare function loadMetadata(networkType: NetworkType, packageId: string): Promise<SuiMoveNormalizedModules | undefined>;