@scallop-io/sui-scallop-sdk 1.5.0-alpha.1 → 1.5.1

package/dist/models/index.d.ts

@@ -1,8 +0,0 @@
-export * from './scallop';
-export * from './scallopAddress';
-export * from './scallopClient';
-export * from './scallopBuilder';
-export * from './scallopQuery';
-export * from './scallopUtils';
-export * from './scallopIndexer';
-export * from './scallopCache';

package/dist/models/scallop.d.ts

@@ -1,73 +0,0 @@
-import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopAddress } from './scallopAddress';
-import { ScallopClient } from './scallopClient';
-import { ScallopBuilder } from './scallopBuilder';
-import { ScallopQuery } from './scallopQuery';
-import { ScallopUtils } from './scallopUtils';
-import type { ScallopBuilderParams, ScallopClientParams, ScallopParams, ScallopQueryParams, ScallopUtilsParams } from '../types/';
-import { ScallopIndexer } from './scallopIndexer';
-import { ScallopCache } from './scallopCache';
-import { QueryClientConfig } from '@tanstack/query-core';
-import type { QueryClient } from '@tanstack/query-core';
-/**
- * @argument params - The parameters for the Scallop instance.
- * @argument cacheOptions - The cache options for the QueryClient.
- *
- * @description
- * The main instance that controls interaction with the Scallop contract.
- *
- * @example
- * ```typescript
- * const sdk = new Scallop(<parameters>);
- * const scallopAddress = await sdk.getScallopAddress();
- * const scallopBuilder = await sdk.createScallopBuilder();
- * const scallopClient = await sdk.createScallopClient();
- * const scallopIndexer= await sdk.createScallopIndexer();
- * const scallopUtils= await sdk.createScallopUtils();
- * ```
- */
-export declare class Scallop {
-    params: ScallopParams;
-    suiKit: SuiKit;
-    cache: ScallopCache;
-    private address;
-    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig, queryClient?: QueryClient);
-    /**
-     * Get a scallop address instance that already has read addresses.
-     *
-     * @param id - The API id of the addresses.
-     * @return Scallop Address.
-     */
-    getScallopAddress(id?: string): Promise<ScallopAddress>;
-    /**
-     * Create a scallop builder instance that already has initial data.
-     *
-     * @return Scallop Builder.
-     */
-    createScallopBuilder(params?: ScallopBuilderParams): Promise<ScallopBuilder>;
-    /**
-     * Create a scallop client instance that already has initial data.
-     *
-     * @param walletAddress - When user cannot provide a secret key or mnemonic, the scallop client cannot directly derive the address of the transaction the user wants to sign. This argument specifies the wallet address for signing the transaction.
-     * @return Scallop Client.
-     */
-    createScallopClient(params?: ScallopClientParams): Promise<ScallopClient>;
-    /**
-     * Create a scallop query instance.
-     *
-     * @return Scallop Query.
-     */
-    createScallopQuery(params?: ScallopQueryParams): Promise<ScallopQuery>;
-    /**
-     * Create a scallop indexer instance.
-     *
-     * @return Scallop Indexer.
-     */
-    createScallopIndexer(): Promise<ScallopIndexer>;
-    /**
-     * Create a scallop utils instance.
-     *
-     * @return Scallop Utils.
-     */
-    createScallopUtils(params?: ScallopUtilsParams): Promise<ScallopUtils>;
-}

package/dist/models/scallopAddress.d.ts

