example-js-sdk 0.0.1

package/lib/websocket/models.d.ts

@@ -0,0 +1,332 @@
+export interface AccountTrade {
+    order_id: string;
+    market_id: string;
+    side: string;
+    price: string;
+    quantity: string;
+    fee_amount: string;
+    fee_denom: string;
+    address: string;
+    block_height: number;
+    block_created_at: string;
+    trade_id: number;
+}
+export interface HistoryOrder {
+    address: string;
+    allocated_margin: string;
+    avg_filled_price: string;
+    available: string;
+    block_created_at: string;
+    block_height: number;
+    filled: string;
+    id: string;
+    initiator: string;
+    is_liquidation?: boolean;
+    is_post_only?: boolean;
+    is_reduce_only?: boolean;
+    market_id: string;
+    order_type: string;
+    pool_id?: number;
+    price: string;
+    quantity: string;
+    side: string;
+    status: string;
+    stop_price: string;
+    time_in_force?: string;
+    trigger_type: string;
+    triggered_block_height: number;
+    referral_address?: string;
+    referral_commission?: number;
+    referral_kickback?: number;
+    cancel_reason?: number;
+}
+export interface BaseHistoryOrder extends HistoryOrder {
+    allocated_margin_amount: string;
+    allocated_margin_denom: string;
+    last_updated_block_height: number;
+    username?: string;
+}
+export interface BaseHistoryOrderEvent extends BaseHistoryOrder {
+    type?: string;
+}
+export interface Candlestick {
+    time: string;
+    close: string;
+    market_id: string;
+    open: string;
+    high: string;
+    low: string;
+    volume: string;
+    quote_volume: string;
+    resolution: number;
+}
+export interface RecentTrade {
+    block_created_at: string;
+    block_height: number;
+    market_id: string;
+    price: string;
+    quantity: string;
+    id?: string;
+    liquidation?: string;
+    taker_id?: string;
+    taker_side?: string;
+    taker_address?: string;
+    taker_fee_amount?: string;
+    taker_fee_denom?: string;
+    taker_fee_kickback?: string;
+    taker_fee_commission?: string;
+    taker_fee_commission_address?: string;
+    maker_id?: string;
+    maker_side?: string;
+    maker_address?: string;
+    maker_fee_amount?: string;
+    maker_fee_denom?: string;
+    maker_fee_kickback?: string;
+    maker_fee_commission?: string;
+    maker_fee_commission_address?: string;
+}
+export interface Position {
+    market_id: string;
+    address: string;
+    trade_id: string;
+    side: string;
+    opened_block_height: number;
+    updated_block_height: number;
+    closed_block_height?: number;
+    realized_pnl: string;
+    max_lots: string;
+    total_fee_amount: string;
+    avg_allocated_margin: string;
+    avg_entry_price: string;
+    avg_exit_price: string;
+    allocated_margin: string;
+    lots: string;
+    opened_at: string;
+    closed_at?: string;
+}
+export interface MarketStat {
+    day_high: string;
+    day_low: string;
+    day_open: string;
+    day_close: string;
+    day_volume: string;
+    day_quote_volume: string;
+    index_price: string;
+    mark_price: string;
+    last_price: string;
+    market_id: string;
+    market_type: string;
+    premium_rate: string;
+    last_funding_at: string;
+    open_interest: string;
+}
+export interface PriceLevel {
+    price: string;
+    quantity: string;
+    market?: string;
+    side?: string;
+}
+export interface PriceLevelEvent extends PriceLevel {
+    type?: string;
+}
+export interface Leverage {
+    market_id?: string;
+    leverage: string;
+}
+export interface Pool {
+    pool: {
+        creator: string;
+        id: number;
+        name: string;
+        denom: string;
+        denom_a: string;
+        amount_a: string;
+        weight_a: string;
+        denom_b: string;
+        amount_b: string;
+        weight_b: string;
+        swap_fee: string;
+        shares_amount: string;
+        amp_bps: string;
+        v_amount_a: string;
+        v_amount_b: string;
+        is_deprecated?: boolean;
+    };
+    rewards_weight: string;
+    total_commitment: string;
+}
+export interface Commitment {
+    denom: string;
+    amount: string;
+    start_time: string;
+    end_time: string;
+    duration?: number;
+    is_locked: boolean;
+    commitment_power: string;
+    boost_factor: string;
+}
+export interface CommitmentEvent extends Commitment {
+    Type?: string;
+}
+export interface TokenPrice {
+    denom: string;
+    index: string;
+    index_updated_at: string;
+    twap: string;
+}
+export interface CDPParams {
+    interest_fee: string;
+    liquidation_fee: string;
+    stablecoin_interest_rate: string;
+    stablecoin_mint_cap: string;
+    complete_liquidation_threshold: string;
+    minimum_close_factor: string;
+    small_liquidation_size: string;
+    stale_price_grace_period: string;
+    cdp_paused: boolean;
+    stablecoin_interest_rate_epoch: string;
+    stablecoin_interest_rate_adjuster_coefficient?: string;
+}
+export interface StablecoinInterestInfo {
+    last_updated_time: string;
+    stablecoin_interest_rate: string;
+}
+export interface RateStrategy {
+    name: string;
+    optimal_usage: string;
+    base_variable_borrow_rate: string;
+    variable_rate_slope_1: string;
+    variable_rate_slope_2: string;
+    base_stable_borrow_rate: string;
+    stable_rate_slope_1: string;
+    stable_rate_slope_2: string;
+    optimal_stable_to_total_debt_ratio: string;
+}
+/**
+ * @deprecated old websocket response struct for get_cdp_assets_all
+ * use AssetParams instead
+ */
+export interface Asset {
+    asset_params: {
+        denom: string;
+        oracle_id: string;
+        rate_strategy_name: string;
+        loan_to_value: string;
+        liquidation_threshold: string;
+        liquidation_bonus: string;
+        supply_cap: string;
+        borrow_cap: string;
+    };
+    asset_utilization: {
+        denom: string;
+        total_borrowed: string;
+        total_amount: string;
+        utilization_rate: string;
+    };
+}
+export interface AssetParams {
+    denom: string;
+    oracle_id: string;
+    rate_strategy_name: string;
+    allow_repay_stablecoin_interest_debt: boolean;
+    loan_to_value: string;
+    liquidation_threshold: string;
+    liquidation_discount: string;
+    supply_cap: string;
+    borrow_cap: string;
+}
+export interface Collateral {
+    cibt_denom: string;
+    denom: string;
+    collateral_amount: string;
+}
+export interface Debt {
+    denom: string;
+    principal: string;
+    initial_cumulative_interest_multiplier: string;
+}
+export interface AccountData {
+    total_collaterals_usd: string;
+    total_debts_usd: string;
+    available_borrows_usd: string;
+    curr_liquidation_threshold: string;
+    health_factor: string;
+}
+export interface CDPAccountStablecoin {
+    principal: string;
+    interest_debt: string;
+    initial_cumulative_interest_multiplier: string;
+}
+/**
+ * Response for get_cdp_total_borrows and get_cdp_borrows
+ * Do not confuse with Debt
+ */
+export interface CDPBorrow {
+    address: string;
+    amount: string;
+    denom: string;
+    type: string;
+    initial_cumulative_interest_multiplier?: string;
+}
+/**
+ * Response for get_cdp_total_collaterals and get_cdp_collaterals
+ * Do not confuse with Collateral
+ */
+export interface CDPCollateral {
+    address: string;
+    amount: string;
+    denom: string;
+}
+export interface CDPDebtInfo {
+    denom: string;
+    last_updated_time: string;
+    total_principal: string;
+    cumulative_interest_multiplier: string;
+    total_accumulated_interest: string;
+    utilization_rate: string;
+}
+export interface CDPStableCoinDebtInfo {
+    denom: string;
+    last_updated_time: string;
+    total_principal: string;
+    cumulative_interest_multiplier: string;
+    total_accumulated_interest: string;
+}
+export interface CDPLiquidation {
+    liquidator: string;
+    debtor: string;
+    collateral_denom: string;
+    collateral_amount_liquidated: string;
+    collateral_amount_liquidator: string;
+    collateral_amount_fee: string;
+    liquidation_price: string;
+    market_price: string;
+    discount: string;
+    debt_denom: string;
+    debt_amount: string;
+    block_height: number;
+    block_time: string;
+    transaction_hash: string;
+}
+export interface RewardScheme {
+    id: number;
+    creator: string;
+    reward_denom: string;
+    asset_denom: string;
+    reward_type: string;
+    reward_amount_per_second: string;
+    start_time: string;
+    end_time: string;
+    reward_per_share_last_updated_at: string;
+    reward_per_share: string;
+}
+export interface RewardDebt {
+    user_address: string;
+    reward_scheme_id: number;
+    reward_debt: string;
+    last_updated_at: string;
+}
+export interface CDPTokenSupply {
+    cibt_denom: string;
+    amount: string;
+}

