@scallop-io/sui-kit 1.4.3 → 2.0.0

package/dist/suiKit.d.ts

@@ -1,128 +0,0 @@
-import { Transaction } from '@mysten/sui/transactions';
-import { SuiAccountManager } from './libs/suiAccountManager';
-import { SuiTxBlock } from './libs/suiTxBuilder';
-import { SuiInteractor } from './libs/suiInteractor';
-import type { SuiTransactionBlockResponse, DevInspectResults, SuiObjectDataOptions, DryRunTransactionBlockResponse } from '@mysten/sui/client';
-import type { SuiSharedObject, SuiOwnedObject } from './libs/suiModel';
-import type { SuiKitParams, DerivePathParams, SuiTxArg, SuiVecTxArg, SuiKitReturnType, SuiObjectArg } from './types';
-/**
- * @class SuiKit
- * @description This class is used to aggregate the tools that used to interact with SUI network.
- */
-export declare class SuiKit {
-    accountManager: SuiAccountManager;
-    suiInteractor: SuiInteractor;
-    /**
-     * 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 or bech32, when mnemonics is provided, secretKey will be ignored
-     * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'mainnet'
-     * @param fullnodeUrls, the fullnode url, default is the preconfig fullnode url for the given network type
-     */
-    constructor(params: SuiKitParams);
-    /**
-     * Create SuiTxBlock with sender set to the current signer
-     * @returns SuiTxBlock with sender set to the current signer
-     */
-    createTxBlock(): SuiTxBlock;
-    /**
-     * if derivePathParams is not provided or mnemonics is empty, it will return the keypair.
-     * else:
-     * it will generate signer from the mnemonic with the given derivePathParams.
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    getKeypair(derivePathParams?: DerivePathParams): import("@mysten/sui/dist/cjs/keypairs/ed25519").Ed25519Keypair;
-    /**
-     * @description Switch the current account with the given derivePathParams
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    switchAccount(derivePathParams: DerivePathParams): void;
-    /**
-     * @description Get the address of the account for the given derivePathParams
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    getAddress(derivePathParams?: DerivePathParams): string;
-    get currentAddress(): string;
-    getBalance(coinType?: string, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui/client").CoinBalance>;
-    get client(): import("@mysten/sui/client").SuiClient;
-    getObjects(objectIds: string[], options?: SuiObjectDataOptions & {
-        batchSize?: number;
-        switchClientDelay?: number;
-    }): Promise<import("@mysten/sui/client").SuiObjectData[]>;
-    /**
-     * @description Update objects in a batch
-     * @param suiObjects
-     */
-    updateObjects(suiObjects: (SuiSharedObject | SuiOwnedObject)[]): Promise<void>;
-    signTxn(tx: Uint8Array | Transaction | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui/dist/cjs/cryptography").SignatureWithBytes>;
-    signAndSendTxn(tx: Uint8Array | Transaction | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    dryRunTxn(tx: Uint8Array | Transaction | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<DryRunTransactionBlockResponse>;
-    /**
-     * Transfer the given amount of SUI to the recipient
-     * @param recipient
-     * @param amount
-     * @param derivePathParams
-     */
-    transferSui(recipient: string, amount: number, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferSui<S extends boolean>(recipient: string, amount: number, sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    /**
-     * Transfer to mutliple recipients
-     * @param recipients the recipients addresses
-     * @param amounts the amounts of SUI to transfer to each recipient, the length of amounts should be the same as the length of recipients
-     * @param derivePathParams
-     */
-    transferSuiToMany(recipients: string[], amounts: number[], derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferSuiToMany<S extends boolean>(recipients: string[], amounts: number[], sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    /**
-     * Transfer the given amounts of coin to multiple recipients
-     * @param recipients the list of recipient address
-     * @param amounts the amounts to transfer for each recipient
-     * @param coinType any custom coin type but not SUI
-     * @param derivePathParams the derive path params for the current signer
-     */
-    transferCoinToMany(recipients: string[], amounts: number[], coinType: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferCoinToMany<S extends boolean>(recipients: string[], amounts: number[], coinType: string, sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    transferCoin(recipient: string, amount: number, coinType: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferCoin<S extends boolean>(recipient: string, amount: number, coinType: string, sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    transferObjects(objects: SuiObjectArg[], recipient: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferObjects<S extends boolean>(objects: SuiObjectArg[], recipient: string, sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    moveCall(callParams: {
-        target: string;
-        arguments?: (SuiTxArg | SuiVecTxArg)[];
-        typeArguments?: string[];
-        derivePathParams?: DerivePathParams;
-    }): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Select coins with the given amount and coin type, the total amount is greater than or equal to the given amount
-     * @param amount
-     * @param coinType
-     * @param owner
-     */
-    selectCoinsWithAmount(amount: number, coinType: string, owner?: string): Promise<{
-        objectId: string;
-        digest: string;
-        version: string;
-        balance: string;
-    }[]>;
-    /**
-     * stake the given amount of SUI to the validator
-     * @param amount the amount of SUI to stake
-     * @param validatorAddr the validator address
-     * @param sign whether to sign and send the transaction, default is true
-     * @param derivePathParams the derive path params for the current signer
-     */
-    stakeSui(amount: number, validatorAddr: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    stakeSui<S extends boolean>(amount: number, validatorAddr: string, sign?: S, derivePathParams?: DerivePathParams): Promise<SuiKitReturnType<S>>;
-    /**
-     * Execute the transaction with on-chain data but without really submitting. Useful for querying the effects of a transaction.
-     * Since the transaction is not submitted, its gas cost is not charged.
-     * @param tx the transaction to execute
-     * @param derivePathParams the derive path params
-     * @returns the effects and events of the transaction, such as object changes, gas cost, event emitted.
-     */
-    inspectTxn(tx: Uint8Array | Transaction | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<DevInspectResults>;
-}

package/dist/types/index.d.ts

@@ -1,76 +0,0 @@
-import type { Transaction, TransactionObjectArgument, Argument, Inputs, TransactionArgument } from '@mysten/sui/transactions';
-import type { SerializedBcs } from '@mysten/bcs';
-import { SuiClient, SuiTransactionBlockResponse } from '@mysten/sui/client';
-import { SuiTxBlock } from 'src/libs/suiTxBuilder';
-export type SuiKitParams = (AccountManagerParams & {
-    faucetUrl?: string;
-    networkType?: NetworkType;
-}) & Partial<SuiInteractorParams>;
-export type SuiInteractorParams = {
-    fullnodeUrls: string[];
-} | {
-    suiClients: SuiClient[];
-};
-export type NetworkType = 'testnet' | 'mainnet' | 'devnet' | 'localnet';
-export type AccountManagerParams = {
-    mnemonics?: string;
-    secretKey?: string;
-};
-export type DerivePathParams = {
-    accountIndex?: number;
-    isExternal?: boolean;
-    addressIndex?: number;
-};
-type TransactionBlockType = InstanceType<typeof Transaction>;
-export type PureCallArg = {
-    Pure: number[];
-};
-type SharedObjectRef = {
-    /** Hex code as string representing the object id */
-    objectId: string;
-    /** The version the object was shared at */
-    initialSharedVersion: number | string;
-    /** Whether reference is mutable */
-    mutable: boolean;
-};
-type SuiObjectRef = {
-    /** Base64 string representing the object digest */
-    objectId: string;
-    /** Object version */
-    version: number | string;
-    /** Hex code as string representing the object id */
-    digest: string;
-};
-/**
- * An object argument.
- */
-type ObjectArg = {
-    ImmOrOwnedObject: SuiObjectRef;
-} | {
-    SharedObject: SharedObjectRef;
-} | {
-    Receiving: SuiObjectRef;
-};
-export type ObjectCallArg = {
-    Object: ObjectArg;
-};
-export type TransactionType = Parameters<TransactionBlockType['add']>;
-export type TransactionPureArgument = Extract<Argument, {
-    $kind: 'Input';
-    type?: 'pure';
-}>;
-export type SuiTxArg = TransactionArgument | SerializedBcs<any>;
-export type SuiAddressArg = Argument | SerializedBcs<any> | string;
-export type SuiAmountsArg = SuiTxArg | number | bigint;
-export type SuiObjectArg = TransactionObjectArgument | string | Parameters<typeof Inputs.ObjectRef>[0] | Parameters<typeof Inputs.SharedObjectRef>[0] | ObjectCallArg;
-export type SuiVecTxArg = {
-    value: SuiTxArg[];
-    vecType: SuiInputTypes;
-} | SuiTxArg[];
-/**
- * These are the basics types that can be used in the SUI
- */
-export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256';
-export type SuiInputTypes = 'object' | SuiBasicTypes;
-export type SuiKitReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : SuiTxBlock;
-export {};