@0xobelisk/client 0.3.2 → 0.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/client",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",

package/dist/index.d.ts

@@ -1,9 +0,0 @@
-export * from '@mysten/sui.js';
-export { Ed25519Keypair } from '@mysten/sui.js/keypairs/ed25519';
-export * from '@mysten/bcs';
-export { Obelisk } from './obelisk';
-export { SuiAccountManager } from './libs/suiAccountManager';
-export { SuiTxBlock } from './libs/suiTxBuilder';
-export { SuiContractFactory } from './libs/suiContractFactory';
-export { getMetadata } from './metadata';
-export type * from './types';

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

@@ -1,35 +0,0 @@
-import { Ed25519Keypair } from '@mysten/sui.js';
-import type { AccountMangerParams, DerivePathParams } from 'src/types';
-export declare class SuiAccountManager {
-    private mnemonics;
-    private secretKey;
-    currentKeyPair: Ed25519Keypair;
-    currentAddress: string;
-    /**
-     * Support the following ways to init the SuiToolkit:
-     * 1. mnemonics
-     * 2. secretKey (base64 or hex)
-     * If none of them is provided, will generate a random mnemonics with 24 words.
-     *
-     * @param mnemonics, 12 or 24 mnemonics words, separated by space
-     * @param secretKey, base64 or hex string, when mnemonics is provided, secretKey will be ignored
-     */
-    constructor({ mnemonics, secretKey }?: AccountMangerParams);
-    /**
-     * if derivePathParams is not provided or mnemonics is empty, it will return the currentKeyPair.
-     * else:
-     * it will generate keyPair from the mnemonic with the given derivePathParams.
-     */
-    getKeyPair(derivePathParams?: DerivePathParams): Ed25519Keypair;
-    /**
-     * if derivePathParams is not provided or mnemonics is empty, it will return the currentAddress.
-     * else:
-     * it will generate address from the mnemonic with the given derivePathParams.
-     */
-    getAddress(derivePathParams?: DerivePathParams): string;
-    /**
-     * Switch the current account with the given derivePathParams.
-     * This is only useful when the mnemonics is provided. For secretKey mode, it will always use the same account.
-     */
-    switchAccount(derivePathParams: DerivePathParams): void;
-}

package/dist/libs/suiAccountManager/keypair.d.ts

@@ -1,21 +0,0 @@
-import { Ed25519Keypair } from '@mysten/sui.js';
-import type { DerivePathParams } from 'src/types';
-/**
- * @description Get ed25519 derive path for SUI
- * @param derivePathParams
- */
-export declare const getDerivePathForSUI: (derivePathParams?: DerivePathParams) => string;
-/**
- * the format is m/44'/784'/accountIndex'/${isExternal ? 1 : 0}'/addressIndex'
- *
- * accountIndex is the index of the account, default is 0.
- *
- * isExternal is the type of the address, default is false. Usually, the external address is used to receive coins. The internal address is used to change coins.
- *
- * addressIndex is the index of the address, default is 0. It's used to generate multiple addresses for one account.
- *
- * @description Get keypair from mnemonics and derive path
- * @param mnemonics
- * @param derivePathParams
- */
-export declare const getKeyPair: (mnemonics: string, derivePathParams?: DerivePathParams) => Ed25519Keypair;

package/dist/libs/suiInteractor/defaultConfig.d.ts

@@ -1,10 +0,0 @@
-import type { Connection } from '@mysten/sui.js';
-import type { NetworkType } from 'src/types';
-export declare const defaultGasBudget: number;
-export declare const defaultGasPrice = 1000;
-/**
- * @description Get the default fullnode url and faucet url for the given network type
- * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
- * @returns { fullNode: string, websocket: string, faucet?: string }
- */
-export declare const getDefaultConnection: (networkType?: NetworkType) => Connection;

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

@@ -1,2 +0,0 @@
-export { SuiInteractor } from './suiInteractor';
-export { getDefaultConnection } from './defaultConfig';

package/dist/libs/suiInteractor/suiInteractor.d.ts