@@ -1,150 +0,0 @@
-import { type NetworkType } from '@scallop-io/sui-kit';
-import type { ScallopAddressParams, AddressesInterface, AddressStringPath, ScallopAddressInstanceParams } from '../types';
-import { ScallopCache } from './scallopCache';
-/**
- * @description
- * It provides methods for managing addresses.
- *
- * @example
- * ```typescript
- * const scallopAddress = new ScallopAddress(<parameters>);
- * scallopAddress.<address functions>();
- * await scallopAddress.<address async functions>();
- * ```
- */
-export declare class ScallopAddress {
-    private readonly _auth?;
-    private readonly _requestClient;
-    private _id?;
-    private _network;
-    private _currentAddresses?;
-    private _addressesMap;
-    cache: ScallopCache;
-    constructor(params: ScallopAddressParams, instance?: ScallopAddressInstanceParams);
-    /**
-     * Get addresses API id.
-     *
-     * @return The addresses API id.
-     */
-    getId(): string | undefined;
-    /**
-     * Get the address at the provided path.
-     *
-     * @param path - The path of the address to get.
-     * @return The address at the provided path.
-     */
-    get(path: AddressStringPath): any;
-    /**
-     * Sets the address for the specified path, it does not interact with the API.
-     *
-     * @param path - The path of the address to set.
-     * @param address - The address be setted to the tartget path.
-     * @return The addresses.
-     */
-    set(path: AddressStringPath, address: string): AddressesInterface | undefined;
-    /**
-     * Synchronize the specified network addresses from the addresses map to the
-     * current addresses and change the default network to specified network.
-     *
-     * @param network - Specifies which network's addresses you want to get.
-     * @return Current addresses.
-     */
-    switchCurrentAddresses(network: NetworkType): AddressesInterface | undefined;
-    /**
-     * Get the addresses, If `network` is not provided, returns the current
-     * addresses or the default network addresses in the addresses map.
-     *
-     * @param network - Specifies which network's addresses you want to get.
-     */
-    getAddresses(network?: NetworkType): AddressesInterface | undefined;
-    /**
-     * Set the addresses into addresses map. If the specified network is the same
-     * as the current network, the current addresses will be updated at the same time.
-     *
-     * @param addresses - The addresses be setted to the tartget network.
-     * @param network - Specifies which network's addresses you want to set.
-     * @return The addresses.
-     */
-    setAddresses(addresses: AddressesInterface, network?: NetworkType): void;
-    /**
-     * Get all addresses.
-     *
-     * @return All addresses.
-     */
-    getAllAddresses(): {
-        [k: string]: AddressesInterface;
-    };
-    /**
-     * Create a new addresses through the API and synchronize it back to the
-     * instance.
-     *
-     * @description
-     * If the `network` is not specified, the mainnet is used by default.
-     * If no `addresses` from instance or parameter is provided, an addresses with
-     * all empty strings is created by default.
-     *
-     * This function only allows for one addresses to be input into a specific network
-     * at a time, and does not provide an addresses map for setting addresses
-     * across all networks at once.
-     *
-     * @param params.addresses - The addresses be setted to the tartget network.
-     * @param params.network - Specifies which network's addresses you want to set.
-     * @param params.auth - The authentication API key.
-     * @param params.memo - Add memo to the addresses created in the API.
-     * @return All addresses.
-     */
-    create(params?: {
-        addresses?: AddressesInterface | undefined;
-        network?: NetworkType | undefined;
-        auth?: string | undefined;
-        memo?: string | undefined;
-    }): Promise<{
-        [k: string]: AddressesInterface;
-    }>;
-    /**
-     * Read and synchronizes all addresses from the API into instance.
-     *
-     * @param id - The id of the addresses to get.
-     * @return All addresses.
-     */
-    read(id?: string): Promise<{
-        [k: string]: AddressesInterface;
-    }>;
-    /**
-     * Update the addresses through the API and synchronize it back to the
-     * instance.
-     *
-     * @description
-     * If the `network` is not specified, the mainnet is used by default.
-     * If no `addresses` from instance or parameter is provided, an addresses with
-     * all empty strings is created by default.
-     *
-     * This function only allows for one addresses to be input into a specific network
-     * at a time, and does not provide an addresses map for setting addresses
-     * across all networks at once.
-     *
-     * @param params.id - The id of the addresses to update.
-     * @param params.addresses - The addresses be setted to the tartget network.
-     * @param params.network - Specifies which network's addresses you want to set.
-     * @param params.auth - The authentication api key.
-     * @param params.memo - Add memo to the addresses created in the API.
-     * @return All addresses.
-     */
-    update(params?: {
-        id?: string;
-        addresses?: AddressesInterface | undefined;
-        network?: NetworkType | undefined;
-        auth?: string | undefined;
-        memo?: string | undefined;
-    }): Promise<{
-        [k: string]: AddressesInterface;
-    }>;
-    /**
-     * Deletes all addresses of a specified id through the API and clear all
-     * addresses in the instance.
-     *
-     * @param id - The id of the addresses to delete.
-     * @param auth - The authentication API key.
-     */
-    delete(id?: string, auth?: string): Promise<void>;
-}

