carbon-js-sdk 0.2.7-beta.1 → 0.2.7-beta.2

package/lib/CarbonSDK.d.ts

@@ -0,0 +1,103 @@
+/// <reference types="node" />
+import { Network, Network as _Network, NetworkConfig } from "./constant";
+import { OfflineDirectSigner, OfflineSigner } from "@cosmjs/proto-signing";
+import { Tendermint34Client } from "@cosmjs/tendermint-rpc";
+import { CarbonQueryClient, ETHClient, HydrogenClient, InsightsQueryClient, NEOClient, TokenClient, ZILClient } from "./clients";
+import N3Client from "./clients/N3Client";
+import { AdminModule, BankModule, BrokerModule, CDPModule, CoinModule, FeeModule, GovModule, IBCModule, LeverageModule, LiquidityPoolModule, MarketModule, OracleModule, OrderModule, PositionModule, ProfileModule, SubAccountModule, XChainModule } from "./modules";
+import { StakingModule } from "./modules/staking";
+import { CosmosLedger, Keplr } from "./provider";
+import { CarbonSigner, CarbonWallet, CarbonWalletGenericOpts } from "./wallet";
+export { CarbonTx } from "./util";
+export { CarbonSigner, CarbonSignerTypes, CarbonWallet, CarbonWalletGenericOpts, CarbonWalletInitOpts } from "./wallet";
+export interface CarbonSDKOpts {
+    network: Network;
+    tmClient: Tendermint34Client;
+    token?: TokenClient;
+    config?: Partial<NetworkConfig>;
+    defaultTimeoutBlocks?: number;
+}
+export interface CarbonSDKInitOpts {
+    network: Network;
+    tmClient?: Tendermint34Client;
+    config?: Partial<NetworkConfig>;
+    wallet?: CarbonWallet;
+    skipInit?: boolean;
+    defaultTimeoutBlocks?: number;
+}
+/**
+ * Carbon SDK
+ *
+ *
+ */
+declare class CarbonSDK {
+    static DEFAULT_NETWORK: Network;
+    static TokenClient: typeof TokenClient;
+    readonly query: CarbonQueryClient;
+    insights: InsightsQueryClient;
+    hydrogen: HydrogenClient;
+    wallet?: CarbonWallet;
+    network: Network;
+    configOverride: Partial<NetworkConfig>;
+    networkConfig: NetworkConfig;
+    tmClient: Tendermint34Client;
+    token: TokenClient;
+    admin: AdminModule;
+    order: OrderModule;
+    lp: LiquidityPoolModule;
+    subaccount: SubAccountModule;
+    profile: ProfileModule;
+    cdp: CDPModule;
+    leverage: LeverageModule;
+    market: MarketModule;
+    broker: BrokerModule;
+    position: PositionModule;
+    coin: CoinModule;
+    oracle: OracleModule;
+    gov: GovModule;
+    staking: StakingModule;
+    bank: BankModule;
+    fee: FeeModule;
+    ibc: IBCModule;
+    xchain: XChainModule;
+    neo: NEOClient;
+    eth: ETHClient;
+    bsc: ETHClient;
+    zil: ZILClient;
+    n3: N3Client;
+    constructor(opts: CarbonSDKOpts);
+    static instance(opts?: CarbonSDKInitOpts): Promise<CarbonSDK>;
+    static instanceWithWallet(wallet: CarbonWallet, sdkOpts?: CarbonSDKInitOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithPrivateKey(privateKey: string | Buffer, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithMnemonic(mnemonic: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithSigner(signer: CarbonSigner, publicKeyBase64: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts, customSigner?: OfflineSigner & OfflineDirectSigner): Promise<ConnectedCarbonSDK>;
+    static instanceWithLedger(ledger: CosmosLedger, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithKeplr(keplr: Keplr, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceViewOnly(bech32Address: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    initialize(): Promise<CarbonSDK>;
+    clone(): CarbonSDK;
+    generateOpts(): CarbonSDKOpts;
+    connect(wallet: CarbonWallet): Promise<ConnectedCarbonSDK>;
+    disconnect(): CarbonSDK;
+    connectWithPrivateKey(privateKey: string | Buffer, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithMnemonic(mnemonic: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithSigner(signer: CarbonSigner, publicKeyBase64: string, opts?: CarbonWalletGenericOpts, customSigner?: OfflineSigner & OfflineDirectSigner): Promise<ConnectedCarbonSDK>;
+    connectWithLedger(ledger: CosmosLedger, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithKeplr(keplr: Keplr, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectViewOnly(bech32Address: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    getConfig(): NetworkConfig;
+    getTokenClient(): TokenClient;
+    getConnectedWallet(): CarbonWallet;
+    log(...args: any[]): void;
+    private checkWallet;
+    static parseNetwork: (network: string, defaultNetwork?: Network | null) => Network | null;
+}
+export declare class ConnectedCarbonSDK extends CarbonSDK {
+    wallet: CarbonWallet;
+    constructor(wallet: CarbonWallet, opts: CarbonSDKOpts);
+    clone(): ConnectedCarbonSDK;
+}
+declare namespace CarbonSDK {
+    export import Network = _Network;
+}
+export default CarbonSDK;

package/lib/clients/BlockchainClient.d.ts

@@ -0,0 +1,16 @@
+import { StargateClient } from "@cosmjs/stargate";
+import { Tendermint34Client } from "@cosmjs/tendermint-rpc";
+/**
+ * BlockchainClient is functionally the same with StargateClient,
+ * with an additional static initializer:
+ *
+ * ```
+ * BlockchainClient.connectWithTm(tmClient: Tendermint34Client)
+ * ```
+ *
+ * @see StargateClient
+ */
+declare class BlockchainClient extends StargateClient {
+    static connectWithTm(tmClient: Tendermint34Client): BlockchainClient;
+}
+export default BlockchainClient;

package/lib/clients/CarbonQueryClient.d.ts

@@ -0,0 +1,80 @@
+import { QueryClientImpl as ADLQueryClient } from "../codec/adl/query";
+import { QueryClientImpl as BookQueryClient } from "../codec/book/query";
+import { QueryClientImpl as BrokerQueryClient } from "../codec/broker/query";
+import { QueryClientImpl as CDPQueryClient } from "../codec/cdp/query";
+import { QueryClientImpl as CoinQueryClient } from "../codec/coin/query";
+import { QueryClientImpl as AuthQueryClient } from "../codec/cosmos/auth/v1beta1/query";
+import { QueryClientImpl as BankQueryClient } from "../codec/cosmos/bank/v1beta1/query";
+import { QueryClientImpl as DistributionQueryClient } from "../codec/cosmos/distribution/v1beta1/query";
+import { QueryClientImpl as EvidenceQueryClient } from "../codec/cosmos/evidence/v1beta1/query";
+import { QueryClientImpl as GovQueryClient } from "../codec/cosmos/gov/v1beta1/query";
+import { QueryClientImpl as MintQueryClient } from "../codec/cosmos/mint/v1beta1/query";
+import { QueryClientImpl as ParamsQueryClient } from "../codec/cosmos/params/v1beta1/query";
+import { QueryClientImpl as SlashingQueryClient } from "../codec/cosmos/slashing/v1beta1/query";
+import { QueryClientImpl as StakingQueryClient } from "../codec/cosmos/staking/v1beta1/query";
+import { QueryClientImpl as UpgradeQueryClient } from "../codec/cosmos/upgrade/v1beta1/query";
+import { QueryClientImpl as IBCInterchainControlQueryClient } from "../codec/ibc/applications/interchain_accounts/controller/v1/query";
+import { QueryClientImpl as IBCInterchainHostQueryClient } from "../codec/ibc/applications/interchain_accounts/host/v1/query";
+import { QueryClientImpl as IBCTransferQueryClient } from "../codec/ibc/applications/transfer/v1/query";
+import { QueryClientImpl as FeeQueryClient } from "../codec/fee/query";
+import { QueryClientImpl as InflationQueryClient } from "../codec/inflation/query";
+import { QueryClientImpl as InsuranceQueryClient } from "../codec/insurance/query";
+import { QueryClientImpl as LeverageQueryClient } from "../codec/leverage/query";
+import { QueryClientImpl as LiquidationQueryClient } from "../codec/liquidation/query";
+import { QueryClientImpl as LiquidityPoolQueryClient } from "../codec/liquiditypool/query";
+import { QueryClientImpl as MarketQueryClient } from "../codec/market/query";
+import { QueryClientImpl as MarketStatsQueryClient } from "../codec/marketstats/query";
+import { QueryClientImpl as MiscQueryClient } from "../codec/misc/query";
+import { QueryClientImpl as OracleQueryClient } from "../codec/oracle/query";
+import { QueryClientImpl as OrderQueryClient } from "../codec/order/query";
+import { QueryClientImpl as PositionQueryClient } from "../codec/position/query";
+import { QueryClientImpl as PricingQueryClient } from "../codec/pricing/query";
+import { QueryClientImpl as ProfileQueryClient } from "../codec/profile/query";
+import { QueryClientImpl as SubaccountQueryClient } from "../codec/subaccount/query";
+import { QueryClientImpl as HeadersyncQueryClient } from "../codec/headersync/query";
+import { Tendermint34Client } from "@cosmjs/tendermint-rpc";
+import BlockchainClient from "./BlockchainClient";
+export interface IBCClientGroup {
+    controller: IBCInterchainControlQueryClient;
+    host: IBCInterchainHostQueryClient;
+    transfer: IBCTransferQueryClient;
+}
+declare class CarbonQueryClient {
+    private readonly tmClient;
+    adl: ADLQueryClient;
+    book: BookQueryClient;
+    broker: BrokerQueryClient;
+    coin: CoinQueryClient;
+    cdp: CDPQueryClient;
+    fee: FeeQueryClient;
+    inflation: InflationQueryClient;
+    insurance: InsuranceQueryClient;
+    leverage: LeverageQueryClient;
+    liquidation: LiquidationQueryClient;
+    liquiditypool: LiquidityPoolQueryClient;
+    market: MarketQueryClient;
+    marketstats: MarketStatsQueryClient;
+    misc: MiscQueryClient;
+    oracle: OracleQueryClient;
+    order: OrderQueryClient;
+    position: PositionQueryClient;
+    pricing: PricingQueryClient;
+    profile: ProfileQueryClient;
+    subaccount: SubaccountQueryClient;
+    headersync: HeadersyncQueryClient;
+    auth: AuthQueryClient;
+    bank: BankQueryClient;
+    distribution: DistributionQueryClient;
+    evidence: EvidenceQueryClient;
+    gov: GovQueryClient;
+    mint: MintQueryClient;
+    params: ParamsQueryClient;
+    slashing: SlashingQueryClient;
+    staking: StakingQueryClient;
+    upgrade: UpgradeQueryClient;
+    chain: BlockchainClient;
+    ibc: IBCClientGroup;
+    private baseClient;
+    constructor(tmClient: Tendermint34Client);
+}
+export default CarbonQueryClient;

package/lib/clients/ETHClient.d.ts

@@ -0,0 +1,101 @@
+import CarbonSDK from "../CarbonSDK";
+import { EthNetworkConfig, NetworkConfig, NetworkConfigProvider } from "../constant";
+import { Models } from "../index";
+import { Blockchain } from "../util/blockchain";
+import { TokenInitInfo, TokensWithExternalBalance } from "../util/external";
+import BigNumber from "bignumber.js";
+import { ethers } from "ethers";
+import TokenClient from "./TokenClient";
+export interface ETHClientOpts {
+    configProvider: NetworkConfigProvider;
+    tokenClient: TokenClient;
+    blockchain: Blockchain;
+}
+interface ETHTxParams {
+    gasPriceGwei: BigNumber;
+    gasLimit: BigNumber;
+    ethAddress: string;
+    signer: ethers.Signer;
+}
+export interface BridgeParams {
+    fromToken: Models.Token;
+    toToken: Models.Token;
+    amount: BigNumber;
+    fromAddress: string;
+    recoveryAddress: string;
+    toAddress: string;
+    feeAmount: BigNumber;
+    gasPriceGwei: BigNumber;
+    gasLimit: BigNumber;
+    signer: ethers.Signer;
+    signCompleteCallback?: () => void;
+}
+export interface LockParams extends ETHTxParams {
+    address: Uint8Array;
+    amount: BigNumber;
+    token: Models.Token;
+    signCompleteCallback?: () => void;
+}
+export interface ApproveERC20Params extends ETHTxParams {
+    token: Models.Token;
+    spenderAddress?: string;
+    signCompleteCallback?: () => void;
+}
+export interface EthersTransactionResponse extends ethers.Transaction {
+    wait: () => Promise<ethers.Transaction>;
+}
+export declare const FEE_MULTIPLIER: ethers.BigNumber;
+export declare class ETHClient {
+    readonly configProvider: NetworkConfigProvider;
+    readonly blockchain: Blockchain;
+    readonly tokenClient: TokenClient;
+    static SUPPORTED_BLOCKCHAINS: Blockchain[];
+    static BLOCKCHAIN_KEY: {
+        bsc: string;
+        eth: string;
+    };
+    private constructor();
+    static instance(opts: ETHClientOpts): ETHClient;
+    getExternalBalances(api: CarbonSDK, address: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    approveERC20(params: ApproveERC20Params): Promise<EthersTransactionResponse>;
+    checkAllowanceERC20(token: Models.Token, owner: string, spender: string): Promise<BigNumber>;
+    bridgeTokens(params: BridgeParams): Promise<EthersTransactionResponse>;
+    lockDeposit(params: LockParams): Promise<EthersTransactionResponse>;
+    getDepositContractAddress(swthBech32Address: string, ownerEthAddress: string): Promise<string>;
+    sendDeposit(tokenWithExternalBalances: TokensWithExternalBalance, swthAddress: string, ethAddress: string, getSignatureCallback: (msg: string) => Promise<{
+        address: string;
+        signature: string;
+    }>, overrideFee?: ethers.BigNumber): Promise<Response | "insufficient balance">;
+    getDepositFeeAmount(token: Models.Token, depositAddress: string): Promise<ethers.BigNumber>;
+    isContract(address: string): Promise<boolean>;
+    retrieveERC20Info(address: string): Promise<TokenInitInfo>;
+    formatWithdrawalAddress(address: string): Promise<string>;
+    getEthSigner(privateKey: ethers.utils.BytesLike): ethers.Wallet;
+    sign(message: string, privateKey: ethers.utils.BytesLike): Promise<{
+        address: string;
+        signature: string;
+    }>;
+    /**
+     * TargetProxyHash is a hash of token originator address that is used
+     * for lockproxy asset registration and identification
+     *
+     * @param token
+     */
+    getTargetProxyHash(token: Models.Token): string;
+    getProvider(): ethers.providers.JsonRpcProvider;
+    getNetworkConfig(): NetworkConfig;
+    getConfig(): EthNetworkConfig;
+    getPayerUrl(): string;
+    getProviderUrl(): string;
+    getLockProxyAddress(): string;
+    getBalanceReaderAddress(): string;
+    getWalletBytecodeHash(): string;
+    getBridgeEntranceAddr(): string;
+    /**
+     * verify that address is a valid checksum.
+     * Returns checksum address if valid, returns undefined if invalid
+     * @input address to be verified
+     */
+    verifyChecksum(input: string): string | undefined;
+}
+export default ETHClient;

package/lib/clients/HydrogenClient.d.ts

@@ -0,0 +1,21 @@
+import { NetworkConfig } from "../constant";
+import { GetDetailedTransfersResponse, GetRelaysRequest, GetStatsResponse, GetTransfersRequest, GetTransfersResponse } from "../hydrogen";
+import { GetFeeQuoteRequest, GetFeeQuoteResponse } from "../hydrogen/feeQuote";
+export declare const HydrogenEndpoints: {
+    stats: string;
+    transfer_payloads: string;
+    relays: string;
+    fee_quote: string;
+};
+declare class HydrogenClient {
+    private config;
+    private readonly apiManager;
+    constructor(config: NetworkConfig);
+    checkState(): void;
+    getStats(): Promise<GetStatsResponse>;
+    getTransfers(req: GetTransfersRequest): Promise<GetTransfersResponse>;
+    getDetailedTransfers(req: GetTransfersRequest): Promise<GetDetailedTransfersResponse>;
+    getRelaysTransfers(req: GetRelaysRequest): Promise<GetDetailedTransfersResponse>;
+    getFeeQuote(req: GetFeeQuoteRequest): Promise<GetFeeQuoteResponse>;
+}
+export default HydrogenClient;

package/lib/clients/InsightsQueryClient.d.ts

@@ -0,0 +1,36 @@
+import { NetworkConfig } from "../constant";
+import { Insights } from "../index";
+import { APIUtils } from "../util";
+declare class InsightsQueryClient {
+    readonly apiManager: APIUtils.APIManager<typeof Insights.InsightsEndpoints>;
+    constructor(config: NetworkConfig);
+    parseResponse(response: Response): Promise<APIUtils.RequestResult>;
+    Stake(req?: Insights.QueryGetStakeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetStakeResponse>>;
+    Transaction(req?: Insights.QueryGetTransactionRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetTransactionResponse>>;
+    AvgBlockTime(req: Insights.QueryGetAvgBlockTimeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetAvgBlockTimeResponse>>;
+    ActiveAccounts(req?: Insights.QueryGetActiveAccountsRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetActiveAccountsResponse>>;
+    UserProfile(req: Insights.QueryGetUserProfileRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetUserProfileResponse>>;
+    UserGrowth(req?: Insights.QueryGetUserGrowthRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetUserGrowthResponse>>;
+    TotalUsers(req?: Insights.QueryGetTotalUsersRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetTotalUsersResponse>>;
+    Pools(req?: Insights.QueryGetPoolsRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPoolsResponse>>;
+    PoolHistory(query: Insights.QueryGetPoolHistoryRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPoolHistoryResponse>>;
+    PoolVolume(req: Insights.QueryGetPoolVolumeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPoolVolumeResponse>>;
+    PoolsVolume(req?: Insights.QueryGetPoolsVolumeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPoolsVolumeResponse>>;
+    CompetitionLeaderboard(req: Insights.QueryGetCompetitionLeaderboardRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetCompetitionLeaderboardResponse>>;
+    PoolsLiquidity(req?: Insights.QueryGetPoolsLiquidityRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPoolsLiquidityResponse>>;
+    MarketsVolume(req?: Insights.QueryGetMarketVolumeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetMarketVolumeResponse>>;
+    Nodes(req?: Insights.QueryGetNodesRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetNodesResponse>>;
+    BalanceTotal(req: Insights.QueryGetTotalBalanceRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetTotalBalanceResponse>>;
+    BalanceList(req: Insights.QueryGetBalanceListRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetBalanceListResponse>>;
+    BalanceChange(req: Insights.QueryGetBalanceChangeRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetBalanceChangeResponse>>;
+    BalanceHistory(req: Insights.QueryGetBalanceHistoryRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetBalanceHistoryResponse>>;
+    BalanceSupply(): Promise<Insights.InsightsQueryResponse<Insights.QueryGetBalanceSupplyResponse>>;
+    BalanceDistribution(req?: Insights.QueryGetBalanceDistributionRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetBalanceDistributionResponse>>;
+    LiquidationEngine(query: Insights.GetLiquidationEngineParams): Promise<Insights.InsightsQueryResponse<Insights.QueryGetLiquidationEngineResponse>>;
+    LiquidationAndADL(query: Insights.GetLiquidationAndADLQueryParams): Promise<Insights.InsightsQueryResponse<Insights.QueryGetLiquidationAndADLResponse>>;
+    PositionsView(req: Insights.GetPositionsViewPathParams, query: Insights.GetPositionsViewQueryParams): Promise<Insights.InsightsQueryResponse<Insights.QueryGetPositionsViewResponse>>;
+    Leaderboard(req: Insights.GetLeaderboardPathParams, query: Insights.GetLeaderboardQueryParams): Promise<Insights.InsightsQueryResponse<Insights.QueryGetLeaderboardResponse>>;
+    DenomToGeckoIdMap(): Promise<Insights.InsightsQueryResponse<Insights.QueryDenomToGeckoIdMap>>;
+    FundingHistory(query: Insights.QueryGetFundingRateRequest): Promise<Insights.InsightsQueryResponse<Insights.QueryGetFundingRateResponse>>;
+}
+export default InsightsQueryClient;

package/lib/clients/N3Client.d.ts

@@ -0,0 +1,73 @@
+import CarbonSDK from "../CarbonSDK";
+import { NetworkConfigProvider } from "../constant";
+import { NeoLedgerAccount } from "../provider/account";
+import { O3Wallet } from "../provider/o3";
+import { Blockchain } from "../util/blockchain";
+import { TokensWithExternalBalance } from "../util/external";
+import { SimpleMap } from "../util/type";
+import { tx, u } from "@cityofzion/neon-core-next";
+import BigNumber from "bignumber.js";
+export interface N3ClientOpts {
+    configProvider: NetworkConfigProvider;
+    blockchain?: Blockchain;
+}
+export interface LockLedgerDepositParams {
+    token: TokensWithExternalBalance;
+    toAddressHex: string;
+    feeAmount: BigNumber;
+    amount: BigNumber;
+    signCompleteCallback?: () => void;
+    ledger: NeoLedgerAccount;
+}
+export interface LockO3DepositParams {
+    token: TokensWithExternalBalance;
+    toAddressHex: string;
+    feeAmount: BigNumber;
+    amount: BigNumber;
+    signCompleteCallback?: () => void;
+    o3Wallet: O3Wallet;
+}
+export interface NeoDapiInvokeArgs {
+    scriptHash: string;
+    args?: any[];
+    operation: string;
+    fee?: string;
+    signers: any[];
+}
+export interface NeoDapiInvokeOutput {
+    txid: string;
+    nodeUrl: string;
+}
+export interface N3Signer {
+    scriptHash: string;
+    sign: (txn: tx.Transaction, networkMagic?: number, k?: string | number) => Promise<tx.Transaction>;
+}
+export declare class N3Client {
+    readonly configProvider: NetworkConfigProvider;
+    readonly blockchain: Blockchain;
+    static SUPPORTED_BLOCKCHAINS: Blockchain[];
+    static BLOCKCHAIN_KEY: {
+        neo3: string;
+    };
+    private rpcClient;
+    private constructor();
+    static signerFromPrivateKey(privateKey: string): N3Signer;
+    static signerFromLedger(ledger: NeoLedgerAccount): N3Signer;
+    static instance(opts: N3ClientOpts): N3Client;
+    getExternalBalances(sdk: CarbonSDK, address: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    getAllN3Balances(address: string): Promise<SimpleMap<string>>;
+    lock(lockProxyScriptHash: string, tokenScriptHash: string, fromAddressHex: string, toAddressHex: string, amount: BigNumber, feeAmount: BigNumber, signer: N3Signer): Promise<string | false>;
+    lockDeposit(token: TokensWithExternalBalance, feeAmountInput: string, swthAddress: string, neoPrivateKey: string): Promise<string | false>;
+    lockO3Deposit(params: LockO3DepositParams): Promise<string>;
+    lockLedgerDeposit(params: LockLedgerDepositParams): Promise<string | false>;
+    getNetworkFee(txn: tx.Transaction, networkFee: number): Promise<u.BigInteger>;
+    getSystemFee(txn: tx.Transaction, systemFee: number, signers?: (tx.Signer | tx.SignerJson)[]): Promise<u.BigInteger>;
+    formatWithdrawalAddress(address: string): Promise<string>;
+    retrieveNEP17Info(address: string): Promise<{
+        name: string;
+        symbol: string;
+        address: string;
+        decimals: number;
+    }>;
+}
+export default N3Client;

package/lib/clients/NEOClient.d.ts

@@ -0,0 +1,57 @@
+import CarbonSDK from "../CarbonSDK";
+import { NeoNetworkConfig, NetworkConfig, NetworkConfigProvider } from "../constant";
+import { Models } from "../index";
+import { NeoLedgerAccount } from "../provider/account";
+import { O3Wallet } from "../provider/o3";
+import { Blockchain } from "../util/blockchain";
+import { TokenInitInfo, TokensWithExternalBalance } from "../util/external";
+import BigNumber from "bignumber.js";
+export interface NEOClientOpts {
+    configProvider: NetworkConfigProvider;
+    blockchain?: Blockchain;
+}
+export interface LockLedgerDepositParams {
+    feeAmount: BigNumber;
+    amount: BigNumber;
+    address: Uint8Array;
+    token: TokensWithExternalBalance;
+    ledger: NeoLedgerAccount;
+    signCompleteCallback?: () => void;
+}
+export interface LockO3DepositParams {
+    feeAmount: BigNumber;
+    amount: BigNumber;
+    address: Uint8Array;
+    token: TokensWithExternalBalance;
+    o3Wallet: O3Wallet;
+    signCompleteCallback?: () => void;
+}
+export declare class NEOClient {
+    readonly configProvider: NetworkConfigProvider;
+    readonly blockchain: Blockchain;
+    static SUPPORTED_BLOCKCHAINS: Blockchain[];
+    static BLOCKCHAIN_KEY: {
+        neo: string;
+    };
+    private constructor();
+    static instance(opts: NEOClientOpts): NEOClient;
+    private parseHexNum;
+    getExternalBalances(sdk: CarbonSDK, address: string, url: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    lockDeposit(token: TokensWithExternalBalance, feeAmountInput: string, swthAddress: string, neoPrivateKey: string): Promise<false | import("@cityofzion/neon-api/lib/funcs/types").DoInvokeConfig>;
+    lockO3Deposit(params: LockO3DepositParams): Promise<any>;
+    lockLedgerDeposit(params: LockLedgerDepositParams): Promise<any>;
+    retrieveNEP5Info(scriptHash: string): Promise<TokenInitInfo>;
+    wrapNeoToNneo(neoAmount: BigNumber, neoPrivateKey: string): Promise<import("@cityofzion/neon-api/lib/funcs/types").DoInvokeConfig>;
+    formatWithdrawalAddress(address: string): Promise<string>;
+    /**
+     * TargetProxyHash is a hash of token originator address that is used
+     * for lockproxy asset registration and identification
+     *
+     * @param token
+     */
+    getTargetProxyHash(token: Models.Token): string;
+    getNetworkConfig(): NetworkConfig;
+    getConfig(): NeoNetworkConfig;
+    getProviderUrl(): string;
+}
+export default NEOClient;

package/lib/clients/TokenClient.d.ts

@@ -0,0 +1,56 @@
+import { Token } from "../codec";
+import { NetworkConfigProvider } from "../constant";
+import { BlockchainUtils, TypeUtils } from "../util";
+import BigNumber from "bignumber.js";
+import CarbonQueryClient from "./CarbonQueryClient";
+declare class TokenClient {
+    readonly query: CarbonQueryClient;
+    readonly configProvider: NetworkConfigProvider;
+    static Blacklist: Partial<TypeUtils.NetworkMap<string[]>>;
+    readonly tokens: TypeUtils.SimpleMap<Token>;
+    readonly wrapperMap: TypeUtils.SimpleMap<string>;
+    readonly poolTokens: TypeUtils.SimpleMap<Token>;
+    readonly symbols: TypeUtils.SimpleMap<string>;
+    readonly usdValues: TypeUtils.SimpleMap<BigNumber>;
+    readonly commonAssetNames: TypeUtils.SimpleMap<string>;
+    readonly geckoTokenNames: TypeUtils.SimpleMap<string>;
+    private additionalGeckoDenoms;
+    private constructor();
+    static instance(query: CarbonQueryClient, configProvider: NetworkConfigProvider): TokenClient;
+    initialize(): Promise<void>;
+    registerGeckoIdMap(map: TypeUtils.SimpleMap<string>): void;
+    getCommonDenom(denom: string): string;
+    getDecimals(denom: string): number | undefined;
+    getBlockchain(denom: string): BlockchainUtils.Blockchain | undefined;
+    getSymbol(denom: string): string;
+    getUSDValue(denom: string): BigNumber | undefined;
+    toHuman(denom: string, unitlessAmt: BigNumber): BigNumber;
+    toUnitless(denom: string, humanAmt: BigNumber): BigNumber;
+    tokenForId(id: string): Token | undefined;
+    tokenForDenom(denom: string): Token | undefined;
+    getFeeInfo(denom: string): Promise<any>;
+    getTokenName(denom: string, overrideMap?: TypeUtils.SimpleMap<string>): string;
+    getTokenDesc(denom: string): string;
+    static isPoolTokenNew(denom: string): boolean;
+    static isPoolTokenLegacy(denom: string): boolean;
+    static isPoolToken(denom: string): boolean;
+    static isIBCDenom(denom: string): boolean;
+    isWrappedToken(denom?: string): boolean;
+    hasWrappedToken(denom?: string): boolean;
+    getWrappedTokens(denom: string): Token[];
+    getWrappedToken(denom: string, blockchain?: BlockchainUtils.Blockchain): Token | null;
+    getSourceToken(denom: string): Token | null;
+    getNativeToken(): Token | undefined;
+    isNativeToken(denom: string): boolean;
+    getDepositTokenFor(tokenDenom: string, chain: BlockchainUtils.Blockchain): Token | undefined;
+    getAllTokens(): Promise<Token[]>;
+    reloadTokens(): Promise<TypeUtils.SimpleMap<Token>>;
+    getCarbonIbcTokens(): Token[];
+    reloadWrapperMap(): Promise<TypeUtils.SimpleMap<string>>;
+    reloadDenomGeckoMap(): Promise<void>;
+    reloadUSDValues(denoms?: string[]): Promise<TypeUtils.SimpleMap<BigNumber>>;
+    getUSDValuesFromCoinGecko(geckoIds: string[]): Promise<any>;
+    getDenomToGeckoIdMap(): Promise<TypeUtils.SimpleMap<string>>;
+    setCommonAssetConfig(): void;
+}
+export default TokenClient;

package/lib/clients/ZILClient.d.ts

@@ -0,0 +1,106 @@
+import CarbonSDK from "../CarbonSDK";
+import { NetworkConfig, NetworkConfigProvider, ZilNetworkConfig } from "../constant";
+import { Models } from "../index";
+import { Blockchain } from "../util/blockchain";
+import { TokensWithExternalBalance } from "../util/external";
+import { Transaction, Wallet } from "@zilliqa-js/account";
+import { Zilliqa } from "@zilliqa-js/zilliqa";
+import BigNumber from "bignumber.js";
+export declare type WalletProvider = Omit<Zilliqa & {
+    wallet: Wallet & {
+        net: string;
+        defaultAccount: {
+            base16: string;
+            bech32: string;
+        };
+    };
+}, // ugly hack for zilpay non-standard API
+'subscriptionBuilder'>;
+export interface ZILClientOpts {
+    configProvider: NetworkConfigProvider;
+    blockchain: Blockchain;
+}
+interface ZILTxParams {
+    gasPrice: BigNumber;
+    gasLimit: BigNumber;
+    zilAddress: string;
+    signer: WalletProvider | string;
+}
+export interface ZILLockParams extends ZILTxParams {
+    address: Uint8Array;
+    amount: BigNumber;
+    token: Models.Token;
+    signCompleteCallback?: () => void;
+}
+export interface ZilBridgeParams {
+    fromToken: Models.Token;
+    toToken: Models.Token;
+    amount: BigNumber;
+    fromAddress: string;
+    recoveryAddress: string;
+    toAddress: string;
+    feeAmount: BigNumber;
+    gasPrice: BigNumber;
+    gasLimit: BigNumber;
+    signer: WalletProvider | string;
+    signCompleteCallback?: () => void;
+}
+export interface ApproveZRC2Params extends ZILTxParams {
+    token: Models.Token;
+    spenderAddress?: string;
+    signCompleteCallback?: () => void;
+}
+export declare enum BatchRequestType {
+    Balance = "balance",
+    TokenBalance = "tokenBalance",
+    TokenAllowance = "tokenAllowance"
+}
+interface BatchRequestItem {
+    id: string;
+    jsonrpc: string;
+    method: string;
+    params: any[];
+}
+interface BatchRequest {
+    type: string;
+    item: BatchRequestItem;
+}
+export declare const tokenBalanceBatchRequest: (tokenAddress: string, walletAddress: string) => BatchRequest;
+export declare const balanceBatchRequest: (address: string) => BatchRequest;
+export declare class ZILClient {
+    readonly configProvider: NetworkConfigProvider;
+    readonly blockchain: Blockchain;
+    static SUPPORTED_BLOCKCHAINS: Blockchain[];
+    static BLOCKCHAIN_KEY: {
+        zil: string;
+    };
+    private walletProvider?;
+    private constructor();
+    static instance(opts: ZILClientOpts): ZILClient;
+    getExternalBalances(sdk: CarbonSDK, address: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    formatWithdrawalAddress(bech32Address: string): Promise<string>;
+    private callContract;
+    approveZRC2(params: ApproveZRC2Params): Promise<Transaction>;
+    checkAllowanceZRC2(token: Models.Token, owner: string, spender: string): Promise<BigNumber>;
+    bridgeTokens(params: ZilBridgeParams): Promise<Transaction>;
+    lockDeposit(params: ZILLockParams): Promise<Transaction>;
+    retrieveZRC2Info(address: string): Promise<{
+        decimals: number;
+        name: string;
+        symbol: string;
+        address: string;
+    }>;
+    /**
+     * TargetProxyHash is a hash of token originator address that is used
+     * for lockproxy asset registration and identification
+     *
+     * @param token
+     */
+    getTargetProxyHash(token: Models.Token): string;
+    getNetworkConfig(): NetworkConfig;
+    getConfig(): ZilNetworkConfig;
+    getProviderUrl(): string;
+    getLockProxyAddress(): string;
+    getBridgeEntranceAddr(): string;
+}
+export default ZILClient;

package/lib/clients/index.d.ts

@@ -0,0 +1,8 @@
+export { default as BlockchainClient } from "./BlockchainClient";
+export { default as CarbonQueryClient } from "./CarbonQueryClient";
+export { default as ETHClient } from "./ETHClient";
+export { default as NEOClient } from "./NEOClient";
+export { default as ZILClient } from "./ZILClient";
+export { default as TokenClient } from "./TokenClient";
+export { default as InsightsQueryClient } from "./InsightsQueryClient";
+export { default as HydrogenClient } from "./HydrogenClient";