example-js-sdk 0.0.1

package/lib/clients/InsightsQueryClient.js

@@ -0,0 +1,496 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../index");
+const util_1 = require("../util");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const dayjs_1 = __importDefault(require("dayjs"));
+class InsightsQueryClient {
+    constructor(config) {
+        const responseParser = this.parseResponse.bind(this);
+        this.apiManager = new util_1.APIUtils.APIManager(config.insightsUrl, index_1.Insights.InsightsEndpoints, responseParser);
+    }
+    async parseResponse(response) {
+        const { status, statusText, headers, url } = response;
+        const result = { status, statusText, headers, url };
+        try {
+            const responseJson = await response.json();
+            result.data = responseJson;
+        }
+        catch (e) {
+            console.error(e);
+        }
+        if (response.status >= 400 && response.status < 600) {
+            throw new util_1.APIUtils.RequestError(result, result.data?.error?.message || "unknown error");
+        }
+        return result;
+    }
+    // Chain api
+    async Stake(req = {}) {
+        const request = this.apiManager.path("chain/stake", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async Transaction(req = {}) {
+        const request = this.apiManager.path("chain/transaction", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async AvgBlockTime(req) {
+        const queryParams = {
+            hours: req.hours,
+        };
+        const request = this.apiManager.path("chain/blocktime", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async Inflation() {
+        const request = this.apiManager.path("chain/inflation");
+        const response = await request.get();
+        return response.data;
+    }
+    // User api
+    async ActiveAccounts(req = {}) {
+        const request = this.apiManager.path("user/active", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserProfile(req) {
+        const request = this.apiManager.path("user/profile", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserGrowth(req = {}) {
+        const request = this.apiManager.path("user/growth", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVolume(req, query) {
+        const request = this.apiManager.path("user/volume", req, query);
+        const response = await request.get();
+        const rawEntries = response.data.result.entries;
+        const meta = response.data.result.meta;
+        const parsedEntries = rawEntries.map(entry => ({
+            lastHeight: entry.lastHeight,
+            time: (0, dayjs_1.default)(entry.time),
+            volumeValue: new bignumber_js_1.default(entry.volumeValue),
+        }));
+        const parsedMeta = {
+            from: (0, dayjs_1.default)(meta.from),
+            until: (0, dayjs_1.default)(meta.until),
+            interval: meta.interval,
+        };
+        return { result: { entries: parsedEntries, meta: parsedMeta } };
+    }
+    async TotalUsers(req = {}) {
+        const request = this.apiManager.path("user/total", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserPnl(req, query) {
+        const request = this.apiManager.path("user/pnl", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserBalanceGraph(req, query) {
+        const request = this.apiManager.path("user/balance/graph", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserPnlGraph(req, query) {
+        const request = this.apiManager.path("user/pnl/graph", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserFundings(req, query) {
+        const request = this.apiManager.path("user/fundings", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserFundingBreakdown(req, query) {
+        const request = this.apiManager.path("user/funding/breakdown", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    // Pool api
+    async Pools(req = {}) {
+        const request = this.apiManager.path("pool/list", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async PoolHistory(query) {
+        const request = this.apiManager.path("pool/history", {}, {
+            sort: query.sort ?? "DESC",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+            poolId: query.poolId,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PerpPoolHistory(query) {
+        const request = this.apiManager.path("pool/perp/history", {}, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+            address: query.address,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PerpPoolApy(query) {
+        const routeParams = { id: query.id };
+        const request = this.apiManager.path("pool/perp/apy", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVaultApy(query) {
+        const routeParams = { id: query.id };
+        const request = this.apiManager.path("vault/user/apy", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVaultDepositors(query) {
+        const routeParams = { id: query.id };
+        const request = this.apiManager.path("vault/user/depositors", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVaultActions(query) {
+        const routeParams = { id: query.id };
+        const request = this.apiManager.path("vault/user/actions", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVaultDepositorActions(query) {
+        const routeParams = { address: query.address };
+        const request = this.apiManager.path("vault/depositor/actions", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PerpPoolDepositorActions(query) {
+        const routeParams = { address: query.address };
+        const request = this.apiManager.path("pool/perp/depositor/actions", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async UserVaultDepositorDeposits(query) {
+        const routeParams = { address: query.address };
+        const request = this.apiManager.path("vault/depositor/deposits", routeParams, {
+            limit: query.limit ?? 10,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PoolVolume(req) {
+        const routeParams = { poolId: req.poolId };
+        const queryParams = {
+            interval: req.interval,
+            from: req.from,
+            until: req.until,
+        };
+        const request = this.apiManager.path("pool/volume", routeParams, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async PoolsVolume(req = {}) {
+        const queryParams = {
+            market: req.market,
+            interval: req.interval,
+            from: req.from,
+            until: req.until,
+        };
+        const request = this.apiManager.path("pools/volume", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserRewardsClaimHistory(req) {
+        const routeParams = { address: req.address };
+        const request = this.apiManager.path("user/pool/rewards", routeParams, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async UserWalletConnected(body) {
+        const request = this.apiManager.path('user/connected/wallet');
+        const response = await request.post({ body });
+        return response.data;
+    }
+    async CompetitionList(req = {}) {
+        const request = this.apiManager.path("competition/list", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    /**
+     * endpoint for legacy Demex Trading volume Competition (circa. 2021-2022). Keeping this here as endpoint has not been removed.
+     */
+    async VolumeCompetitionLeaderboard(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+            ...(req.from && { from: req.from }),
+            ...(req.until && { until: req.until }),
+            ...(req.market && { market: req.market }),
+        };
+        const request = this.apiManager.path("competition/leaderboard", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    /**
+     * endpoint for Perps Trading Competition on Demex (14 Nov 2023 - 28 Nov 2023).
+    */
+    async PerpsTradingCompetitionVolume(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+            ...(req.address && { address: req.address }),
+        };
+        const request = this.apiManager.path("competition/leaderboardvolume", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async PNLCompetitionLeaderboard(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+            ...(req.market && { market: req.market }),
+        };
+        const request = this.apiManager.path("competition/leaderboardpnl", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async LotteryCompetitionLeaderboard(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+            ...(req.market && { market: req.market }),
+        };
+        const request = this.apiManager.path("competition/leaderboardlottery", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async LeagueCompetitionLeaderboard(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+            subCompetitionId: req.subCompetitionId,
+        };
+        const request = this.apiManager.path("competition/leaderboardleague", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async CosmosCompetitionLeaderboard(req) {
+        const queryParams = {
+            competitionId: req.competitionId,
+        };
+        const request = this.apiManager.path("competition/leaderboardcosmos", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async PoolsLiquidity(req = {}) {
+        const queryParams = {
+            poolId: req.poolId,
+            interval: req.interval,
+            from: req.from,
+            until: req.until,
+        };
+        const request = this.apiManager.path("pools/liquidity", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async MarketsVolume(req = {}) {
+        const queryParams = {
+            market: req.market,
+            interval: req.interval,
+            from: req.from,
+            until: req.until,
+            type: req.marketType,
+        };
+        const request = this.apiManager.path("market/volume", {}, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async CarbonCreditsRewards(req) {
+        const routeParams = { epoch: req.epoch, unixStart: req.unixStart };
+        const request = this.apiManager.path('reward/epoch', routeParams, {});
+        const response = await request.get();
+        return response.data;
+    }
+    async PnlLeaderboard(req) {
+        const routeParams = { unixStart: req.unixStart, unixEnd: req.unixEnd };
+        const queryParams = {
+            limit: req.limit ?? 100,
+            market: req.market ?? '',
+            offset: 0,
+            sort: 'DESC',
+        };
+        const request = this.apiManager.path('reward/leaderboard', routeParams, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    // Node api
+    async Nodes(req = {}) {
+        const request = this.apiManager.path("node/list", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    // Balance api
+    async BalanceTotal(req) {
+        const request = this.apiManager.path("balance/total", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async BalanceList(req) {
+        const request = this.apiManager.path("balance/list", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async BalanceChange(req) {
+        const request = this.apiManager.path("balance/change", req);
+        const response = await request.get();
+        return response.data;
+    }
+    async BalanceHistory(req) {
+        const routeParams = {
+            address: req.address,
+            denom: req.denom,
+        };
+        const queryParams = {
+            interval: req.interval,
+            limit: req.limit,
+        };
+        const request = this.apiManager.path("balance/history", routeParams, queryParams);
+        const response = await request.get();
+        return response.data;
+    }
+    async BalanceSupply() {
+        const request = this.apiManager.path("balance/supply");
+        const response = await request.get();
+        return response.data;
+    }
+    async BalanceDistribution(req = {}) {
+        const request = this.apiManager.path("balance/distribution", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    // Positions api
+    async LiquidationEngine(query) {
+        const request = this.apiManager.path("position/liquidation/engine", {}, {
+            sort: query.sort ?? "DESC",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async LiquidationAndADL(query) {
+        const request = this.apiManager.path("position/liquidation", {}, {
+            sort: query.sort ?? "DESC",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PositionsView(req, query) {
+        const request = this.apiManager.path("position/view", req, {
+            sort: query.sort ?? "DESC",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+            market: query.market ?? "",
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async Leaderboard(req, query) {
+        const request = this.apiManager.path("position/leaderboard", req, {
+            market: query.market ?? "",
+            sort: query.sort ?? "DESC",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+            address: query.address ?? "",
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async PositionStats(req, query) {
+        const request = this.apiManager.path("position/stats", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    //Coin Gecko Tokens
+    async DenomToGeckoIdMap() {
+        const request = this.apiManager.path("info/denom_gecko_map");
+        const response = await request.get();
+        return response.data;
+    }
+    async FundingHistory(query) {
+        const request = this.apiManager.path("market/funding/history/all", {}, {
+            market: query.market ?? "",
+            limit: query.limit ?? 100,
+            offset: query.offset ?? 0,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async HistoricalFundingHistory(query) {
+        const request = this.apiManager.path("market/funding/history", {}, {
+            market: query.market?.replace('%2F', '/') ?? "",
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async FundingHistoryGraphData(query) {
+        const request = this.apiManager.path("market/funding/history/chart", {}, {
+            market: query.market,
+            period: query.period,
+        });
+        const response = await request.get();
+        return response.data;
+    }
+    async ProposalVotes(req, query) {
+        const request = this.apiManager.path("proposal/votes", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async Delegations(req, query) {
+        const request = this.apiManager.path("delegations/delegator", req, query);
+        const response = await request.get();
+        return response.data;
+    }
+    async OraclePrices(req = {}) {
+        const request = this.apiManager.path("info/oracles_price", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async AlliancesStake(req = {}) {
+        const request = this.apiManager.path("alliances/stake", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async AlliancesRewards(req = {}) {
+        const request = this.apiManager.path("alliances/rewards", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+    async CrosschainVolumes(req = {}) {
+        const request = this.apiManager.path("crosschain/volume", {}, req);
+        const response = await request.get();
+        return response.data;
+    }
+}
+exports.default = InsightsQueryClient;

package/lib/clients/TokenClient.d.ts

@@ -0,0 +1,93 @@
+import { Carbon } from "../CarbonSDK";
+import { NetworkConfigProvider } from "../constant";
+import { GetFeeQuoteResponse } from "../hydrogen/feeQuote";
+import { BlockchainUtils, TypeUtils } from "../util";
+import { AxelarBridge, BlockchainV2, BridgeMap, IbcBridge } from '../util/blockchain';
+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<Carbon.Coin.Token>;
+    readonly wrapperMap: TypeUtils.SimpleMap<string>;
+    readonly poolTokens: TypeUtils.SimpleMap<Carbon.Coin.Token>;
+    readonly cdpTokens: TypeUtils.SimpleMap<Carbon.Coin.Token>;
+    readonly bridges: BridgeMap;
+    readonly symbols: TypeUtils.SimpleMap<string>;
+    readonly usdValues: TypeUtils.SimpleMap<BigNumber>;
+    readonly commonAssetNames: TypeUtils.SimpleMap<string>;
+    readonly geckoTokenNames: TypeUtils.SimpleMap<string>;
+    initialUsdValuesLoaded: boolean;
+    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 | BlockchainUtils.BlockchainV2 | undefined;
+    getBlockchainV2(denom: string | undefined): BlockchainUtils.BlockchainV2 | undefined;
+    /**
+     * use getTokenName directly instead
+     * @deprecated
+    */
+    getSymbol(denom: string): string;
+    getUSDValue(denom: string): BigNumber | undefined;
+    toHuman(denom: string, unitlessAmt: BigNumber): BigNumber;
+    toUnitless(denom: string, humanAmt: BigNumber): BigNumber;
+    tokenForId(id: string): Carbon.Coin.Token | undefined;
+    tokenForDenom(denom: string): Carbon.Coin.Token | undefined;
+    getFeeInfo(denom: string): Promise<GetFeeQuoteResponse>;
+    getTokenName(denom: string, overrideMap?: TypeUtils.SimpleMap<string>): string;
+    getTokenDesc(denom: string): string;
+    static isPoolTokenNew(denom: string): boolean;
+    static isPoolTokenLegacy(denom: string): boolean;
+    static isCdpToken(denom: string): boolean;
+    static isPoolToken(denom: string): boolean;
+    static isVaultToken(denom: string): boolean;
+    static isPerpPoolToken(denom: string): boolean;
+    static isUserVaultToken(denom: string): boolean;
+    static isIBCDenom(denom: string): boolean;
+    static isCdpIbcDenom(denom: string): boolean;
+    isWrappedToken(denom?: string): boolean;
+    hasWrappedToken(denom?: string): boolean;
+    getWrappedTokens(denom: string): Carbon.Coin.Token[];
+    getWrappedToken(denom: string, blockchain?: BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2, version?: string): Carbon.Coin.Token | null;
+    getSourceToken(denom: string): Carbon.Coin.Token | null;
+    getNativeToken(): Carbon.Coin.Token | undefined;
+    getNativeStablecoin(): Carbon.Coin.Token | undefined;
+    isNativeToken(denom: string): boolean;
+    isNativeStablecoin(denom: string): boolean;
+    isGroupChequeDenom(denom: string): boolean;
+    isBridgedToken(denom: string): boolean;
+    isCarbonToken(token?: Carbon.Coin.Token | null): boolean;
+    getDepositTokenFor(tokenDenom: string, chain: BlockchainUtils.Blockchain | BlockchainUtils.BlockchainV2, version?: string): Carbon.Coin.Token | undefined;
+    getAllTokens(): Promise<Carbon.Coin.Token[]>;
+    reloadTokens(): Promise<TypeUtils.SimpleMap<Carbon.Coin.Token>>;
+    getBridges(): Promise<BridgeMap>;
+    matchChainsWithDifferentChainIds(bridges: Carbon.Coin.Bridge[]): Promise<IbcBridge[]>;
+    mapBridgesFromConnections(): Promise<AxelarBridge[]>;
+    getIbcBlockchainNames(): string[];
+    getAxelarBlockchainNames(): string[];
+    getIbcBridgeFromBlockchainV2: (blockchain: BlockchainV2 | undefined) => IbcBridge | undefined;
+    getIbcChainFromBlockchainV2: (blockchain: BlockchainV2 | undefined) => string | undefined;
+    getPolynetworkBlockchainNames(): string[];
+    getAllBlockchainNames(): string[];
+    getBridgesFromBridgeId(bridgeId: number): Carbon.Coin.Bridge[] | IbcBridge[] | AxelarBridge[];
+    getIbcTokens(): TypeUtils.SimpleMap<Carbon.Coin.Token>;
+    getPolyNetworkTokens(): TypeUtils.SimpleMap<Carbon.Coin.Token>;
+    getBlockchainV2FromIDs(chainId: number, bridgeId: number): BlockchainV2 | undefined;
+    getBridgeFromToken(token: Carbon.Coin.Token | null | undefined): Carbon.Coin.Bridge | IbcBridge | undefined;
+    getIbcChainIdFromToken(token: Carbon.Coin.Token | null): string | undefined;
+    getCdpUnderlyingToken(cdpDenom: string): Carbon.Coin.Token | undefined;
+    reloadWrapperMap(): Promise<TypeUtils.SimpleMap<string>>;
+    reloadDenomGeckoMap(): Promise<void>;
+    reloadUSDValues(denoms?: string[]): Promise<TypeUtils.SimpleMap<BigNumber>>;
+    getUSDValuesFromCoinGecko(geckoIds: string[]): Promise<any>;
+    processTokenPrices(tokenPrices: Carbon.Pricing.TokenPrice[]): TypeUtils.SimpleMap<BigNumber>;
+    getUSDValuesFromPricingModule(): Promise<TypeUtils.SimpleMap<BigNumber>>;
+    getDenomToGeckoIdMap(): Promise<TypeUtils.SimpleMap<string>>;
+    setCommonAssetConfig(): void;
+}
+export default TokenClient;