package/dist/models/scallopBuilder.d.ts

@@ -1,90 +0,0 @@
-import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopAddress } from './scallopAddress';
-import { ScallopQuery } from './scallopQuery';
-import { ScallopUtils } from './scallopUtils';
-import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import type { Transaction } from '@mysten/sui/transactions';
-import type { SuiAmountsArg, SuiTxBlock as SuiKitTxBlock, SuiObjectArg, SuiTxArg, SuiVecTxArg } from '@scallop-io/sui-kit';
-import type { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams, SelectCoinReturnType } from '../types';
-import { ScallopCache } from './scallopCache';
-/**
- * @description
- * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
- *
- * @example
- * ```typescript
- * const scallopBuilder = new ScallopBuilder(<parameters>);
- * await scallopBuilder.init();
- * const txBlock = scallopBuilder.<builder functions>();
- * ```
- */
-export declare class ScallopBuilder {
-    readonly params: ScallopBuilderParams;
-    readonly isTestnet: boolean;
-    suiKit: SuiKit;
-    address: ScallopAddress;
-    query: ScallopQuery;
-    utils: ScallopUtils;
-    walletAddress: string;
-    cache: ScallopCache;
-    constructor(params?: ScallopBuilderParams, instance?: ScallopBuilderInstanceParams);
-    /**
-     * Request the scallop API to initialize data.
-     *
-     * @param force - Whether to force initialization.
-     * @param address - ScallopAddress instance.
-     */
-    init(force?: boolean, address?: ScallopAddress): Promise<void>;
-    /**
-     * Create a scallop txBlock instance that enhances transaction block.
-     *
-     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
-     * @return Scallop txBlock.
-     */
-    createTxBlock(txBlock?: ScallopTxBlock | SuiKitTxBlock | Transaction): ScallopTxBlock;
-    /**
-     * Specifying the sender's amount of coins to get coins args from transaction result.
-     *
-     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
-     * @param assetCoinName - Specific support asset coin name.
-     * @param amount - Amount of coins to be selected.
-     * @param sender - Sender address.
-     * @return Take coin and left coin.
-     */
-    selectCoin<T extends SupportAssetCoins>(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: T, amount: number, sender?: string): Promise<SelectCoinReturnType<T>>;
-    /**
-     * Specifying the sender's amount of market coins to get coins args from transaction result.
-     *
-     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
-     * @param marketCoinName - Specific support market coin name.
-     * @param amount - Amount of coins to be selected.
-     * @param sender - Sender address.
-     * @return Take coin and left coin.
-     */
-    selectMarketCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender?: string): Promise<{
-        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        totalAmount: number;
-    }>;
-    /**
-     * Specifying the sender's amount of sCoins to get coins args from transaction result.
-     *
-     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
-     * @param marketCoinName - Specific support sCoin name.
-     * @param amount - Amount of coins to be selected.
-     * @param sender - Sender address.
-     * @return Take coin and left coin.
-     */
-    selectSCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender?: string): Promise<{
-        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        totalAmount: number;
-    }>;
-    /**
-     * Execute Scallop txBlock using the `signAndSendTxn` methods in suikit.
-     *
-     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
-     */
-    signAndSendTxBlock(txBlock: ScallopTxBlock | SuiKitTxBlock | Transaction): Promise<SuiTransactionBlockResponse>;
-    moveCall(txb: ScallopTxBlock | SuiKitTxBlock, target: string, args?: (SuiTxArg | SuiVecTxArg | SuiObjectArg | SuiAmountsArg)[], typeArgs?: string[]): import("@scallop-io/sui-kit").TransactionResult;
-}

