@n1xyz/nord-ts 0.1.3 → 0.1.5

package/dist/nord/client/Nord.js

@@ -56,11 +56,10 @@ class Nord {
      *
      * @param config - Configuration options for the Nord client
      * @param config.webServerUrl - Base URL for the Nord web server
-     * @param config.bridgeVk - Bridge verification key
      * @param config.solanaUrl - Solana cluster URL
      * @throws {Error} If required configuration is missing
      */
-    constructor({ bridgeVk, solanaUrl, webServerUrl, protonClient, }) {
+    constructor({ solanaUrl, webServerUrl, protonClient, }) {
         /** Available markets */
         this.markets = [];
         /** Available tokens */
@@ -68,7 +67,6 @@ class Nord {
         /** Map of symbol to market_id */
         this.symbolToMarketId = new Map();
         this.webServerUrl = webServerUrl;
-        this.bridgeVk = bridgeVk;
         this.solanaUrl = solanaUrl;
         this.protonClient = protonClient;
         this.httpClient = (0, openapi_fetch_1.default)({ baseUrl: webServerUrl });
@@ -179,24 +177,22 @@ class Nord {
      *
      * @param nordConfig - Configuration options for the Nord client
      * @param nordConfig.webServerUrl - Base URL for the Nord web server
-     * @param nordConfig.bridgeVk - Bridge verification key
+     * @param nordConfig.app - App address
      * @param nordConfig.solanaUrl - Solana cluster URL
      * @returns Initialized Nord client
      * @throws {NordError} If initialization fails
      */
-    static async initNord({ bridgeVk: bridgeVk_, solanaUrl, webServerUrl, }) {
+    static async initNord({ app, solanaUrl, webServerUrl, }) {
         // TODO: we should parametrize the connectionn not have it done here.
         // this is a dogshit api, only here to be compatible with the shitty
         // vibecoded code and not break zero one team's workflow.
         const connection = new web3_js_1.Connection(solanaUrl, { commitment: "confirmed" });
-        const bridgeVk = new web3_js_1.PublicKey(bridgeVk_);
         const protonClient = await proton_1.ProtonClient.init({
             protonUrl: webServerUrl,
-            bridgeVk,
+            app: new web3_js_1.PublicKey(app),
             solConn: connection,
         });
         const nord = new Nord({
-            bridgeVk,
             protonClient,
             solanaUrl,
             webServerUrl,
@@ -488,6 +484,29 @@ class Nord {
     async getInfo() {
         return await this.GET("/info", {});
     }
+    /**
+     * Fetch the current fee tier brackets configured on Nord.
+     *
+     * @returns Array of fee tier identifiers paired with their configuration
+     * @throws {NordError} If the request fails
+     */
+    async getFeeBrackets() {
+        return await this.GET("/fee/brackets/info", {});
+    }
+    /**
+     * Retrieve the fee tier assigned to a specific account.
+     *
+     * @param accountId - Account identifier to query
+     * @returns Fee tier details for the requested account
+     * @throws {NordError} If the request fails
+     */
+    async getAccountFeeTier(accountId) {
+        return await this.GET("/account/{account_id}/fee/tier", {
+            params: {
+                path: { account_id: accountId },
+            },
+        });
+    }
     /**
      * Get account information
      *
@@ -502,6 +521,66 @@ class Nord {
             },
         });
     }
+    /**
+     * Get the public key associated with an account id.
+     *
+     * @param accountId - Account id to query
+     * @returns Base58-encoded account public key
+     * @throws {NordError} If the request fails
+     */
+    async getAccountPubkey(accountId) {
+        return await this.GET("/account/{account_id}/pubkey", {
+            params: {
+                path: { account_id: accountId },
+            },
+        });
+    }
+    /**
+     * Get the withdrawal fee charged for an account.
+     *
+     * @param accountId - Account id to query
+     * @returns Withdrawal fee quoted in quote token units
+     * @throws {NordError} If the request fails
+     */
+    async getAccountWithdrawalFee(accountId) {
+        return await this.GET("/account/{account_id}/fees/withdrawal", {
+            params: {
+                path: { account_id: accountId },
+            },
+        });
+    }
+    /**
+     * Get open orders for an account.
+     *
+     * @param accountId - Account id to query
+     * @param query - Optional pagination parameters
+     * @returns Page of orders keyed by client order id
+     * @throws {NordError} If the request fails
+     */
+    async getAccountOrders(accountId, query) {
+        return await this.GET("/account/{account_id}/orders", {
+            params: {
+                path: { account_id: accountId },
+                query: {
+                    startInclusive: query?.startInclusive,
+                    pageSize: query?.pageSize,
+                },
+            },
+        });
+    }
+    /**
+     * List account fee tiers with pagination support.
+     */
+    async getAccountsFeeTiers(query) {
+        return await this.GET("/accounts/fee-tiers", {
+            params: {
+                query: {
+                    startInclusive: query?.startInclusive ?? undefined,
+                    pageSize: query?.pageSize ?? undefined,
+                },
+            },
+        });
+    }
     /**
      * Get profit and loss history for an account
      *
@@ -535,6 +614,71 @@ class Nord {
             },
         });
     }
+    /**
+     * Fetch the per-market fee quote for an account.
+     *
+     * @param params - Market id, fee kind, and account id to quote
+     * @returns Fee in quote token units (negative means fee is charged)
+     * @throws {NordError} If the request fails
+     */
+    async getMarketFee({ marketId, feeKind, accountId, }) {
+        return await this.GET("/market/{market_id}/fees/{fee_kind}/{account_id}", {
+            params: {
+                path: {
+                    market_id: marketId,
+                    fee_kind: feeKind,
+                    account_id: accountId,
+                },
+            },
+        });
+    }
+    /**
+     * Fetch token statistics such as index price and oracle metadata.
+     *
+     * @param tokenId - Token identifier
+     * @returns Token stats
+     * @throws {NordError} If the request fails
+     */
+    async getTokenStats(tokenId) {
+        return await this.GET("/tokens/{token_id}/stats", {
+            params: {
+                path: { token_id: tokenId },
+            },
+        });
+    }
+    /**
+     * Get order summary by order id.
+     *
+     * @param orderId - Order identifier
+     * @returns Order information
+     * @throws {NordError} If the request fails
+     */
+    async getOrder(orderId) {
+        return await this.GET("/order/{order_id}", {
+            params: {
+                path: { order_id: orderId },
+            },
+        });
+    }
+    /**
+     * Get trade history for a specific order.
+     *
+     * @param orderId - Order identifier
+     * @param query - Optional pagination parameters
+     * @returns Page of trades associated with the order
+     * @throws {NordError} If the request fails
+     */
+    async getOrderTrades(orderId, query) {
+        return await this.GET("/order/{order_id}/trades", {
+            params: {
+                path: { order_id: orderId },
+                query: {
+                    startInclusive: query?.startInclusive,
+                    pageSize: query?.pageSize,
+                },
+            },
+        });
+    }
     /**
      * Check if an account exists for the given address
      *
@@ -545,5 +689,59 @@ class Nord {
     async accountExists(pubkey) {
         return !!(await this.getUser({ pubkey }));
     }
+    /**
+     * Fetch active triggers for an account.
+     *
+     * @param params Optional parameters containing an explicit account id.
+     * @throws {NordError} If no account can be resolved or the request fails.
+     */
+    async getAccountTriggers(params) {
+        const accountId = params?.accountId;
+        if (accountId == null) {
+            throw new NordError_1.NordError("Account ID is undefined. Make sure to call updateAccountId() before requesting triggers.");
+        }
+        try {
+            const triggers = await this.GET("/account/{account_id}/triggers", {
+                params: {
+                    path: { account_id: accountId },
+                },
+            });
+            return triggers ?? [];
+        }
+        catch (error) {
+            throw new NordError_1.NordError("Failed to fetch account triggers", { cause: error });
+        }
+    }
+    /**
+     * Fetch trigger history for an account.
+     *
+     * @param params Optional parameters with account id and history query filters.
+     * @throws {NordError} If no account can be resolved or the request fails.
+     */
+    async getAccountTriggerHistory(params) {
+        const accountId = params?.accountId;
+        if (accountId == null) {
+            throw new NordError_1.NordError("Account ID is undefined. Make sure to call updateAccountId() before requesting trigger history.");
+        }
+        const { accountId: _, ...query } = params;
+        try {
+            return await this.GET("/account/{account_id}/triggers/history", {
+                params: {
+                    path: { account_id: accountId },
+                    query: {
+                        since: query.since,
+                        until: query.until,
+                        pageSize: query.pageSize,
+                        startInclusive: query.startInclusive,
+                    },
+                },
+            });
+        }
+        catch (error) {
+            throw new NordError_1.NordError("Failed to fetch account trigger history", {
+                cause: error,
+            });
+        }
+    }
 }
 exports.Nord = Nord;

package/dist/nord/client/NordAdmin.d.ts

@@ -0,0 +1,236 @@
+import { PublicKey } from "@solana/web3.js";
+import * as proto from "../../gen/nord_pb";
+import { Nord } from "./Nord";
+import { FeeTierConfig } from "../../gen/nord_pb";
+/**
+ * Parameters required to register a new token via the admin API.
+ */
+export interface CreateTokenParams {
+    tokenDecimals: number;
+    weightBps: number;
+    viewSymbol: string;
+    oracleSymbol: string;
+    mintAddr: PublicKey;
+}
+/**
+ * Parameters used when creating a new market.
+ */
+export interface CreateMarketParams {
+    sizeDecimals: number;
+    priceDecimals: number;
+    imfBps: number;
+    cmfBps: number;
+    mmfBps: number;
+    marketType: proto.MarketType;
+    viewSymbol: string;
+    oracleSymbol: string;
+    baseTokenId: number;
+}
+/**
+ * Configuration for updating the Wormhole guardian set on the oracle.
+ */
+export interface PythSetWormholeGuardiansParams {
+    guardianSetIndex: number;
+    addresses: string[];
+}
+/**
+ * Parameters required to link an oracle symbol to a Pyth price feed.
+ */
+export interface PythSetSymbolFeedParams {
+    oracleSymbol: string;
+    priceFeedId: string;
+}
+/**
+ * Identifies a market that should be frozen.
+ */
+export interface FreezeMarketParams {
+    marketId: number;
+}
+/**
+ * Identifies a market that should be unfrozen.
+ */
+export interface UnfreezeMarketParams {
+    marketId: number;
+}
+/**
+ * Parameters for adding a new fee tier.
+ */
+export interface AddFeeTierParams {
+    config: FeeTierConfig;
+}
+/**
+ * Parameters for updating an existing fee tier.
+ */
+export interface UpdateFeeTierParams {
+    tierId: number;
+    config: FeeTierConfig;
+}
+/**
+ * Administrative client capable of submitting privileged configuration actions.
+ */
+export declare class NordAdmin {
+    private readonly nord;
+    private readonly signFn;
+    private constructor();
+    /** Create a new admin client.
+     *
+     * @param nord - Nord instance
+     * @param signFn - Function to sign messages with the admin's wallet.
+     *
+     * `signFn` must sign the _hex-encoded_ message, not the raw message itself, for
+     * the purpose of being compatible with Solana wallets.
+     *
+     * In practice, you will do something along the lines of:
+     *
+     * ```typescript
+     * (x) => wallet.signMessage(new TextEncoder().encode(x.toHex()));
+     * ```
+     *
+     * For a software signing key, this might look more like:
+     *
+     * ```typescript
+     * (x) => nacl.sign.detached(new TextEncoder().encode(x.toHex()), sk);
+     * ``
+     *
+     * where `nacl` is the tweetnacl library.
+     */
+    static new({ nord, signFn, }: Readonly<{
+        nord: Nord;
+        signFn: (m: Uint8Array) => Promise<Uint8Array>;
+    }>): NordAdmin;
+    /**
+     * Submit an action and append the admin signature before sending it to Nord.
+     *
+     * @param kind - Action payload describing the admin request
+     * @throws {NordError} If signing or submission fails
+     */
+    private submitAction;
+    /**
+     * Register a new token that can be listed on Nord.
+     *
+     * @param params - Token configuration values
+     * @returns Action identifier and resulting token metadata
+     * @throws {NordError} If the action submission fails
+     */
+    createToken({ tokenDecimals, weightBps, viewSymbol, oracleSymbol, mintAddr, }: CreateTokenParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_InsertTokenResult>;
+    /**
+     * Open a new market with the provided trading parameters.
+     *
+     * @param params - Market configuration to apply
+     * @returns Action identifier and resulting market metadata
+     * @throws {NordError} If the action submission fails
+     */
+    createMarket(params: CreateMarketParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_InsertMarketResult>;
+    /**
+     * Update the Pyth guardian set used for verifying Wormhole messages.
+     *
+     * Each address must decode from a 20-byte hex string (with or without a
+     * leading `0x` prefix). The engine validates the supplied guardian set index
+     * before applying the update.
+     *
+     * @param params - Guardian set index and guardian addresses
+     * @returns Action identifier and guardian update receipt
+     * @throws {NordError} If the action submission fails
+     */
+    pythSetWormholeGuardians(params: PythSetWormholeGuardiansParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_UpdateGuardianSetResult>;
+    /**
+     * Link an oracle symbol to a specific Pyth price feed.
+     *
+     * The price feed identifier must decode to 32 bytes (with or without a
+     * leading `0x` prefix). Use this call to create or update the mapping used
+     * by the oracle integration.
+     *
+     * @param params - Oracle symbol and price feed identifier
+     * @returns Action identifier and symbol feed receipt
+     * @throws {NordError} If the action submission fails
+     */
+    pythSetSymbolFeed(params: PythSetSymbolFeedParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_OracleSymbolFeedResult>;
+    /**
+     * Pause all trading activity on the exchange.
+     *
+     * @returns Action identifier confirming the pause
+     * @throws {NordError} If the action submission fails
+     */
+    pause(): Promise<{
+        actionId: bigint;
+    }>;
+    /**
+     * Resume trading activity after a pause.
+     *
+     * @returns Action identifier confirming the unpause
+     * @throws {NordError} If the action submission fails
+     */
+    unpause(): Promise<{
+        actionId: bigint;
+    }>;
+    /**
+     * Freeze an individual market, preventing new trades and orders.
+     *
+     * @param params - Target market identifier
+     * @returns Action identifier and freeze receipt
+     * @throws {NordError} If the action submission fails
+     */
+    freezeMarket(params: FreezeMarketParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_MarketFreezeUpdated>;
+    /**
+     * Unfreeze a market that was previously halted.
+     *
+     * @param params - Target market identifier
+     * @returns Action identifier and freeze receipt
+     * @throws {NordError} If the action submission fails
+     */
+    unfreezeMarket(params: UnfreezeMarketParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_MarketFreezeUpdated>;
+    /**
+     * Append a new fee tier to the account bracket configuration.
+     *
+     * - The engine supports at most 16 tiers (ids 0–15). Tier 0 is reserved for
+     *   the default Nord fees; use `updateFeeTier` if you need to change it.
+     * - The first appended tier receives id 1, and subsequent tiers increment the id.
+     *
+     * @param params - Fee tier configuration to insert
+     * @returns Action identifier and fee tier addition receipt
+     * @throws {NordError} If the action submission fails or the new tier exceeds the maximum range (0-15).
+     */
+    addFeeTier(params: AddFeeTierParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_FeeTierAdded>;
+    /**
+     * Update an existing fee tier with new maker/taker rates.
+     *
+     * Tier identifiers must already exist; attempting to update a missing tier
+     * causes the action to fail.
+     *
+     * @param params - Fee tier identifier and updated configuration
+     * @returns Action identifier and fee tier update receipt
+     * @throws {NordError} If the action submission fails or the tier ID exceeds the configured range.
+     */
+    updateFeeTier(params: UpdateFeeTierParams): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_FeeTierUpdated>;
+    /**
+     * Assign a fee tier to one or more accounts.
+     *
+     * The tier id must be within the configured range (0–15). Every account starts
+     * on tier 0; assigning it to another tier requires that tier to exist already.
+     * Invalid account ids or tier ids cause the action to fail.
+     *
+     * @param accounts - Account IDs to update
+     * @param tierId - Target fee tier identifier
+     * @returns Action identifier and accounts-tier receipt
+     * @throws {NordError} If the tier id exceeds the configured range or an account id is invalid.
+     */
+    updateAccountsTier(accounts: number[], tierId: number): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_AccountsTierUpdated>;
+}