@0xobelisk/client 0.3.0 → 0.3.2

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

@@ -0,0 +1,544 @@
+import { TransactionBlock, TransactionExpiration, SuiObjectRef, SharedObjectRef, JsonRpcProvider, TransactionType, Transactions, ObjectCallArg } from '@mysten/sui.js';
+import type { SuiTxArg, SuiObjectArg, SuiVecTxArg } from 'src/types';
+export declare class SuiTxBlock {
+    txBlock: TransactionBlock;
+    constructor(transaction?: TransactionBlock);
+    address(value: string): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    };
+    pure(value: unknown, type?: string): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    };
+    object(value: string | ObjectCallArg): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    };
+    objectRef(ref: SuiObjectRef): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    };
+    sharedObjectRef(ref: SharedObjectRef): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    };
+    setSender(sender: string): void;
+    setSenderIfNotSet(sender: string): void;
+    setExpiration(expiration?: TransactionExpiration): void;
+    setGasPrice(price: number | bigint): void;
+    setGasBudget(budget: number | bigint): void;
+    setGasOwner(owner: string): void;
+    setGasPayment(payments: SuiObjectRef[]): void;
+    add(transaction: TransactionType): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    serialize(): string;
+    build(params?: {
+        provider?: JsonRpcProvider;
+        onlyTransactionKind?: boolean;
+    }): Promise<Uint8Array>;
+    getDigest({ provider }?: {
+        provider?: JsonRpcProvider;
+    }): Promise<string>;
+    get gas(): {
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    };
+    get blockData(): {
+        version: 1;
+        transactions: ({
+            arguments: ({
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "MoveCall";
+            target: `${string}::${string}::${string}`;
+            typeArguments: string[];
+        } | {
+            objects: ({
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "TransferObjects";
+            address: {
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+        } | {
+            kind: "SplitCoins";
+            coin: {
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            amounts: ({
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+        } | {
+            kind: "MergeCoins";
+            destination: {
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+            sources: ({
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+        } | {
+            objects: ({
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            })[];
+            kind: "MakeMoveVec";
+            type?: {
+                None: true | null;
+            } | {
+                Some: Record<string, unknown>;
+            } | undefined;
+        } | {
+            kind: "Publish";
+            dependencies: string[];
+            modules: number[][];
+        } | {
+            packageId: string;
+            kind: "Upgrade";
+            dependencies: string[];
+            modules: number[][];
+            ticket: {
+                kind: "Input";
+                index: number;
+                type?: "object" | "pure" | undefined;
+                value?: any;
+            } | {
+                kind: "GasCoin";
+            } | {
+                kind: "Result";
+                index: number;
+            } | {
+                kind: "NestedResult";
+                index: number;
+                resultIndex: number;
+            };
+        })[];
+        inputs: {
+            kind: "Input";
+            index: number;
+            type?: "object" | "pure" | undefined;
+            value?: any;
+        }[];
+        gasConfig: {
+            payment?: {
+                objectId: string;
+                version: string | number;
+                digest: string;
+            }[] | undefined;
+            owner?: string | undefined;
+            price?: string | undefined;
+            budget?: string | undefined;
+        };
+        sender?: string | undefined;
+        expiration?: {
+            Epoch: number;
+        } | {
+            None: true | null;
+        } | null | undefined;
+    };
+    transferObjects(objects: SuiObjectArg[], recipient: string): this;
+    splitCoins(coin: SuiObjectArg, amounts: number[]): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    mergeCoins(destination: SuiObjectArg, sources: SuiObjectArg[]): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    publish(...args: Parameters<(typeof Transactions)['Publish']>): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    upgrade(...args: Parameters<(typeof Transactions)['Upgrade']>): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    makeMoveVec(...args: Parameters<(typeof Transactions)['MakeMoveVec']>): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    /**
+     * @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[]): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    transferSuiToMany(recipients: string[], amounts: number[]): this;
+    transferSui(recipient: string, amount: number): this;
+    takeAmountFromCoins(coins: SuiObjectArg[], amount: number): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    splitSUIFromGas(amounts: number[]): ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    }) & ({
+        kind: "Input";
+        index: number;
+        type?: "object" | "pure" | undefined;
+        value?: any;
+    } | {
+        kind: "GasCoin";
+    } | {
+        kind: "Result";
+        index: number;
+    } | {
+        kind: "NestedResult";
+        index: number;
+        resultIndex: number;
+    })[];
+    splitMultiCoins(coins: SuiObjectArg[], amounts: number[]): {
+        splitedCoins: ({
+            kind: "Input";
+            index: number;
+            type?: "object" | "pure" | undefined;
+            value?: any;
+        } | {
+            kind: "GasCoin";
+        } | {
+            kind: "Result";
+            index: number;
+        } | {
+            kind: "NestedResult";
+            index: number;
+            resultIndex: number;
+        }) & ({
+            kind: "Input";
+            index: number;
+            type?: "object" | "pure" | undefined;
+            value?: any;
+        } | {
+            kind: "GasCoin";
+        } | {
+            kind: "Result";
+            index: number;
+        } | {
+            kind: "NestedResult";
+            index: number;
+            resultIndex: number;
+        })[];
+        mergedCoin: {
+            kind: "Input";
+            index: number;
+            type?: "object" | "pure" | undefined;
+            value?: any;
+        } | {
+            kind: "GasCoin";
+        } | {
+            kind: "Result";
+            index: number;
+        } | {
+            kind: "NestedResult";
+            index: number;
+            resultIndex: number;
+        };
+    };
+    transferCoinToMany(inputCoins: SuiObjectArg[], sender: string, recipients: string[], amounts: number[]): this;
+    transferCoin(inputCoins: SuiObjectArg[], sender: string, recipient: string, amount: number): this;
+    stakeSui(amount: number, validatorAddr: string): TransactionBlock;
+}

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

@@ -0,0 +1,76 @@
+import { TransactionArgument, TransactionBlock } from '@mysten/sui.js';
+import { SuiTxArg, SuiInputTypes } from 'src/types';
+export declare const getDefaultSuiInputType: (value: any) => SuiInputTypes;
+/**
+ * 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 starting with `0x` =====> 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' | 'object'
+ */
+export declare function makeVecParam(txBlock: TransactionBlock, args: SuiTxArg[], type?: SuiInputTypes): ({
+    kind: "GasCoin";
+} & ({
+    kind: "Input";
+    index: number;
+    type?: "object" | "pure" | undefined;
+    value?: any;
+} | {
+    kind: "GasCoin";
+} | {
+    kind: "Result";
+    index: number;
+} | {
+    kind: "NestedResult";
+    index: number;
+    resultIndex: number;
+})[]) | ({
+    kind: "Result";
+    index: number;
+} & ({
+    kind: "Input";
+    index: number;
+    type?: "object" | "pure" | undefined;
+    value?: any;
+} | {
+    kind: "GasCoin";
+} | {
+    kind: "Result";
+    index: number;
+} | {
+    kind: "NestedResult";
+    index: number;
+    resultIndex: number;
+})[]) | ({
+    kind: "NestedResult";
+    index: number;
+    resultIndex: number;
+} & ({
+    kind: "Input";
+    index: number;
+    type?: "object" | "pure" | undefined;
+    value?: any;
+} | {
+    kind: "GasCoin";
+} | {
+    kind: "Result";
+    index: number;
+} | {
+    kind: "NestedResult";
+    index: number;
+    resultIndex: number;
+})[]) | {
+    kind: "Input";
+    index: number;
+    type?: "object" | "pure" | undefined;
+    value?: any;
+};
+export declare function isMoveVecArg(arg: any): any;
+export declare function convertArgs(txBlock: TransactionBlock, args: any[]): TransactionArgument[];

package/dist/metadata/index.d.ts

@@ -0,0 +1,34 @@
+import { NetworkType } from 'src/types';
+export declare function getMetadata(networkType: NetworkType, packageId: string): Promise<Record<string, {
+    address: string;
+    name: string;
+    fileFormatVersion: number;
+    friends: {
+        address: string;
+        name: string;
+    }[];
+    structs: Record<string, {
+        fields: {
+            type: import("@mysten/sui.js").SuiMoveNormalizedType;
+            name: string;
+        }[];
+        abilities: {
+            abilities: string[];
+        };
+        typeParameters: {
+            constraints: {
+                abilities: string[];
+            };
+            isPhantom: boolean;
+        }[];
+    }>;
+    exposedFunctions: Record<string, {
+        visibility: "Private" | "Public" | "Friend";
+        isEntry: boolean;
+        typeParameters: {
+            abilities: string[];
+        }[];
+        parameters: import("@mysten/sui.js").SuiMoveNormalizedType[];
+        return: import("@mysten/sui.js").SuiMoveNormalizedType[];
+    }>;
+}> | undefined>;