package/lib/websocket/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/websocket/types.d.ts

@@ -0,0 +1,154 @@
+export declare enum WSChannel {
+    candlesticks = "candlesticks",
+    books = "books",
+    recent_trades = "recent_trades",
+    orders = "orders",
+    orders_by_market = "orders_by_market",
+    balances = "balances",
+    account_trades = "account_trades",
+    account_trades_by_market = "account_trades_by_market",
+    market_stats = "market_stats",
+    market_stats_by_market = "market_stats_by_market",
+    leverages = "leverages",
+    leverages_by_market = "leverages_by_market",
+    positions = "positions",
+    positions_by_market = "positions_by_market",
+    pools = "pools",
+    pools_by_id = "pools_by_id",
+    token_prices = "token_prices",
+    token_prices_by_denom = "token_prices_by_denom",
+    commitments = "commitments",
+    token_supply_by_denom = "token_supply_by_denom",
+    market_liquidity_usage_multiplier = "market_liquidity_usage_multiplier"
+}
+export declare enum WSRequest {
+    MarketStats = "get_market_stats",
+    OrderHistory = "get_order_history",
+    RecentTrades = "get_recent_trades",
+    Candlesticks = "get_candlesticks",
+    OpenOrders = "get_open_orders",
+    AccountTrades = "get_account_trades",
+    Leverages = "get_leverages",
+    Positions = "get_positions",
+    OpenPositions = "get_open_positions",
+    ClosedPosition = "get_closed_positions",
+    Balances = "get_balances",
+    OrderBook = "get_orderbook",
+    Pools = "get_pools",
+    Commitments = "get_commitments"
+}
+export interface WsGetRecentTradesParams {
+    market_id: string;
+}
+export interface WsGetCandlesticksParams {
+    market_id: string;
+    resolution: string;
+    from?: string;
+    to?: string;
+}
+export interface WsGetOrderHistoryParams {
+    market_id: string;
+    address: string;
+}
+export interface WsGetOpenOrdersParams {
+    market_id: string;
+    address: string;
+}
+export interface WsGetAccountTradesParams {
+    market_id: string;
+    address: string;
+    page?: number;
+}
+export interface WsGetMarketStatsParams {
+    market_id: string;
+}
+export interface WsGetLeveragesParams {
+    market_id: string;
+    address: string;
+}
+export interface WsGetPositionsParams {
+    market_id: string;
+    address: string;
+    status?: string;
+    order_by?: string;
+    pagination?: {
+        page?: string;
+        page_size?: string;
+    };
+}
+export interface WsGetCommitmentsParams {
+    address: string;
+}
+export interface WsSubscribeParams {
+    channel: WSChannel;
+}
+export interface WsSubscribeCandlesticksParams extends WsSubscribeParams {
+    market_id: string;
+    resolution: string;
+    subscribeUID: string;
+}
+export interface WsSubscribeBooksParams extends WsSubscribeParams {
+    market_id: string;
+}
+export interface WsSubscribeRecentTradesParams extends WsSubscribeParams {
+    market_id: string;
+}
+export interface WsSubscribeOrdersAllParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsSubscribeOrdersByMarketParams extends WsSubscribeParams {
+    market_id: string;
+    address: string;
+}
+export interface WsSubscribeWalletBalanceParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsSubscribeAccountTradesAllParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsSubscribeAccountTradesByMarketParams extends WsSubscribeParams {
+    market_id: string;
+    address: string;
+}
+export interface WsSubscribeMarketStatsAllParams extends WsSubscribeParams {
+}
+export interface WsSubscribeMarketStatsByMarketParams extends WsSubscribeParams {
+    market_id: string;
+}
+export interface WsSubscribeLeveragesAllParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsSubscribeLeveragesByMarketParams extends WsSubscribeParams {
+    market_id: string;
+    address: string;
+}
+export interface WsSubscribePositionsAllParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsSubscribePositionsByMarketParams extends WsSubscribeParams {
+    market_id: string;
+    address: string;
+}
+export interface WsSubscribePoolsAllParams extends WsSubscribeParams {
+}
+export interface WsSubscribePoolsByIdParams extends WsSubscribeParams {
+    id: string;
+}
+export interface WsSubscribeCommitmentParams extends WsSubscribeParams {
+    address: string;
+}
+export interface WsUnsubscribeCandlesticksParams extends WsSubscribeParams {
+    market_id: string;
+    resolution: string;
+}
+export interface WsSubscribeTokenPrices extends WsSubscribeParams {
+    denom: string;
+}
+export interface WsSubscribeAllTokenPrices extends WsSubscribeParams {
+}
+export interface WsSubscribeTokenSupplyByDenom extends WsSubscribeParams {
+    denom: string;
+}
+export interface WsSubscribeMarketLiquidityUsageMultiplier extends WsSubscribeParams {
+}
+export type WsSubscriptionParams = WsSubscribeCandlesticksParams | WsSubscribeBooksParams | WsSubscribeRecentTradesParams | WsSubscribeOrdersAllParams | WsSubscribeOrdersByMarketParams | WsSubscribeWalletBalanceParams | WsSubscribeAccountTradesAllParams | WsSubscribeAccountTradesByMarketParams | WsSubscribeMarketStatsAllParams | WsSubscribeMarketStatsByMarketParams | WsSubscribeLeveragesAllParams | WsSubscribeLeveragesByMarketParams | WsSubscribePositionsAllParams | WsSubscribePositionsByMarketParams | WsSubscribePoolsAllParams | WsSubscribePoolsByIdParams | WsSubscribeTokenPrices | WsSubscribeAllTokenPrices | WsSubscribeCommitmentParams | WsUnsubscribeCandlesticksParams | WsSubscribeTokenSupplyByDenom | WsSubscribeMarketLiquidityUsageMultiplier;

