@bolt-liquidity-hq/sui-client 0.1.0-beta.10

package/dist/index.d.ts

@@ -0,0 +1,371 @@
+import { ChainConfig, ClientConfig, BaseClient, OracleConfig, OracleAssetPair, InvertiblePrice, Price, RouterConfig, Address, BaseLiquidityDetails, Coin, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
+import { SuiClient, SuiTransactionBlockResponse } from '@mysten/sui/client';
+import { Signer } from '@mysten/sui/cryptography';
+import * as _mysten_bcs from '@mysten/bcs';
+import { BcsType } from '@mysten/bcs';
+
+declare const PaginationStruct: {
+    total_count: BcsType<string, string | number | bigint, "u64">;
+    has_next_page: BcsType<boolean, boolean, "bool">;
+    next_cursor: BcsType<string | null, string | null | undefined, "Option<string>">;
+};
+declare const BcsAddressType: BcsType<string, string, "address">;
+type BcsParsed<T extends BcsType<any, any>> = ReturnType<T['parse']>;
+type BcsParsedMultiple<T extends readonly BcsType<any>[]> = {
+    [K in keyof T]: BcsParsed<T[K]>;
+};
+
+type SuiChainConfig = ChainConfig;
+
+type SuiClientConfig = ClientConfig<SuiChainConfig> & {
+    suiClient?: SuiClient;
+    customOverride?: ClientConfig<SuiChainConfig>['customOverride'] & {
+        packageId?: string;
+    };
+};
+
+declare const OracleConfigStruct: _mysten_bcs.BcsStruct<{
+    admin: _mysten_bcs.BcsType<string, string, "address">;
+    price_threshold_ratio: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    default_price_expiry_seconds: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+}, string>;
+type OracleConfigStructOutput = BcsParsed<typeof OracleConfigStruct>;
+declare const AssetPairStruct: _mysten_bcs.BcsStruct<{
+    base_symbol: _mysten_bcs.BcsType<string, string, "string">;
+    quote_symbol: _mysten_bcs.BcsType<string, string, "string">;
+    base_precision: _mysten_bcs.BcsType<number, number, "u8">;
+    quote_precision: _mysten_bcs.BcsType<number, number, "u8">;
+}, string>;
+type AssetPairStructOutput = BcsParsed<typeof AssetPairStruct>;
+declare const AssetPairsResponseStruct: _mysten_bcs.BcsStruct<{
+    asset_pairs: _mysten_bcs.BcsType<{
+        base_symbol: string;
+        quote_symbol: string;
+        base_precision: number;
+        quote_precision: number;
+    }[], Iterable<{
+        base_symbol: string;
+        quote_symbol: string;
+        base_precision: number;
+        quote_precision: number;
+    }> & {
+        length: number;
+    }, string>;
+}, string>;
+type AssetPairsResponseStructOutput = BcsParsed<typeof AssetPairsResponseStruct>;
+declare const AssetPairsResponsePaginatedStruct: _mysten_bcs.BcsStruct<{
+    total_count: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+    next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
+    asset_pairs: _mysten_bcs.BcsType<{
+        base_symbol: string;
+        quote_symbol: string;
+        base_precision: number;
+        quote_precision: number;
+    }[], Iterable<{
+        base_symbol: string;
+        quote_symbol: string;
+        base_precision: number;
+        quote_precision: number;
+    }> & {
+        length: number;
+    }, string>;
+}, string>;
+type AssetPairsResponsePaginatedStructOutput = BcsParsed<typeof AssetPairsResponsePaginatedStruct>;
+declare const PriceDataStruct: _mysten_bcs.BcsStruct<{
+    price: _mysten_bcs.BcsType<string, string | number | bigint, "u128">;
+    expiry_time_ms: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    last_updated_ms: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    updater: _mysten_bcs.BcsType<string, string, "address">;
+}, string>;
+type PriceDataStructOutput = BcsParsed<typeof PriceDataStruct>;
+declare const PriceResponseStruct: _mysten_bcs.BcsStruct<{
+    pair_data: _mysten_bcs.BcsType<{
+        price: string;
+        expiry_time_ms: string;
+        last_updated_ms: string;
+        updater: string;
+    } | null, {
+        price: string | number | bigint;
+        expiry_time_ms: string | number | bigint;
+        last_updated_ms: string | number | bigint;
+        updater: string;
+    } | null | undefined, `Option<${string}>`>;
+}, string>;
+type PriceResponseStructOutput = BcsParsed<typeof PriceResponseStruct>;
+declare const PricesResponsePaginatedStruct: _mysten_bcs.BcsStruct<{
+    total_count: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+    next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
+    prices: _mysten_bcs.BcsType<{
+        price: string;
+        expiry_time_ms: string;
+        last_updated_ms: string;
+        updater: string;
+    }[], Iterable<{
+        price: string | number | bigint;
+        expiry_time_ms: string | number | bigint;
+        last_updated_ms: string | number | bigint;
+        updater: string;
+    }> & {
+        length: number;
+    }, string>;
+}, string>;
+type PricesResponsePaginatedStructOutput = BcsParsed<typeof PricesResponsePaginatedStruct>;
+
+declare const RouterConfigStruct: _mysten_bcs.BcsStruct<{
+    admin: _mysten_bcs.BcsType<string, string, "address">;
+    default_price_oracle_contract: _mysten_bcs.BcsType<string, string, "address">;
+    default_protocol_fee_recipient: _mysten_bcs.BcsType<string, string, "address">;
+    default_protocol_fee: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    default_lp_fee: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+}, string>;
+type RouterConfigStructOutput = BcsParsed<typeof RouterConfigStruct>;
+declare const MarketStruct: _mysten_bcs.BcsStruct<{
+    base_asset_symbol: _mysten_bcs.BcsType<string, string, "string">;
+    quote_assets_symbols: _mysten_bcs.BcsType<string[], Iterable<string> & {
+        length: number;
+    }, string>;
+    market_address: _mysten_bcs.BcsType<string, string, "string">;
+    is_permissioned: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+    created_at_ms: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+}, string>;
+type MarketStructOutput = BcsParsed<typeof MarketStruct>;
+declare const MarketResponseStruct: _mysten_bcs.BcsStruct<{
+    market: _mysten_bcs.BcsType<{
+        base_asset_symbol: string;
+        quote_assets_symbols: string[];
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string;
+    } | null, {
+        base_asset_symbol: string;
+        quote_assets_symbols: Iterable<string> & {
+            length: number;
+        };
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string | number | bigint;
+    } | null | undefined, `Option<${string}>`>;
+}, string>;
+type MarketResponseStructOutput = BcsParsed<typeof MarketResponseStruct>;
+declare const MarketsResponseStruct: _mysten_bcs.BcsStruct<{
+    markets: _mysten_bcs.BcsType<{
+        base_asset_symbol: string;
+        quote_assets_symbols: string[];
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string;
+    }[], Iterable<{
+        base_asset_symbol: string;
+        quote_assets_symbols: Iterable<string> & {
+            length: number;
+        };
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string | number | bigint;
+    }> & {
+        length: number;
+    }, string>;
+}, string>;
+type MarketsResponseStructOutput = BcsParsed<typeof MarketsResponseStruct>;
+declare const MarketsResponsePaginatedStruct: _mysten_bcs.BcsStruct<{
+    total_count: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+    next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
+    markets: _mysten_bcs.BcsType<{
+        base_asset_symbol: string;
+        quote_assets_symbols: string[];
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string;
+    }[], Iterable<{
+        base_asset_symbol: string;
+        quote_assets_symbols: Iterable<string> & {
+            length: number;
+        };
+        market_address: string;
+        is_permissioned: boolean;
+        created_at_ms: string | number | bigint;
+    }> & {
+        length: number;
+    }, string>;
+}, string>;
+type MarketsResponsePaginatedStructOutput = BcsParsed<typeof MarketsResponsePaginatedStruct>;
+declare const BaseLiquidityResponseStruct: _mysten_bcs.BcsStruct<{
+    total_count: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+    next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
+    base_assets: _mysten_bcs.BcsType<string[], Iterable<string> & {
+        length: number;
+    }, string>;
+}, string>;
+type BaseLiquidityResponseStructOutput = BcsParsed<typeof BaseLiquidityResponseStruct>;
+
+declare const GetPoolInfoResponseStruct: readonly [_mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u128">, _mysten_bcs.BcsType<string, string, "address">, _mysten_bcs.BcsType<boolean, boolean, "bool">];
+type GetPoolInfoResponseStructOutput = BcsParsedMultiple<typeof GetPoolInfoResponseStruct>;
+declare const GetFeesResponseStruct: readonly [_mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u64">];
+type GetFeesResponseStructOutput = BcsParsedMultiple<typeof GetFeesResponseStruct>;
+
+/**
+ * Client implementation for interacting with the Bolt Liquidity Outpost on Sui blockchain.
+ *
+ * This class extends the abstract {@link BaseClient} to provide Sui-specific functionality
+ * for querying and executing transactions on Bolt Protocol's oracle and router smart contracts.
+ * It uses SuiTransactionBlockResponse as the transaction output type, providing detailed transaction execution information.
+ *
+ * @extends {BaseClient<Signer, SuiTransactionBlockResponse>}
+ *
+ * @group Bolt API Clients
+ *
+ * @example
+ * ```typescript
+ * // Create a client for Sui mainnet
+ * const client = new BoltSuiClient();
+ *
+ * // Query oracle prices
+ * const price = await client.getPrice("0x2::sui::SUI", "0xusdcAddress...");
+ *
+ * // Execute a swap (requires signer)
+ * const signer = // ... get signer from wallet
+ * const result = await client.swap(signer, {
+ *   assetIn: "0x2::sui::SUI",
+ *   amountIn: "1000000000", // 1 SUI (9 decimals)
+ *   assetOut: "0xusdcAddress..."
+ * });
+ * ```
+ */
+declare class BoltSuiClient extends BaseClient<Signer, SuiTransactionBlockResponse> {
+    /**
+     * The Sui-specific chain configuration including RPC endpoint
+     */
+    chainConfig: SuiChainConfig;
+    /**
+     * Package Id for the deployed Bolt contracts on Sui
+     */
+    packageId: string;
+    /**
+     * Instance of the Sui client to interact with the blockchain
+     */
+    suiClient: SuiClient;
+    /**
+     * Creates a new instance of the BoltSuiClient.
+     *
+     * The client automatically configures itself based on the specified chain and environment,
+     * loading the appropriate contract addresses, chain configuration, and assets from configuration files.
+     *
+     * @param config - (Optional) Configuration for the client
+     * @param config.environment - (Optional) The deployment environment ('mainnet' or 'testnet'). Defaults to 'mainnet'
+     * @param config.customOverride - (Optional) Custom overrides for chain configuration, contracts, and assets
+     * @param config.customOverride.chainConfig - (Optional) Override chain configuration
+     * @param config.customOverride.chainConfig.id - (Optional) Custom chain ID
+     * @param config.customOverride.chainConfig.name - (Optional) Custom chain name
+     * @param config.customOverride.chainConfig.rpcEndpoint - (Optional) Custom RPC endpoint URL
+     * @param config.customOverride.packageId - (Optional) Custom package ID for Bolt contracts
+     * @param config.customOverride.contracts - (Optional) Override contract addresses
+     * @param config.customOverride.contracts.oracle - (Optional) Custom oracle contract address
+     * @param config.customOverride.contracts.router - (Optional) Custom router contract address
+     * @param config.customOverride.assetsConfig - (Optional) Custom asset configurations indexed by denom
+     * @param config.suiClient - (Optional) Pre-existing SuiClient to use for blockchain queries
+     *
+     * @throws {InvalidObjectError} Thrown when required configuration fields are missing
+     *
+     * @example
+     * ```typescript
+     * // Use default configuration (Sui mainnet)
+     * const client = new BoltSuiClient();
+     *
+     * // Use testnet configuration
+     * const testnetClient = new BoltSuiClient({
+     *   environment: 'testnet'
+     * });
+     *
+     * // Use custom chain configuration
+     * const customClient = new BoltSuiClient({
+     *   customOverride: {
+     *     chainConfig: {
+     *       id: 'sui-custom',
+     *       name: 'Sui Custom',
+     *       rpcEndpoint: 'https://custom-rpc.example.com'
+     *     },
+     *     packageId: '0xcustom_package_id...',
+     *     contracts: {
+     *       oracle: '0xcustom_oracle...',
+     *       router: '0xcustom_router...'
+     *     },
+     *     assetsConfig: {
+     *       '0x2::sui::SUI': {
+     *         symbol: 'SUI',
+     *         name: 'Sui',
+     *         chainId: 'sui-custom',
+     *         denom: '0x2::sui::SUI',
+     *         decimals: 9,
+     *         logo: 'https://example.com/sui.png',
+     *         coingeckoId: 'sui'
+     *       }
+     *     }
+     *   }
+     * });
+     *
+     * // Use pre-existing Sui client
+     * const clientWithCustomClient = new BoltSuiClient({
+     *   suiClient: mySuiClient
+     * });
+     * ```
+     */
+    constructor(config?: SuiClientConfig);
+    /** @inheritdoc */
+    getOracleConfig(): Promise<OracleConfig>;
+    /** @inheritdoc */
+    getAllOracleAssetPairs(): Promise<OracleAssetPair[]>;
+    /** @inheritdoc */
+    getPrice(baseDenom: string, quoteDenom: string): Promise<InvertiblePrice>;
+    /** @inheritdoc */
+    getAllPrices(): Promise<Price[]>;
+    /** @inheritdoc */
+    getRouterConfig(): Promise<RouterConfig>;
+    /** @inheritdoc */
+    getAllBaseAssetsLiquidity(): Promise<Record<Address, BaseLiquidityDetails>>;
+    /** @inheritdoc */
+    getAllQuotesByUser(address: Address): Promise<Record<Address, Coin[]>>;
+    /** @inheritdoc */
+    getPoolByBaseAsset(baseDenom: string): Promise<Pool>;
+    /** @inheritdoc */
+    getAllPools(): Promise<Pool[]>;
+    getPoolConfig(poolContractAddress: string): Promise<PoolConfig>;
+    /** @inheritdoc */
+    getAssets(): Promise<Asset[]>;
+    /** @inheritdoc */
+    getPoolConfigByBaseAsset(baseDenom: string): Promise<PoolConfig>;
+    /**
+     * @inheritdoc
+     *
+     * @example
+     * ```typescript
+     * // Get signer from wallet (e.g., Sui Wallet, Suiet, etc.)
+     * const signer = // ... obtain signer from wallet
+     *
+     * // Execute swap: 1 SUI for USDC
+     * const result = await client.swap(signer, {
+     *   assetIn: "0x2::sui::SUI",
+     *   amountIn: "1000000000", // 1 SUI (9 decimals)
+     *   assetOut: "0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN", // USDC address
+     *   minimumAmountOut: "1950000", // Minimum 1.95 USDC expected (6 decimals)
+     *   receiver: "0x..." // Optional custom receiver address
+     * });
+     *
+     * console.log(`Swap successful!`);
+     * console.log(`Transaction digest: ${result.txHash}`);
+     * console.log(`Received: ${result.amountOut} ${result.assetOut}`);
+     * console.log(`Gas cost: ${result.txOutput.effects.gasUsed.computationCost}`);
+     * console.log(`Status: ${result.txOutput.effects.status.status}`);
+     * ```
+     *
+     * @remarks
+     * This implementation returns a SuiTransactionBlockResponse as the transaction output,
+     * which includes details like gas costs, transaction effects, object changes, and events.
+     */
+    swap(signer: Signer, params: SwapParams): Promise<SwapResult<SuiTransactionBlockResponse>>;
+}
+
+export { AssetPairStruct, type AssetPairStructOutput, AssetPairsResponsePaginatedStruct, type AssetPairsResponsePaginatedStructOutput, AssetPairsResponseStruct, type AssetPairsResponseStructOutput, BaseLiquidityResponseStruct, type BaseLiquidityResponseStructOutput, BcsAddressType, type BcsParsed, type BcsParsedMultiple, BoltSuiClient, GetFeesResponseStruct, type GetFeesResponseStructOutput, GetPoolInfoResponseStruct, type GetPoolInfoResponseStructOutput, MarketResponseStruct, type MarketResponseStructOutput, MarketStruct, type MarketStructOutput, MarketsResponsePaginatedStruct, type MarketsResponsePaginatedStructOutput, MarketsResponseStruct, type MarketsResponseStructOutput, OracleConfigStruct, type OracleConfigStructOutput, PaginationStruct, PriceDataStruct, type PriceDataStructOutput, PriceResponseStruct, type PriceResponseStructOutput, PricesResponsePaginatedStruct, type PricesResponsePaginatedStructOutput, RouterConfigStruct, type RouterConfigStructOutput, type SuiChainConfig, type SuiClientConfig };