@@ -1,205 +0,0 @@
-import { SuiTransactionBlockResponse, JsonRpcProvider, DynamicFieldName, SuiAddress } from '@mysten/sui.js';
-import { FaucetNetworkType, NetworkType, ObjectData, EntityData } from 'src/types';
-import { SuiOwnedObject, SuiSharedObject } from '../suiModel';
-/**
- * `SuiTransactionSender` is used to send transaction with a given gas coin.
- * It always uses the gas coin to pay for the gas,
- * and update the gas coin after the transaction.
- */
-export declare class SuiInteractor {
-    readonly providers: JsonRpcProvider[];
-    currentProvider: JsonRpcProvider;
-    network?: NetworkType;
-    constructor(fullNodeUrls: string[], network?: NetworkType);
-    switchToNextProvider(): void;
-    sendTx(transactionBlock: Uint8Array | string, signature: string | string[]): Promise<SuiTransactionBlockResponse>;
-    getObjects(ids: string[]): Promise<ObjectData[]>;
-    getObject(id: string): Promise<ObjectData>;
-    getEntitiesObjects(ids: string[]): Promise<EntityData[]>;
-    getDynamicFieldObject(parentId: string, name: string | DynamicFieldName): Promise<{
-        data?: {
-            objectId: string;
-            version: string;
-            digest: string;
-            type?: string | null | undefined;
-            bcs?: {
-                type: string;
-                version: string;
-                hasPublicTransfer: boolean;
-                dataType: "moveObject";
-                bcsBytes: string;
-            } | {
-                id: string;
-                dataType: "package";
-                moduleMap: Record<string, string>;
-            } | null | undefined;
-            owner?: {
-                AddressOwner: string;
-            } | {
-                ObjectOwner: string;
-            } | {
-                Shared: {
-                    initial_shared_version: string | null;
-                };
-            } | "Immutable" | null | undefined;
-            storageRebate?: string | null | undefined;
-            previousTransaction?: string | null | undefined;
-            content?: {
-                type: string;
-                fields: Record<string, any>;
-                hasPublicTransfer: boolean;
-                dataType: "moveObject";
-            } | {
-                disassembled: Record<string, unknown>;
-                dataType: "package";
-            } | null | undefined;
-            display?: Record<string, string> | {
-                data?: Record<string, string> | null | undefined;
-                error?: {
-                    code: string;
-                    version?: string | undefined;
-                    digest?: string | undefined;
-                    error?: string | undefined;
-                    object_id?: string | undefined;
-                    parent_object_id?: string | undefined;
-                } | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
-        error?: {
-            code: string;
-            version?: string | undefined;
-            digest?: string | undefined;
-            error?: string | undefined;
-            object_id?: string | undefined;
-            parent_object_id?: string | undefined;
-        } | null | undefined;
-    }>;
-    getDynamicFields(parentId: string, cursor?: string, limit?: number): Promise<{
-        data: {
-            type: "DynamicField" | "DynamicObject";
-            objectType: string;
-            objectId: string;
-            version: number;
-            digest: string;
-            name: {
-                type: string;
-                value?: any;
-            };
-            bcsName: string;
-        }[];
-        nextCursor: string | null;
-        hasNextPage: boolean;
-    }>;
-    getOwnedObjects(owner: SuiAddress, cursor?: string, limit?: number): Promise<{
-        data: {
-            data?: {
-                objectId: string;
-                version: string;
-                digest: string;
-                type?: string | null | undefined;
-                bcs?: {
-                    type: string;
-                    version: string;
-                    hasPublicTransfer: boolean;
-                    dataType: "moveObject";
-                    bcsBytes: string;
-                } | {
-                    id: string;
-                    dataType: "package";
-                    moduleMap: Record<string, string>;
-                } | null | undefined;
-                owner?: "Immutable" | {
-                    AddressOwner: string;
-                } | {
-                    ObjectOwner: string;
-                } | {
-                    Shared: {
-                        initial_shared_version: string | null;
-                    };
-                } | null | undefined;
-                storageRebate?: string | null | undefined;
-                previousTransaction?: string | null | undefined;
-                content?: {
-                    type: string;
-                    fields: Record<string, any>;
-                    hasPublicTransfer: boolean;
-                    dataType: "moveObject";
-                } | {
-                    disassembled: Record<string, unknown>;
-                    dataType: "package";
-                } | null | undefined;
-                display?: Record<string, string> | {
-                    data?: Record<string, string> | null | undefined;
-                    error?: {
-                        code: string;
-                        version?: string | undefined;
-                        digest?: string | undefined;
-                        error?: string | undefined;
-                        object_id?: string | undefined;
-                        parent_object_id?: string | undefined;
-                    } | null | undefined;
-                } | null | undefined;
-            } | null | undefined;
-            error?: {
-                code: string;
-                version?: string | undefined;
-                digest?: string | undefined;
-                error?: string | undefined;
-                object_id?: string | undefined;
-                parent_object_id?: string | undefined;
-            } | null | undefined;
-        }[];
-        hasNextPage: boolean;
-        nextCursor?: string | null | undefined;
-    }>;
-    getNormalizedMoveModulesByPackage(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[];
-        }>;
-    }>>;
-    /**
-     * @description Update objects in a batch
-     * @param suiObjects
-     */
-    updateObjects(suiObjects: (SuiOwnedObject | SuiSharedObject)[]): Promise<void>;
-    /**
-     * @description Select coins that add up to the given amount.
-     * @param addr the address of the owner
-     * @param amount the amount that is needed for the coin
-     * @param coinType the coin type, default is '0x2::SUI::SUI'
-     */
-    selectCoins(addr: string, amount: number, coinType?: string): Promise<{
-        objectId: string;
-        digest: string;
-        version: string;
-    }[]>;
-    requestFaucet(address: SuiAddress, network: FaucetNetworkType): Promise<void>;
-}