@rabby-wallet/rabby-api 0.6.14-alpha.0 → 0.6.15-alpha.0

package/README.md

@@ -1,25 +1,25 @@
-# rabby-api
-
-## Install
-
-```bash
-npm install rabby-api @debank/common
-```
-
-## Usage
-
-```ts
-import { OpenApiService } from 'rabby-api';
-
-const service = new OpenApiService({
-  store: {
-    host: 'https://api.rabby.io'
-  }
-});
-
-// init service
-await service.init();
-
-// call api
-await service.getTotalBalance('0x1234');
-```
+# rabby-api
+
+## Install
+
+```bash
+npm install rabby-api @debank/common
+```
+
+## Usage
+
+```ts
+import { OpenApiService } from 'rabby-api';
+
+const service = new OpenApiService({
+  store: {
+    host: 'https://api.rabby.io'
+  }
+});
+
+// init service
+await service.init();
+
+// call api
+await service.getTotalBalance('0x1234');
+```

package/dist/index.d.ts

@@ -1,278 +1,282 @@
-import { AxiosAdapter } from 'axios';
-import { RateLimitedAxiosInstance } from 'axios-rate-limit';
-import { ServerChain, TotalBalanceResponse, ChainWithPendingCount, SecurityCheckResponse, Tx, ExplainTxResponse, GasLevel, GetTxResponse, TokenItem, AssetItem, NFTItem, Collection, TxHistoryResult, TokenApproval, NFTApprovalResponse, ApprovalStatus, UsedChain, Protocol, ComplexProtocol, ExplainTypedDataResponse, SwapTradeList, SlippageStatus, CEXQuote, Summary, Cex, ContractCredit, AddrDescResponse, ParseTxResponse, CollectionWithFloorPrice, ParseTypedDataResponse, ParseTextResponse, CollectionList } from './types';
-interface OpenApiStore {
-    host: string;
-}
-interface Options {
-    store: OpenApiStore;
-    adapter?: AxiosAdapter;
-}
-export declare class OpenApiService {
-    store: OpenApiStore;
-    request: RateLimitedAxiosInstance;
-    setHost: (host: string) => Promise<void>;
-    getHost: () => string;
-    ethRpc: ((chainId: string, arg: {
-        method: string;
-        params: Array<any>;
-        origin?: string;
-    }) => Promise<any>) | (() => Promise<never>);
-    adapter?: AxiosAdapter;
-    constructor({ store, adapter }: Options);
-    init: (hf?: string) => Promise<void>;
-    private _mountMethods;
-    getRecommendChains: (address: string, origin: string) => Promise<ServerChain[]>;
-    getTotalBalance: (address: string) => Promise<TotalBalanceResponse>;
-    getPendingCount: (address: string) => Promise<{
-        total_count: number;
-        chains: ChainWithPendingCount[];
-    }>;
-    checkOrigin: (address: string, origin: string) => Promise<SecurityCheckResponse>;
-    checkText: (address: string, origin: string, text: string) => Promise<SecurityCheckResponse>;
-    checkTx: (tx: Tx, origin: string, address: string, update_nonce?: boolean) => Promise<SecurityCheckResponse>;
-    preExecTx: ({ tx, origin, address, updateNonce, pending_tx_list, }: {
-        tx: Tx;
-        origin: string;
-        address: string;
-        updateNonce: boolean;
-        pending_tx_list: Tx[];
-    }) => Promise<ExplainTxResponse>;
-    historyGasUsed: (params: {
-        tx: Tx;
-        user_addr: string;
-    }) => Promise<{
-        gas_used: number;
-    }>;
-    pendingTxList: (tx: Tx, origin: string, address: string, update_nonce?: boolean) => Promise<Tx[]>;
-    traceTx: (txId: string, traceId: string, chainId: string) => Promise<void>;
-    pushTx: (tx: Tx, traceId?: string) => Promise<any>;
-    explainText: (origin: string, address: string, text: string) => Promise<{
-        comment: string;
-    }>;
-    gasMarket: (chainId: string, customGas?: number) => Promise<GasLevel[]>;
-    getTx: (chainId: string, hash: string, gasPrice: number) => Promise<GetTxResponse>;
-    getEnsAddressByName: (name: string) => Promise<{
-        addr: string;
-        name: string;
-    }>;
-    searchToken: (id: string, q: string, chainId?: string, is_all?: boolean) => Promise<TokenItem[]>;
-    searchSwapToken: (id: string, chainId: string, q: string, is_all?: boolean) => Promise<any>;
-    getToken: (id: string, chainId: string, tokenId: string) => Promise<TokenItem>;
-    getCachedTokenList: (id: string) => Promise<TokenItem[]>;
-    listToken: (id: string, chainId?: string, isAll?: boolean) => Promise<TokenItem[]>;
-    getHistoryTokenList: (params: {
-        id: string;
-        chainId?: string;
-        timeAt?: number;
-        dateAt?: string;
-    }) => Promise<TokenItem[]>;
-    customListToken: (uuids: string[], id: string) => Promise<TokenItem[]>;
-    listChainAssets: (id: string) => Promise<AssetItem[]>;
-    listNFT: (id: string, isAll?: boolean) => Promise<NFTItem[]>;
-    listCollection: (params: {
-        collection_ids: string;
-    }) => Promise<Collection[]>;
-    listTxHisotry: (params: {
-        id?: string;
-        chain_id?: string;
-        token_id?: string;
-        coin_id?: string;
-        start_time?: number;
-        page_count?: number;
-    }) => Promise<TxHistoryResult>;
-    tokenPrice: (tokenName: string) => Promise<{
-        change_percent: number;
-        last_price: number;
-    }>;
-    tokenAuthorizedList: (id: string, chain_id: string) => Promise<TokenApproval[]>;
-    userNFTAuthorizedList: (id: string, chain_id: string) => Promise<NFTApprovalResponse>;
-    getDEXList: (chain_id: string) => Promise<{
-        id: string;
-        name: string;
-        logo_url: string;
-        site_url: string;
-        type: string;
-    }[]>;
-    getSwapQuote: (params: {
-        id: string;
-        chain_id: string;
-        dex_id: string;
-        pay_token_id: string;
-        pay_token_raw_amount: string;
-        receive_token_id: string;
-    }) => Promise<{
-        receive_token_raw_amount: number;
-        dex_approve_to: string;
-        dex_swap_to: string;
-        dex_swap_calldata: string;
-        is_wrapped: boolean;
-        gas: {
-            gas_used: number;
-            gas_price: number;
-            gas_cost_value: number;
-            gas_cost_usd_value: number;
-        };
-        pay_token: TokenItem;
-        receive_token: TokenItem;
-    }>;
-    getSwapTokenList: (id: string, chainId?: string) => Promise<TokenItem[]>;
-    postGasStationOrder: (params: {
-        userAddr: string;
-        fromChainId: string;
-        fromTxId: string;
-        toChainId: string;
-        toTokenAmount: string;
-        fromTokenId: string;
-        fromTokenAmount: string;
-        fromUsdValue: number;
-    }) => Promise<any>;
-    getGasStationChainBalance: (chain_id: string, addr: string) => Promise<{
-        usd_value: number;
-    }>;
-    getGasStationTokenList: () => Promise<TokenItem[]>;
-    explainTypedData: (user_addr: string, origin: string, data: any) => Promise<ExplainTypedDataResponse>;
-    checkTypedData: (user_addr: string, origin: string, data: any) => Promise<SecurityCheckResponse>;
-    approvalStatus: (id: string) => Promise<ApprovalStatus[]>;
-    usedChainList: (id: string) => Promise<UsedChain[]>;
-    getLatestVersion: () => Promise<{
-        version_tag: string;
-    }>;
-    addOriginFeedback: (params: {
-        user_addr: string;
-        origin: string;
-        is_safe: boolean;
-    }) => Promise<{
-        is_success: boolean;
-    }>;
-    getProtocolList: (addr: string) => Promise<Protocol[]>;
-    getComplexProtocolList: (addr: string) => Promise<ComplexProtocol[]>;
-    getProtocol: ({ addr, id, }: {
-        addr: string;
-        id: string;
-    }) => Promise<ComplexProtocol>;
-    getHistoryProtocol: ({ addr, id, timeAt, dateAt, }: {
-        addr: string;
-        id: string;
-        timeAt?: number | undefined;
-        dateAt?: number | undefined;
-    }) => Promise<ComplexProtocol>;
-    getTokenHistoryPrice: ({ chainId, id, timeAt, }: {
-        chainId: string;
-        id: string;
-        timeAt: number;
-    }) => Promise<{
-        price: number;
-    }>;
-    getTokenHistoryDict: ({ chainId, ids, timeAt, }: {
-        chainId: string;
-        ids: string;
-        timeAt: number;
-    }) => Promise<Record<string, number>>;
-    getNetCurve: (addr: string) => Promise<{
-        timestamp: number;
-        usd_value: number;
-    }[]>;
-    getChainList: () => Promise<ServerChain[]>;
-    getCEXSwapQuote: (params: {
-        cex_id: string;
-        pay_token_id: string;
-        pay_token_amount: string;
-        receive_token_id: string;
-        chain_id: string;
-    }) => Promise<CEXQuote>;
-    getSwapTradeList: (params: {
-        user_addr: string;
-        start: string;
-        limit: string;
-    }) => Promise<SwapTradeList>;
-    postSwap: (params: {
-        quote: {
-            pay_token_id: string;
-            pay_token_amount: number;
-            receive_token_id: string;
-            receive_token_amount: number;
-            slippage: number;
-        };
-        dex_id: string;
-        tx_id: string;
-        tx: Tx;
-    }) => Promise<any>;
-    checkSlippage: (params: {
-        chain_id: string;
-        slippage: string;
-        from_token_id: string;
-        to_token_id: string;
-    }) => Promise<SlippageStatus>;
-    getOriginPopularityLevel: (origin: string) => Promise<{
-        level: 'very_low' | 'low' | 'medium' | 'high';
-    }>;
-    getOriginIsScam: (origin: string, source: string) => Promise<{
-        is_scam: boolean;
-    }>;
-    getOriginThirdPartyCollectList: (origin: string) => Promise<{
-        collect_list: {
-            name: string;
-            logo_url: string;
-        }[];
-    }>;
-    getSummarizedAssetList: (id: string, chain_id?: string) => Promise<Summary>;
-    parseTx: ({ chainId, tx, origin, addr, }: {
-        chainId: string;
-        tx: Tx;
-        origin: string;
-        addr: string;
-    }) => Promise<ParseTxResponse>;
-    isSuspiciousToken: (id: string, chainId: string) => Promise<{
-        is_suspicious: boolean;
-    }>;
-    depositCexSupport: (id: string, chainId: string, cexId: string) => Promise<{
-        support: boolean;
-    }>;
-    depositCexList: (id: string, chainId: string) => Promise<{
-        cex_list: Cex[];
-    }>;
-    getContractCredit: (id: string, chainId: string) => Promise<ContractCredit>;
-    hasInteraction: (addr: string, chainId: string, contractId: string) => Promise<{
-        has_interaction: boolean;
-    }>;
-    tokenApproveExposure: (id: string, chainId: string) => Promise<{
-        usd_value: number;
-    }>;
-    addrDesc: (id: string) => Promise<AddrDescResponse>;
-    hasTransfer: (chainId: string, from: string, to: string) => Promise<{
-        has_transfer: boolean;
-    }>;
-    isTokenContract: (chainId: string, id: string) => Promise<{
-        is_token: boolean;
-    }>;
-    addrUsedChainList: (id: string) => Promise<UsedChain[]>;
-    getTokenNFTExposure: (chainId: string, id: string) => Promise<{
-        usd_value: number;
-    }>;
-    getCollection: (chainId: string, id: string) => Promise<{
-        collection: CollectionWithFloorPrice;
-    }>;
-    isSuspiciousCollection: (chainId: string, id: string) => Promise<{
-        is_suspicious: boolean;
-    }>;
-    isOriginVerified: (origin: string) => Promise<{
-        is_verified: boolean | null;
-    }>;
-    parseTypedData: ({ typedData, origin, address, }: {
-        typedData: Record<string, any>;
-        origin: string;
-        address: string;
-    }) => Promise<ParseTypedDataResponse>;
-    parseText: ({ text, origin, address, }: {
-        text: string;
-        origin: string;
-        address: string;
-    }) => Promise<ParseTextResponse>;
-    collectionList: ({ id, chainId, isAll, }: {
-        id: string;
-        chainId?: string | undefined;
-        isAll: boolean;
-    }) => Promise<CollectionList[]>;
-}
-export {};
+import { AxiosAdapter } from 'axios';
+import { RateLimitedAxiosInstance } from 'axios-rate-limit';
+import { ServerChain, TotalBalanceResponse, ChainWithPendingCount, SecurityCheckResponse, Tx, ExplainTxResponse, GasLevel, GetTxResponse, TokenItem, AssetItem, NFTItem, Collection, TxHistoryResult, TokenApproval, NFTApprovalResponse, ApprovalStatus, UsedChain, Protocol, ComplexProtocol, ExplainTypedDataResponse, SwapTradeList, SlippageStatus, CEXQuote, Summary, Cex, ContractCredit, AddrDescResponse, ParseTxResponse, CollectionWithFloorPrice, ParseTypedDataResponse, ParseTextResponse, CollectionList } from './types';
+interface OpenApiStore {
+    host: string;
+    testnetHost?: string;
+}
+interface Options {
+    store: OpenApiStore;
+    adapter?: AxiosAdapter;
+}
+export declare class OpenApiService {
+    store: OpenApiStore;
+    request: RateLimitedAxiosInstance;
+    setHost: (host: string) => Promise<void>;
+    getHost: () => string;
+    setTestnetHost: (host: string) => Promise<void>;
+    getTestnetHost: () => string | undefined;
+    ethRpc: ((chainId: string, arg: {
+        method: string;
+        params: Array<any>;
+        origin?: string;
+    }) => Promise<any>) | (() => Promise<never>);
+    adapter?: AxiosAdapter;
+    constructor({ store, adapter }: Options);
+    init: (hf?: string) => Promise<void>;
+    private _getRequestOptions;
+    private _mountMethods;
+    getRecommendChains: (address: string, origin: string) => Promise<ServerChain[]>;
+    getTotalBalance: (address: string) => Promise<TotalBalanceResponse>;
+    getPendingCount: (address: string) => Promise<{
+        total_count: number;
+        chains: ChainWithPendingCount[];
+    }>;
+    checkOrigin: (address: string, origin: string) => Promise<SecurityCheckResponse>;
+    checkText: (address: string, origin: string, text: string) => Promise<SecurityCheckResponse>;
+    checkTx: (tx: Tx, origin: string, address: string, update_nonce?: boolean) => Promise<SecurityCheckResponse>;
+    preExecTx: ({ tx, origin, address, updateNonce, pending_tx_list, }: {
+        tx: Tx;
+        origin: string;
+        address: string;
+        updateNonce: boolean;
+        pending_tx_list: Tx[];
+    }) => Promise<ExplainTxResponse>;
+    historyGasUsed: (params: {
+        tx: Tx;
+        user_addr: string;
+    }) => Promise<{
+        gas_used: number;
+    }>;
+    pendingTxList: (tx: Tx, origin: string, address: string, update_nonce?: boolean) => Promise<Tx[]>;
+    traceTx: (txId: string, traceId: string, chainId: string) => Promise<void>;
+    pushTx: (tx: Tx, traceId?: string) => Promise<any>;
+    explainText: (origin: string, address: string, text: string) => Promise<{
+        comment: string;
+    }>;
+    gasMarket: (chainId: string, customGas?: number) => Promise<GasLevel[]>;
+    getTx: (chainId: string, hash: string, gasPrice: number) => Promise<GetTxResponse>;
+    getEnsAddressByName: (name: string) => Promise<{
+        addr: string;
+        name: string;
+    }>;
+    searchToken: (id: string, q: string, chainId?: string, is_all?: boolean) => Promise<TokenItem[]>;
+    searchSwapToken: (id: string, chainId: string, q: string, is_all?: boolean) => Promise<any>;
+    getToken: (id: string, chainId: string, tokenId: string) => Promise<TokenItem>;
+    getCachedTokenList: (id: string) => Promise<TokenItem[]>;
+    listToken: (id: string, chainId?: string, isAll?: boolean) => Promise<TokenItem[]>;
+    getHistoryTokenList: (params: {
+        id: string;
+        chainId?: string;
+        timeAt?: number;
+        dateAt?: string;
+    }) => Promise<TokenItem[]>;
+    customListToken: (uuids: string[], id: string) => Promise<TokenItem[]>;
+    listChainAssets: (id: string) => Promise<AssetItem[]>;
+    listNFT: (id: string, isAll?: boolean) => Promise<NFTItem[]>;
+    listCollection: (params: {
+        collection_ids: string;
+    }) => Promise<Collection[]>;
+    listTxHisotry: (params: {
+        id?: string;
+        chain_id?: string;
+        token_id?: string;
+        coin_id?: string;
+        start_time?: number;
+        page_count?: number;
+    }) => Promise<TxHistoryResult>;
+    tokenPrice: (tokenName: string) => Promise<{
+        change_percent: number;
+        last_price: number;
+    }>;
+    tokenAuthorizedList: (id: string, chain_id: string) => Promise<TokenApproval[]>;
+    userNFTAuthorizedList: (id: string, chain_id: string) => Promise<NFTApprovalResponse>;
+    getDEXList: (chain_id: string) => Promise<{
+        id: string;
+        name: string;
+        logo_url: string;
+        site_url: string;
+        type: string;
+    }[]>;
+    getSwapQuote: (params: {
+        id: string;
+        chain_id: string;
+        dex_id: string;
+        pay_token_id: string;
+        pay_token_raw_amount: string;
+        receive_token_id: string;
+    }) => Promise<{
+        receive_token_raw_amount: number;
+        dex_approve_to: string;
+        dex_swap_to: string;
+        dex_swap_calldata: string;
+        is_wrapped: boolean;
+        gas: {
+            gas_used: number;
+            gas_price: number;
+            gas_cost_value: number;
+            gas_cost_usd_value: number;
+        };
+        pay_token: TokenItem;
+        receive_token: TokenItem;
+    }>;
+    getSwapTokenList: (id: string, chainId?: string) => Promise<TokenItem[]>;
+    postGasStationOrder: (params: {
+        userAddr: string;
+        fromChainId: string;
+        fromTxId: string;
+        toChainId: string;
+        toTokenAmount: string;
+        fromTokenId: string;
+        fromTokenAmount: string;
+        fromUsdValue: number;
+    }) => Promise<any>;
+    getGasStationChainBalance: (chain_id: string, addr: string) => Promise<{
+        usd_value: number;
+    }>;
+    getGasStationTokenList: () => Promise<TokenItem[]>;
+    explainTypedData: (user_addr: string, origin: string, data: any) => Promise<ExplainTypedDataResponse>;
+    checkTypedData: (user_addr: string, origin: string, data: any) => Promise<SecurityCheckResponse>;
+    approvalStatus: (id: string) => Promise<ApprovalStatus[]>;
+    usedChainList: (id: string) => Promise<UsedChain[]>;
+    getLatestVersion: () => Promise<{
+        version_tag: string;
+    }>;
+    addOriginFeedback: (params: {
+        user_addr: string;
+        origin: string;
+        is_safe: boolean;
+    }) => Promise<{
+        is_success: boolean;
+    }>;
+    getProtocolList: (addr: string) => Promise<Protocol[]>;
+    getComplexProtocolList: (addr: string) => Promise<ComplexProtocol[]>;
+    getProtocol: ({ addr, id, }: {
+        addr: string;
+        id: string;
+    }) => Promise<ComplexProtocol>;
+    getHistoryProtocol: ({ addr, id, timeAt, dateAt, }: {
+        addr: string;
+        id: string;
+        timeAt?: number | undefined;
+        dateAt?: number | undefined;
+    }) => Promise<ComplexProtocol>;
+    getTokenHistoryPrice: ({ chainId, id, timeAt, }: {
+        chainId: string;
+        id: string;
+        timeAt: number;
+    }) => Promise<{
+        price: number;
+    }>;
+    getTokenHistoryDict: ({ chainId, ids, timeAt, }: {
+        chainId: string;
+        ids: string;
+        timeAt: number;
+    }) => Promise<Record<string, number>>;
+    getNetCurve: (addr: string) => Promise<{
+        timestamp: number;
+        usd_value: number;
+    }[]>;
+    getChainList: () => Promise<ServerChain[]>;
+    getCEXSwapQuote: (params: {
+        cex_id: string;
+        pay_token_id: string;
+        pay_token_amount: string;
+        receive_token_id: string;
+        chain_id: string;
+    }) => Promise<CEXQuote>;
+    getSwapTradeList: (params: {
+        user_addr: string;
+        start: string;
+        limit: string;
+    }) => Promise<SwapTradeList>;
+    postSwap: (params: {
+        quote: {
+            pay_token_id: string;
+            pay_token_amount: number;
+            receive_token_id: string;
+            receive_token_amount: number;
+            slippage: number;
+        };
+        dex_id: string;
+        tx_id: string;
+        tx: Tx;
+    }) => Promise<any>;
+    checkSlippage: (params: {
+        chain_id: string;
+        slippage: string;
+        from_token_id: string;
+        to_token_id: string;
+    }) => Promise<SlippageStatus>;
+    getOriginPopularityLevel: (origin: string) => Promise<{
+        level: 'very_low' | 'low' | 'medium' | 'high';
+    }>;
+    getOriginIsScam: (origin: string, source: string) => Promise<{
+        is_scam: boolean;
+    }>;
+    getOriginThirdPartyCollectList: (origin: string) => Promise<{
+        collect_list: {
+            name: string;
+            logo_url: string;
+        }[];
+    }>;
+    getSummarizedAssetList: (id: string, chain_id?: string) => Promise<Summary>;
+    parseTx: ({ chainId, tx, origin, addr, }: {
+        chainId: string;
+        tx: Tx;
+        origin: string;
+        addr: string;
+    }) => Promise<ParseTxResponse>;
+    isSuspiciousToken: (id: string, chainId: string) => Promise<{
+        is_suspicious: boolean;
+    }>;
+    depositCexSupport: (id: string, chainId: string, cexId: string) => Promise<{
+        support: boolean;
+    }>;
+    depositCexList: (id: string, chainId: string) => Promise<{
+        cex_list: Cex[];
+    }>;
+    getContractCredit: (id: string, chainId: string) => Promise<ContractCredit>;
+    hasInteraction: (addr: string, chainId: string, contractId: string) => Promise<{
+        has_interaction: boolean;
+    }>;
+    tokenApproveExposure: (id: string, chainId: string) => Promise<{
+        usd_value: number;
+    }>;
+    addrDesc: (id: string) => Promise<AddrDescResponse>;
+    hasTransfer: (chainId: string, from: string, to: string) => Promise<{
+        has_transfer: boolean;
+    }>;
+    isTokenContract: (chainId: string, id: string) => Promise<{
+        is_token: boolean;
+    }>;
+    addrUsedChainList: (id: string) => Promise<UsedChain[]>;
+    getTokenNFTExposure: (chainId: string, id: string) => Promise<{
+        usd_value: number;
+    }>;
+    getCollection: (chainId: string, id: string) => Promise<{
+        collection: CollectionWithFloorPrice;
+    }>;
+    isSuspiciousCollection: (chainId: string, id: string) => Promise<{
+        is_suspicious: boolean;
+    }>;
+    isOriginVerified: (origin: string) => Promise<{
+        is_verified: boolean | null;
+    }>;
+    parseTypedData: ({ typedData, origin, address, }: {
+        typedData: Record<string, any>;
+        origin: string;
+        address: string;
+    }) => Promise<ParseTypedDataResponse>;
+    parseText: ({ text, origin, address, }: {
+        text: string;
+        origin: string;
+        address: string;
+    }) => Promise<ParseTextResponse>;
+    collectionList: ({ id, chainId, isAll, }: {
+        id: string;
+        chainId?: string | undefined;
+        isAll: boolean;
+    }) => Promise<CollectionList[]>;
+}
+export {};