package/dist/models/scallopCache.d.ts

@@ -1,81 +0,0 @@
-import { QueryClient } from '@tanstack/query-core';
-import { SuiObjectArg } from '@scallop-io/sui-kit';
-import { SuiKit } from '@scallop-io/sui-kit';
-import type { SuiObjectResponse, SuiObjectDataOptions, SuiObjectData, GetOwnedObjectsParams, DevInspectResults, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams, GetBalanceParams, CoinBalance } from '@mysten/sui/client';
-import { ScallopCacheInstanceParams, ScallopCacheParams } from 'src/types';
-type QueryInspectTxnParams = {
-    queryTarget: string;
-    args: SuiObjectArg[];
-    typeArgs?: any[];
-};
-/**
- * @description
- * It provides caching for moveCall, RPC Request, and API Request.
- *
- *
- * @example
- * ```typescript
- * const scallopCache = new scallopCache(<parameters>);
- * scallopCache.<indexer functions>();
- * await scallopCache.<indexer async functions>();
- * ```
- */
-export declare class ScallopCache {
-    readonly params: ScallopCacheParams;
-    queryClient: QueryClient;
-    suiKit: SuiKit;
-    walletAddress: string;
-    private tokensPerInterval;
-    private interval;
-    private tokens;
-    private lastRefill;
-    constructor(params?: ScallopCacheParams, instance?: ScallopCacheInstanceParams);
-    private get client();
-    private refill;
-    private removeTokens;
-    private callWithRateLimit;
-    /**
-     * @description Invalidate cache based on the refetchType parameter
-     * @param refetchType Determines the type of queries to be refetched. Defaults to `active`.
-     *
-     * - `active`: Only queries that match the refetch predicate and are actively being rendered via useQuery and related functions will be refetched in the background.
-     * - `inactive`: Only queries that match the refetch predicate and are NOT actively being rendered via useQuery and related functions will be refetched in the background.
-     * - `all`: All queries that match the refetch predicate will be refetched in the background.
-     * - `none`: No queries will be refetched. Queries that match the refetch predicate will only be marked as invalid.
-     */
-    private retryFn;
-    /**
-     * @description Provides cache for inspectTxn of the SuiKit.
-     * @param QueryInspectTxnParams
-     * @param txBlock
-     * @returns Promise<DevInspectResults>
-     */
-    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults | null>;
-    queryGetNormalizedMoveFunction(target: string): Promise<import("@mysten/sui/client").SuiMoveNormalizedFunction | null>;
-    /**
-     * @description Provides cache for getObject of the SuiKit.
-     * @param objectId
-     * @param QueryObjectParams
-     * @returns Promise<SuiObjectResponse>
-     */
-    queryGetObject(objectId: string, options?: SuiObjectDataOptions): Promise<SuiObjectResponse | null>;
-    /**
-     * @description Provides cache for getObjects of the SuiKit.
-     * @param objectIds
-     * @returns Promise<SuiObjectData[]>
-     */
-    queryGetObjects(objectIds: string[]): Promise<SuiObjectData[]>;
-    /**
-     * @description Provides cache for getOwnedObjects of the SuiKit.
-     * @param input
-     * @returns Promise<PaginatedObjectsResponse>
-     */
-    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<import("@mysten/sui/client").PaginatedObjectsResponse | null>;
-    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage | null>;
-    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse | null>;
-    queryGetAllCoinBalances(owner: string): Promise<{
-        [k: string]: CoinBalance;
-    }>;
-    queryGetCoinBalance(input: GetBalanceParams): Promise<CoinBalance | null>;
-}
-export {};