package/lib/websocket/types.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WSRequest = exports.WSChannel = void 0;
+var WSChannel;
+(function (WSChannel) {
+    WSChannel["candlesticks"] = "candlesticks";
+    WSChannel["books"] = "books";
+    WSChannel["recent_trades"] = "recent_trades";
+    WSChannel["orders"] = "orders";
+    WSChannel["orders_by_market"] = "orders_by_market";
+    WSChannel["balances"] = "balances";
+    WSChannel["account_trades"] = "account_trades";
+    WSChannel["account_trades_by_market"] = "account_trades_by_market";
+    WSChannel["market_stats"] = "market_stats";
+    WSChannel["market_stats_by_market"] = "market_stats_by_market";
+    WSChannel["leverages"] = "leverages";
+    WSChannel["leverages_by_market"] = "leverages_by_market";
+    WSChannel["positions"] = "positions";
+    WSChannel["positions_by_market"] = "positions_by_market";
+    WSChannel["pools"] = "pools";
+    WSChannel["pools_by_id"] = "pools_by_id";
+    WSChannel["token_prices"] = "token_prices";
+    WSChannel["token_prices_by_denom"] = "token_prices_by_denom";
+    WSChannel["commitments"] = "commitments";
+    WSChannel["token_supply_by_denom"] = "token_supply_by_denom";
+    WSChannel["market_liquidity_usage_multiplier"] = "market_liquidity_usage_multiplier";
+})(WSChannel || (exports.WSChannel = WSChannel = {}));
+var WSRequest;
+(function (WSRequest) {
+    WSRequest["MarketStats"] = "get_market_stats";
+    WSRequest["OrderHistory"] = "get_order_history";
+    WSRequest["RecentTrades"] = "get_recent_trades";
+    WSRequest["Candlesticks"] = "get_candlesticks";
+    WSRequest["OpenOrders"] = "get_open_orders";
+    WSRequest["AccountTrades"] = "get_account_trades";
+    WSRequest["Leverages"] = "get_leverages";
+    WSRequest["Positions"] = "get_positions";
+    WSRequest["OpenPositions"] = "get_open_positions";
+    WSRequest["ClosedPosition"] = "get_closed_positions";
+    WSRequest["Balances"] = "get_balances";
+    WSRequest["OrderBook"] = "get_orderbook";
+    WSRequest["Pools"] = "get_pools";
+    WSRequest["Commitments"] = "get_commitments";
+})(WSRequest || (exports.WSRequest = WSRequest = {}));

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "example-js-sdk",
+  "version": "0.0.1",
+  "description": "TypeScript SDK for Carbon blockchain",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "watch": "nodemon yarn build",
+    "build": "yarn run lint && tsc && tsc-alias",
+    "cp-proto": "cp ~/go/src/github.com/mememax/orbix/gen/proto-ts.tar.gz .",
+    "sync-proto": "sh scripts/update-proto.sh",
+    "sync-register": "yarn sync-reset && sh scripts/generate-registry.sh",
+    "sync-reset": "find . -type f -name 'export.ts' -delete && rm -f src/codec/*-models.ts",
+    "test": "tsc && node lib/test.js",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint . --ext .ts",
+    "prepare": "rm -rf ./lib && yarn run build",
+    "prepublishOnly": "yarn run lint",
+    "preversion": "yarn run lint",
+    "version": "yarn run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "ws": "^7.4.6"
+  },
+  "nodemonConfig": {
+    "delay": 500,
+    "ext": "ts, css, js, json",
+    "watch": [
+      "./src",
+      "./package.json"
+    ]
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "dependencies": {
+    "@cityofzion/neon-api": "^4.9.0",
+    "@cityofzion/neon-core": "^4.9.0",
+    "@cityofzion/neon-core-next": "npm:@cityofzion/neon-core@^5.0.0",
+    "@cityofzion/neon-js": "^4.9.0",
+    "@cosmjs/stargate": "0.32.4",
+    "@cosmos-kit/leap": "^0.15.12",
+    "@improbable-eng/grpc-web": "^0.15.0",
+    "@improbable-eng/grpc-web-node-http-transport": "^0.15.0",
+    "@keplr-wallet/types": "^0.12.207",
+    "@ledgerhq/hw-transport-webhid": "^6.20.0",
+    "@ledgerhq/hw-transport-webusb": "^6.20.0",
+    "@metamask/detect-provider": "^2.0.0",
+    "base58check": "^2.0.0",
+    "bignumber.js": "^9.1.0",
+    "bip32": "^2.0.6",
+    "bip39": "^3.0.4",
+    "cosmjs-types": "^0.9.0",
+    "dayjs": "^1.10.5",
+    "eth-sig-util": "^3.0.1",
+    "ethers": "^5.6.0",
+    "eventemitter3": "^5.0.0",
+    "jwt-decode": "^4.0.0",
+    "ledger-cosmos-js": "^2.1.8",
+    "lodash": "^4.17.21",
+    "node-fetch": "^2.6.1",
+    "query-string": "^7.0.1",
+    "secp256k1": "^4.0.2",
+    "secp256r1": "^0.0.3",
+    "semver": "^7.3.7",
+    "tsc-alias": "^1.2.11",
+    "typescript": "^5.8.3",
+    "wif": "^2.0.6"
+  },
+  "devDependencies": {
+    "@ledgerhq/hw-transport-node-hid": "^6.29.5",
+    "@types/lodash": "^4.14.174",
+    "@types/node": "^17.0.6",
+    "@types/node-fetch": "^2.5.12",
+    "@types/ripemd160": "^2.0.0",
+    "@types/secp256k1": "^4.0.2",
+    "@types/semver": "^7.3.13",
+    "@types/w3c-web-hid": "^1.0.2",
+    "@types/w3c-web-usb": "^1.0.5",
+    "@types/websocket": "^1.0.4",
+    "@types/wif": "^2.0.2",
+    "@types/ws": "^7.4.7",
+    "@typescript-eslint/eslint-plugin": "^6.9.0",
+    "@typescript-eslint/parser": "^6.9.0",
+    "dotenv": "^10.0.0",
+    "eslint": "^8.42.0",
+    "prettier": "2.5.1"
+  },
+  "packageManager": "yarn@1.22.19"
+}