carbon-js-sdk 0.4.6 → 0.4.7

package/lib/CarbonSDK.js

@@ -68,8 +68,8 @@ class CarbonSDK {
         this.chainId = (_d = (_c = opts.chainId) !== null && _c !== void 0 ? _c : constant_1.CarbonChainIDs[this.network]) !== null && _d !== void 0 ? _d : constant_1.CarbonChainIDs[constant_1.Network.MainNet];
         this.query = new clients_1.CarbonQueryClient(opts.tmClient);
         this.insights = new clients_1.InsightsQueryClient(this.networkConfig);
-        this.hydrogen = new clients_1.HydrogenClient(this.networkConfig);
         this.token = (_e = opts.token) !== null && _e !== void 0 ? _e : clients_1.TokenClient.instance(this.query, this);
+        this.hydrogen = clients_1.HydrogenClient.instance(this.networkConfig, this.token);
         this.admin = new modules_1.AdminModule(this);
         this.order = new modules_1.OrderModule(this);
         this.lp = new modules_1.LiquidityPoolModule(this);

package/lib/clients/ETHClient.d.ts

@@ -9,7 +9,7 @@ import TokenClient from "./TokenClient";
 export interface ETHClientOpts {
     configProvider: NetworkConfigProvider;
     tokenClient: TokenClient;
-    blockchain: Blockchain;
+    blockchain: typeof ETHClient.SUPPORTED_BLOCKCHAINS[number];
 }
 interface ETHTxParams {
     gasPriceGwei: BigNumber;
@@ -47,9 +47,9 @@ export interface EthersTransactionResponse extends ethers.Transaction {
 export declare const FEE_MULTIPLIER: ethers.BigNumber;
 export declare class ETHClient {
     readonly configProvider: NetworkConfigProvider;
-    readonly blockchain: Blockchain;
+    readonly blockchain: typeof ETHClient.SUPPORTED_BLOCKCHAINS[number];
     readonly tokenClient: TokenClient;
-    static SUPPORTED_BLOCKCHAINS: Blockchain[];
+    static SUPPORTED_BLOCKCHAINS: readonly [Blockchain.BinanceSmartChain, Blockchain.Ethereum, Blockchain.Arbitrum, Blockchain.Polygon, Blockchain.Okc];
     static BLOCKCHAIN_KEY: {
         bsc: string;
         eth: string;
@@ -57,9 +57,16 @@ export declare class ETHClient {
         polygon: string;
         okc: string;
     };
+    static BLOCKCHAINV2_MAPPING: {
+        bsc: string;
+        eth: string;
+        arbitrum: string;
+        polygon: string;
+        okc: string;
+    };
     private constructor();
     static instance(opts: ETHClientOpts): CarbonSDK.ETHClient;
-    getExternalBalances(api: CarbonSDK, address: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    getExternalBalances(api: CarbonSDK, address: string, whitelistDenoms?: string[], version?: string): Promise<TokensWithExternalBalance[]>;
     approveERC20(params: ApproveERC20Params): Promise<EthersTransactionResponse>;
     checkAllowanceERC20(token: Models.Token, owner: string, spender: string): Promise<BigNumber>;
     bridgeTokens(params: BridgeParams): Promise<EthersTransactionResponse>;

package/lib/clients/ETHClient.js

@@ -35,15 +35,22 @@ class ETHClient {
             throw new Error(`unsupported blockchain - ${blockchain}`);
         return new ETHClient(configProvider, blockchain, tokenClient);
     }
-    getExternalBalances(api, address, whitelistDenoms) {
+    getExternalBalances(api, address, whitelistDenoms, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             const tokenQueryResults = yield api.token.getAllTokens();
             const lockProxyAddress = this.getLockProxyAddress().toLowerCase();
-            const tokens = tokenQueryResults.filter((token) => blockchain_1.blockchainForChainId(token.chainId.toNumber(), api.network) == this.blockchain &&
-                token.tokenAddress.length == 40 &&
-                token.bridgeAddress.toLowerCase() == generic_1.stripHexPrefix(lockProxyAddress) &&
-                (!whitelistDenoms || whitelistDenoms.includes(token.denom)) &&
-                this.verifyChecksum(generic_1.appendHexPrefix(token.tokenAddress)));
+            const tokens = tokenQueryResults.filter((token) => {
+                const isCorrectBlockchain = version === "V2"
+                    ?
+                        this.tokenClient.getBlockchainV2(token.denom) == ETHClient.BLOCKCHAINV2_MAPPING[this.blockchain]
+                    :
+                        blockchain_1.blockchainForChainId(token.chainId.toNumber(), api.network) == this.blockchain;
+                return isCorrectBlockchain &&
+                    token.tokenAddress.length == 40 &&
+                    token.bridgeAddress.toLowerCase() == generic_1.stripHexPrefix(lockProxyAddress) &&
+                    (!whitelistDenoms || whitelistDenoms.includes(token.denom)) &&
+                    this.verifyChecksum(generic_1.appendHexPrefix(token.tokenAddress));
+            });
             const assetIds = tokens.map((token) => {
                 return this.verifyChecksum(generic_1.appendHexPrefix(token.tokenAddress));
             });
@@ -358,4 +365,11 @@ ETHClient.BLOCKCHAIN_KEY = {
     [blockchain_1.Blockchain.Polygon]: "polygon",
     [blockchain_1.Blockchain.Okc]: "okc",
 };
+ETHClient.BLOCKCHAINV2_MAPPING = {
+    [blockchain_1.Blockchain.BinanceSmartChain]: "Binance Smart Chain",
+    [blockchain_1.Blockchain.Ethereum]: "Ethereum",
+    [blockchain_1.Blockchain.Arbitrum]: "Arbitrum",
+    [blockchain_1.Blockchain.Polygon]: "Polygon",
+    [blockchain_1.Blockchain.Okc]: "Okc",
+};
 exports.default = ETHClient;

package/lib/clients/HydrogenClient.d.ts

@@ -1,6 +1,8 @@
 import { NetworkConfig } from "../constant";
-import { GetDetailedTransfersResponse, GetRelaysRequest, GetRelaysResponse, GetStatsResponse, GetTransfersRequest, GetTransfersResponse } from "../hydrogen";
-import { GetFeeQuoteRequest, GetFeeQuoteResponse } from "../hydrogen/feeQuote";
+import { BlockchainUtils } from "../util";
+import { ChainTransaction, CrossChainTransfer, CrossChainTransferDetailed, GetDetailedTransfersResponse, GetRelaysRequest, GetRelaysResponse, GetStatsResponse, GetTransfersRequest, GetTransfersResponse, RelaysResponse } from "../hydrogen";
+import { FeeQuote, GetFeeQuoteRequest, GetFeeQuoteResponse } from "../hydrogen/feeQuote";
+import TokenClient from './TokenClient';
 export declare const HydrogenEndpoints: {
     stats: string;
     transfer_payloads: string;
@@ -10,12 +12,19 @@ export declare const HydrogenEndpoints: {
 declare class HydrogenClient {
     private config;
     private readonly apiManager;
-    constructor(config: NetworkConfig);
+    private readonly tokenClient;
+    constructor(config: NetworkConfig, tokenClient: TokenClient);
+    static instance(config: NetworkConfig, tokenClient: TokenClient): HydrogenClient;
     checkState(): void;
+    formatCrossChainTransferV2: (value: any) => CrossChainTransfer;
+    formatCrossChainTransferDetailedV2: (value: any) => CrossChainTransferDetailed;
+    formatRelaysTransfersV2: (value: any) => RelaysResponse;
+    formatChainEventV2: (value: any, blockchain: BlockchainUtils.BlockchainV2) => ChainTransaction | null;
+    formatFeeQuoteV2: (value: any, blockchain: BlockchainUtils.BlockchainV2) => FeeQuote;
     getStats(): Promise<GetStatsResponse>;
-    getTransfers(req: GetTransfersRequest): Promise<GetTransfersResponse>;
-    getDetailedTransfers(req: GetTransfersRequest): Promise<GetDetailedTransfersResponse>;
-    getRelaysTransfers(req: GetRelaysRequest): Promise<GetRelaysResponse>;
-    getFeeQuote(req: GetFeeQuoteRequest): Promise<GetFeeQuoteResponse>;
+    getTransfers(req: GetTransfersRequest, version?: string): Promise<GetTransfersResponse>;
+    getDetailedTransfers(req: GetTransfersRequest, version?: string): Promise<GetDetailedTransfersResponse>;
+    getRelaysTransfers(req: GetRelaysRequest, version?: string): Promise<GetRelaysResponse>;
+    getFeeQuote(req: GetFeeQuoteRequest, blockchain?: BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2 | undefined, version?: string): Promise<GetFeeQuoteResponse>;
 }
 export default HydrogenClient;

package/lib/clients/HydrogenClient.js

@@ -67,10 +67,56 @@ const formatFeeQuote = (value) => {
         return value;
     return Object.assign(Object.assign({}, value), { blockchain: parseHydrogenBlockchain(value.blockchain), created_at: formatDateField((_a = value.created_at) === null || _a === void 0 ? void 0 : _a.toString()), expires_at: formatDateField((_b = value.expires_at) === null || _b === void 0 ? void 0 : _b.toString()) });
 };
+const getBridgeBlockchainFromId = (bridgeId) => {
+    switch (bridgeId) {
+        case 1:
+            return 'Polynetwork';
+        case 2:
+            return 'Ibc';
+        default:
+            return 'Polynetwork';
+    }
+};
 class HydrogenClient {
-    constructor(config) {
+    constructor(config, tokenClient) {
         this.config = config;
+        this.formatCrossChainTransferV2 = (value) => {
+            var _a, _b;
+            if (typeof value !== "object")
+                return value;
+            return Object.assign(Object.assign({}, value), { created_at: formatDateField((_a = value.created_at) === null || _a === void 0 ? void 0 : _a.toString()), updated_at: formatDateField((_b = value.updated_at) === null || _b === void 0 ? void 0 : _b.toString()), source_blockchain: this.tokenClient.getBlockchainV2FromIDs(value.from_chain_id, value.bridge_id), bridging_blockchain: getBridgeBlockchainFromId(value.bridge_id), destination_blockchain: this.tokenClient.getBlockchainV2FromIDs(value.to_chain_id, value.bridge_id) });
+        };
+        this.formatCrossChainTransferDetailedV2 = (value) => {
+            if (!value || typeof value !== "object")
+                return value;
+            const source_blockchain = this.tokenClient.getBlockchainV2FromIDs(value.from_chain_id, value.bridge_id);
+            const destination_blockchain = this.tokenClient.getBlockchainV2FromIDs(value.to_chain_id, value.bridge_id);
+            const bridging_blockchain = getBridgeBlockchainFromId(value.bridge_id);
+            return Object.assign(Object.assign({}, this.formatCrossChainTransferV2(value)), { source_event: this.formatChainEventV2(value.source_event, source_blockchain !== null && source_blockchain !== void 0 ? source_blockchain : ''), bridging_event: this.formatChainEventV2(value.bridging_event, bridging_blockchain), destination_event: this.formatChainEventV2(value.destination_event, destination_blockchain !== null && destination_blockchain !== void 0 ? destination_blockchain : '') });
+        };
+        this.formatRelaysTransfersV2 = (value) => {
+            var _a, _b;
+            if (!value || typeof value !== "object")
+                return value;
+            return Object.assign(Object.assign({}, value), { created_at: formatDateField((_a = value.created_at) === null || _a === void 0 ? void 0 : _a.toString()), updated_at: formatDateField((_b = value.updated_at) === null || _b === void 0 ? void 0 : _b.toString()), source_blockchain: this.tokenClient.getBlockchainV2FromIDs(value.from_chain_id, value.bridge_id), bridging_blockchain: getBridgeBlockchainFromId(value.bridge_id), destination_blockchain: this.tokenClient.getBlockchainV2FromIDs(value.to_chain_id, value.bridge_id) });
+        };
+        this.formatChainEventV2 = (value, blockchain) => {
+            var _a, _b, _c;
+            if (!value || typeof value !== "object")
+                return value;
+            return Object.assign(Object.assign({}, value), { confirmed_at: formatDateField((_a = value.confirmed_at) === null || _a === void 0 ? void 0 : _a.toString()), created_at: formatDateField((_b = value.created_at) === null || _b === void 0 ? void 0 : _b.toString()), updated_at: formatDateField((_c = value.updated_at) === null || _c === void 0 ? void 0 : _c.toString()), blockchain });
+        };
+        this.formatFeeQuoteV2 = (value, blockchain) => {
+            var _a, _b;
+            if (typeof value !== "object")
+                return value;
+            return Object.assign(Object.assign({}, value), { blockchain, created_at: formatDateField((_a = value.created_at) === null || _a === void 0 ? void 0 : _a.toString()), expires_at: formatDateField((_b = value.expires_at) === null || _b === void 0 ? void 0 : _b.toString()) });
+        };
         this.apiManager = new util_1.APIUtils.APIManager(config.hydrogenUrl, exports.HydrogenEndpoints);
+        this.tokenClient = tokenClient;
+    }
+    static instance(config, tokenClient) {
+        return new HydrogenClient(config, tokenClient);
     }
     checkState() {
         var _a;
@@ -89,40 +135,40 @@ class HydrogenClient {
             return response.data;
         });
     }
-    getTransfers(req) {
+    getTransfers(req, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkState();
             const request = this.apiManager.path("transfer_payloads", {}, Object.assign(Object.assign({}, req), { include_tx: false }));
             const response = yield request.get();
             const result = response.data;
-            return Object.assign(Object.assign({}, result), { data: result.data.map(formatCrossChainTransfer) });
+            return Object.assign(Object.assign({}, result), { data: result.data.map(version === "V1" ? formatCrossChainTransfer : this.formatCrossChainTransferV2) });
         });
     }
-    getDetailedTransfers(req) {
+    getDetailedTransfers(req, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkState();
             const request = this.apiManager.path("transfer_payloads", {}, Object.assign(Object.assign({}, req), { include_tx: true }));
             const response = yield request.get();
             const result = response.data;
-            return Object.assign(Object.assign({}, result), { data: result.data.map(formatCrossChainTransferDetailed) });
+            return Object.assign(Object.assign({}, result), { data: result.data.map(version === "V1" ? formatCrossChainTransferDetailed : this.formatCrossChainTransferDetailedV2) });
         });
     }
-    getRelaysTransfers(req) {
+    getRelaysTransfers(req, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkState();
             const request = this.apiManager.path("relays", {}, Object.assign(Object.assign({}, req), { include_tx: true }));
             const response = yield request.get();
             const result = response.data;
-            return Object.assign(Object.assign({}, result), { data: result.data.map(formatRelaysTransfers) });
+            return Object.assign(Object.assign({}, result), { data: result.data.map(version === "V1" ? formatRelaysTransfers : this.formatRelaysTransfersV2) });
         });
     }
-    getFeeQuote(req) {
+    getFeeQuote(req, blockchain = undefined, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkState();
             const request = this.apiManager.path("fee_quote", {}, Object.assign({}, req));
             const response = yield request.get();
             const result = response.data;
-            return formatFeeQuote(result);
+            return version === "V1" ? formatFeeQuote(result) : this.formatFeeQuoteV2(result, blockchain);
         });
     }
 }

package/lib/clients/NEOClient.d.ts

@@ -36,7 +36,7 @@ export declare class NEOClient {
     private constructor();
     static instance(opts: NEOClientOpts): CarbonSDK.NEOClient;
     static parseHexNum(hex: string, exp?: number): string;
-    getExternalBalances(sdk: CarbonSDK, address: string, url: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
+    getExternalBalances(sdk: CarbonSDK, address: string, url: string, whitelistDenoms?: string[], version?: 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>;

package/lib/clients/NEOClient.js

@@ -60,13 +60,18 @@ class NEOClient {
         const res = hex.length % 2 !== 0 ? `0${hex}` : hex;
         return new bignumber_js_1.default(res ? Neon.u.reverseHex(res) : "00", 16).shiftedBy(-exp).toString();
     }
-    getExternalBalances(sdk, address, url, whitelistDenoms) {
+    getExternalBalances(sdk, address, url, whitelistDenoms, version = "V1") {
         return __awaiter(this, void 0, void 0, function* () {
             const tokenQueryResults = yield sdk.token.getAllTokens();
             const account = new Neon.wallet.Account(address);
-            const tokens = tokenQueryResults.filter((token) => blockchain_1.blockchainForChainId(token.chainId.toNumber(), sdk.network) == this.blockchain &&
-                token.tokenAddress.length == 40 &&
-                token.bridgeAddress.length == 40);
+            const tokens = tokenQueryResults.filter((token) => {
+                const isCorrectBlockchain = version === "V2"
+                    ?
+                        !!sdk.token.getBlockchainV2(token.denom) && (blockchain_1.BLOCKCHAIN_V2_TO_V1_MAPPING[sdk.token.getBlockchainV2(token.denom)] == this.blockchain)
+                    :
+                        blockchain_1.blockchainForChainId(token.chainId.toNumber(), sdk.network) == this.blockchain;
+                return (isCorrectBlockchain || token.denom === "swth") && token.tokenAddress.length == 40 && token.bridgeAddress.length == 40;
+            });
             const client = new Neon.rpc.RPCClient(url, "2.5.2"); // TODO: should we change the RPC version??
             // NOTE: fetching of tokens is chunked in sets of 15 as we may hit
             // the gas limit on the RPC node and error out otherwise

package/lib/clients/TokenClient.d.ts

@@ -1,9 +1,14 @@
-import { Token, TokenPrice } from "../codec";
+import { Bridge, Token, TokenPrice } from "../codec";
+import { DenomTrace } from "../codec/ibc/applications/transfer/v1/transfer";
 import { NetworkConfigProvider } from "../constant";
 import { FeeQuote } from "../hydrogen/feeQuote";
 import { BlockchainUtils, TypeUtils } from "../util";
+import { BlockchainV2, BridgeMap, IbcBridge } from '../util/blockchain';
 import BigNumber from "bignumber.js";
 import CarbonQueryClient from "./CarbonQueryClient";
+export interface DenomTraceExtended extends DenomTrace {
+    token?: Token;
+}
 declare class TokenClient {
     readonly query: CarbonQueryClient;
     readonly configProvider: NetworkConfigProvider;
@@ -12,10 +17,12 @@ declare class TokenClient {
     readonly wrapperMap: TypeUtils.SimpleMap<string>;
     readonly poolTokens: TypeUtils.SimpleMap<Token>;
     readonly cdpTokens: TypeUtils.SimpleMap<Token>;
+    readonly bridges: BridgeMap;
     readonly symbols: TypeUtils.SimpleMap<string>;
     readonly usdValues: TypeUtils.SimpleMap<BigNumber>;
     readonly commonAssetNames: TypeUtils.SimpleMap<string>;
     readonly geckoTokenNames: TypeUtils.SimpleMap<string>;
+    readonly denomTraces: TypeUtils.SimpleMap<DenomTraceExtended>;
     private additionalGeckoDenoms;
     private constructor();
     static instance(query: CarbonQueryClient, configProvider: NetworkConfigProvider): TokenClient;
@@ -23,7 +30,8 @@ declare class TokenClient {
     registerGeckoIdMap(map: TypeUtils.SimpleMap<string>): void;
     getCommonDenom(denom: string): string;
     getDecimals(denom: string): number | undefined;
-    getBlockchain(denom: string): BlockchainUtils.Blockchain | undefined;
+    getBlockchain(denom: string): BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2 | undefined;
+    getBlockchainV2(denom: string | undefined): BlockchainUtils.BlockchainV2 | undefined;
     getSymbol(denom: string): string;
     getUSDValue(denom: string): BigNumber | undefined;
     toHuman(denom: string, unitlessAmt: BigNumber): BigNumber;
@@ -42,16 +50,32 @@ declare class TokenClient {
     isWrappedToken(denom?: string): boolean;
     hasWrappedToken(denom?: string): boolean;
     getWrappedTokens(denom: string): Token[];
-    getWrappedToken(denom: string, blockchain?: BlockchainUtils.Blockchain): Token | null;
+    getWrappedToken(denom: string, blockchain?: BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2, version?: string): Token | null;
     getSourceToken(denom: string): Token | null;
     getNativeToken(): Token | undefined;
     getNativeStablecoin(): Token | undefined;
     isNativeToken(denom: string): boolean;
     isNativeStablecoin(denom: string): boolean;
-    getDepositTokenFor(tokenDenom: string, chain: BlockchainUtils.Blockchain): Token | undefined;
+    isGroupedToken(denom: string): boolean;
+    isCarbonToken(token?: Token | null): boolean;
+    getDepositTokenFor(tokenDenom: string, chain: BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2, version?: string): Token | undefined;
     getAllTokens(): Promise<Token[]>;
     reloadTokens(): Promise<TypeUtils.SimpleMap<Token>>;
-    getCarbonIbcTokens(): Token[];
+    reloadDenomTraces(): Promise<TypeUtils.SimpleMap<DenomTraceExtended>>;
+    getDenomTraceData(denom: string): DenomTrace | undefined;
+    getBridges(): Promise<BridgeMap>;
+    matchChainsWithDifferentChainIds(bridges: Bridge[]): Promise<IbcBridge[]>;
+    getIbcBlockchainNames(): string[];
+    getIbcChainFromBlockchainV2: (blockchain: BlockchainV2 | undefined) => string | undefined;
+    getPolynetworkBlockchainNames(): string[];
+    getAllBlockchainNames(): string[];
+    getBridgesFromBridgeId(bridgeId: number): Bridge[] | IbcBridge[];
+    getIbcTokens(): TypeUtils.SimpleMap<Token>;
+    getPolyNetworkTokens(): TypeUtils.SimpleMap<Token>;
+    getBlockchainV2FromIDs(chainId: string, bridgeId: string): BlockchainV2 | undefined;
+    getBridgeFromToken(token: Token | null): Bridge | IbcBridge | undefined;
+    getIbcChainIdFromToken(token: Token | null): string | undefined;
+    getCarbonDenomTraces(): Promise<TypeUtils.SimpleMap<DenomTrace>>;
     getCdpUnderlyingToken(cdpDenom: string): Token | undefined;
     reloadWrapperMap(): Promise<TypeUtils.SimpleMap<string>>;
     reloadDenomGeckoMap(): Promise<void>;