@n1xyz/nord-ts 0.1.3 → 0.1.5

package/dist/nord/client/NordAdmin.js

@@ -0,0 +1,337 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NordAdmin = void 0;
+const protobuf_1 = require("@bufbuild/protobuf");
+const proto = __importStar(require("../../gen/nord_pb"));
+const utils_1 = require("../../utils");
+const actions_1 = require("../api/actions");
+const NordError_1 = require("../utils/NordError");
+/**
+ * Administrative client capable of submitting privileged configuration actions.
+ */
+class NordAdmin {
+    constructor({ nord, signFn, }) {
+        this.nord = nord;
+        this.signFn = signFn;
+    }
+    /** 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, }) {
+        return new NordAdmin({
+            nord,
+            signFn,
+        });
+    }
+    /**
+     * 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
+     */
+    async submitAction(kind) {
+        const timestamp = await this.nord.getTimestamp();
+        const action = (0, actions_1.createAction)(timestamp, 0, kind);
+        return (0, actions_1.sendAction)(this.nord.webServerUrl, async (xs) => {
+            const signature = await this.signFn(xs);
+            if (signature.length !== 64) {
+                throw new NordError_1.NordError("invalid signature length; must be 64 bytes");
+            }
+            return Uint8Array.from([...xs, ...signature]);
+        }, action);
+    }
+    /**
+     * 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
+     */
+    async createToken({ tokenDecimals, weightBps, viewSymbol, oracleSymbol, mintAddr, }) {
+        const receipt = await this.submitAction({
+            case: "createToken",
+            value: (0, protobuf_1.create)(proto.Action_CreateTokenSchema, {
+                tokenDecimals,
+                weightBps,
+                viewSymbol,
+                oracleSymbol,
+                solAddr: mintAddr.toBytes(),
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "insertTokenResult", "create token");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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
+     */
+    async createMarket(params) {
+        const receipt = await this.submitAction({
+            case: "createMarket",
+            value: (0, protobuf_1.create)(proto.Action_CreateMarketSchema, {
+                sizeDecimals: params.sizeDecimals,
+                priceDecimals: params.priceDecimals,
+                imfBps: params.imfBps,
+                cmfBps: params.cmfBps,
+                mmfBps: params.mmfBps,
+                marketType: params.marketType,
+                viewSymbol: params.viewSymbol,
+                oracleSymbol: params.oracleSymbol,
+                baseTokenId: params.baseTokenId,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "insertMarketResult", "create market");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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
+     */
+    async pythSetWormholeGuardians(params) {
+        const addresses = params.addresses.map((address) => {
+            try {
+                const decoded = (0, utils_1.decodeHex)(address);
+                if (decoded.length !== 20) {
+                    throw new Error("guardian address must be 20 bytes");
+                }
+                return decoded;
+            }
+            catch (e) {
+                throw new NordError_1.NordError("invalid guardian address; must be a 20 byte hex address", { cause: e });
+            }
+        });
+        const receipt = await this.submitAction({
+            case: "pythSetWormholeGuardians",
+            value: (0, protobuf_1.create)(proto.Action_PythSetWormholeGuardiansSchema, {
+                guardianSetIndex: params.guardianSetIndex,
+                addresses,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "updateGuardianSetResult", "update wormhole guardians");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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
+     */
+    async pythSetSymbolFeed(params) {
+        let priceFeedId;
+        try {
+            priceFeedId = (0, utils_1.decodeHex)(params.priceFeedId);
+            if (priceFeedId.length !== 32) {
+                throw new Error("price feed id must be 32 bytes");
+            }
+        }
+        catch (e) {
+            throw new NordError_1.NordError("invalid price feed id; must be a 32 byte hex id", {
+                cause: e,
+            });
+        }
+        const receipt = await this.submitAction({
+            case: "pythSetSymbolFeed",
+            value: (0, protobuf_1.create)(proto.Action_PythSetSymbolFeedSchema, {
+                oracleSymbol: params.oracleSymbol,
+                priceFeedId,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "oracleSymbolFeedResult", "set symbol feed");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * Pause all trading activity on the exchange.
+     *
+     * @returns Action identifier confirming the pause
+     * @throws {NordError} If the action submission fails
+     */
+    async pause() {
+        const receipt = await this.submitAction({
+            case: "pause",
+            value: (0, protobuf_1.create)(proto.Action_PauseSchema, {}),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "paused", "pause");
+        return { actionId: receipt.actionId };
+    }
+    /**
+     * Resume trading activity after a pause.
+     *
+     * @returns Action identifier confirming the unpause
+     * @throws {NordError} If the action submission fails
+     */
+    async unpause() {
+        const receipt = await this.submitAction({
+            case: "unpause",
+            value: (0, protobuf_1.create)(proto.Action_UnpauseSchema, {}),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "unpaused", "unpause");
+        return { actionId: receipt.actionId };
+    }
+    /**
+     * 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
+     */
+    async freezeMarket(params) {
+        const receipt = await this.submitAction({
+            case: "freezeMarket",
+            value: (0, protobuf_1.create)(proto.Action_FreezeMarketSchema, {
+                marketId: params.marketId,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "marketFreezeUpdated", "freeze market");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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
+     */
+    async unfreezeMarket(params) {
+        const receipt = await this.submitAction({
+            case: "unfreezeMarket",
+            value: (0, protobuf_1.create)(proto.Action_UnfreezeMarketSchema, {
+                marketId: params.marketId,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "marketFreezeUpdated", "unfreeze market");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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).
+     */
+    async addFeeTier(params) {
+        const receipt = await this.submitAction({
+            case: "addFeeTier",
+            value: (0, protobuf_1.create)(proto.Action_AddFeeTierSchema, {
+                config: (0, protobuf_1.create)(proto.FeeTierConfigSchema, params.config),
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "feeTierAdded", "add fee tier");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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.
+     */
+    async updateFeeTier(params) {
+        const receipt = await this.submitAction({
+            case: "updateFeeTier",
+            value: (0, protobuf_1.create)(proto.Action_UpdateFeeTierSchema, {
+                id: params.tierId,
+                config: (0, protobuf_1.create)(proto.FeeTierConfigSchema, params.config),
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "feeTierUpdated", "update fee tier");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+    /**
+     * 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.
+     */
+    async updateAccountsTier(accounts, tierId) {
+        const receipt = await this.submitAction({
+            case: "updateAccountsTier",
+            value: (0, protobuf_1.create)(proto.Action_UpdateAccountsTierSchema, {
+                accounts,
+                tierId,
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "accountsTierUpdated", "update accounts tier");
+        return { actionId: receipt.actionId, ...receipt.kind.value };
+    }
+}
+exports.NordAdmin = NordAdmin;

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

@@ -0,0 +1,33 @@
+import { Connection, PublicKey } from "@solana/web3.js";
+import type { Transaction } from "@solana/web3.js";
+import * as proto from "../../gen/nord_pb";
+import { Nord } from "./Nord";
+export interface NordClientParams {
+    nord: Nord;
+    address: PublicKey;
+    walletSignFn: (message: Uint8Array | string) => Promise<Uint8Array>;
+    sessionSignFn: (message: Uint8Array) => Promise<Uint8Array>;
+    transactionSignFn: <T extends Transaction>(tx: T) => Promise<T>;
+    connection?: Connection;
+    sessionId?: bigint;
+    sessionPubKey: Uint8Array;
+    publicKey: PublicKey;
+}
+export declare abstract class NordClient {
+    readonly nord: Nord;
+    readonly address: PublicKey;
+    readonly walletSignFn: (message: Uint8Array | string) => Promise<Uint8Array>;
+    readonly sessionSignFn: (message: Uint8Array) => Promise<Uint8Array>;
+    readonly transactionSignFn: <T extends Transaction>(tx: T) => Promise<T>;
+    connection: Connection;
+    sessionId?: bigint;
+    sessionPubKey: Uint8Array;
+    publicKey: PublicKey;
+    lastTs: number;
+    protected actionNonce: number;
+    protected constructor(params: NordClientParams);
+    protected submitSignedAction(kind: proto.Action["kind"], makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>): Promise<proto.Receipt>;
+    protected nextActionNonce(): number;
+    protected cloneClientState(target: NordClient): void;
+    getSolanaPublicKey(): PublicKey;
+}

package/dist/nord/client/NordClient.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NordClient = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const actions_1 = require("../api/actions");
+class NordClient {
+    constructor(params) {
+        this.lastTs = 0;
+        this.actionNonce = 0;
+        this.nord = params.nord;
+        this.address = params.address;
+        this.walletSignFn = params.walletSignFn;
+        this.sessionSignFn = params.sessionSignFn;
+        this.transactionSignFn = params.transactionSignFn;
+        this.connection =
+            params.connection ??
+                new web3_js_1.Connection(params.nord.solanaUrl, {
+                    commitment: "confirmed",
+                });
+        this.sessionId = params.sessionId;
+        this.sessionPubKey = new Uint8Array(params.sessionPubKey);
+        this.publicKey = params.publicKey;
+    }
+    async submitSignedAction(kind, makeSignedMessage) {
+        const nonce = this.nextActionNonce();
+        const currentTimestamp = await this.nord.getTimestamp();
+        const action = (0, actions_1.createAction)(currentTimestamp, nonce, kind);
+        return (0, actions_1.sendAction)(this.nord.webServerUrl, makeSignedMessage, action);
+    }
+    nextActionNonce() {
+        return ++this.actionNonce;
+    }
+    cloneClientState(target) {
+        target.connection = this.connection;
+        target.sessionId = this.sessionId;
+        target.sessionPubKey = new Uint8Array(this.sessionPubKey);
+        target.publicKey = this.publicKey;
+        target.lastTs = this.lastTs;
+        target.actionNonce = this.actionNonce;
+    }
+    getSolanaPublicKey() {
+        return this.address;
+    }
+}
+exports.NordClient = NordClient;

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

@@ -3,8 +3,8 @@ import Decimal from "decimal.js";
 import { FillMode, Side, SPLTokenInfo, QuoteSize, TriggerKind } from "../../types";
 import * as proto from "../../gen/nord_pb";
 import { BigIntValue } from "../../utils";
-import type { AccountTriggerInfo, TriggerHistoryPage, HistoryTriggerQuery } from "../api/triggers";
 import { Nord } from "./Nord";
+import { NordClient } from "./NordClient";
 /**
  * Parameters for creating a NordUser instance
  */
@@ -48,6 +48,7 @@ export interface PlaceOrderParams {
     quoteSize?: QuoteSize;
     /** Account ID to place the order from */
     accountId?: number;
+    clientOrderId?: BigIntValue;
 }
 export interface AddTriggerParams {
     marketId: number;
@@ -106,17 +107,7 @@ export interface UserAtomicSubaction {
 /**
  * User class for interacting with the Nord protocol
  */
-export declare class NordUser {
-    /** Nord client instance */
-    readonly nord: Nord;
-    /** User's blockchain address */
-    readonly address: PublicKey;
-    /** Function to sign messages with the user's wallet */
-    readonly walletSignFn: (message: Uint8Array | string) => Promise<Uint8Array>;
-    /** Function to sign messages with the user's session key */
-    readonly sessionSignFn: (message: Uint8Array) => Promise<Uint8Array>;
-    /** Function to sign transactions with the user's wallet */
-    readonly transactionSignFn: <T extends Transaction>(tx: T) => Promise<T>;
+export declare class NordUser extends NordClient {
     /** User balances by token symbol */
     balances: {
         [key: string]: {
@@ -156,18 +147,6 @@ export declare class NordUser {
     };
     /** User's account IDs */
     accountIds?: number[];
-    /** Current session ID */
-    sessionId?: bigint;
-    /** User's public key */
-    publicKey: PublicKey;
-    /** Session public key */
-    sessionPubKey: Uint8Array;
-    /** Last timestamp used */
-    lastTs: number;
-    /** Last nonce used */
-    lastNonce: number;
-    /** Solana connection */
-    connection: Connection;
     /** SPL token information */
     splTokenInfos: SPLTokenInfo[];
     /**
@@ -202,7 +181,7 @@ export declare class NordUser {
      */
     getAssociatedTokenAccount(mint: PublicKey): Promise<PublicKey>;
     /**
-     * Deposit SPL tokens to the bridge
+     * Deposit SPL tokens to the app
      *
      * @param amount - Amount to deposit
      * @param tokenId - Token ID
@@ -213,7 +192,7 @@ export declare class NordUser {
      */
     depositSpl(amount: number, tokenId: number, recipient?: PublicKey): Promise<string>;
     /**
-     * Deposit SPL tokens to the bridge
+     * Deposit SPL tokens to the app
      *
      * @param amount - Amount to deposit
      * @param tokenId - Token ID
@@ -234,6 +213,7 @@ export declare class NordUser {
      * @returns Nonce as number
      */
     getNonce(): number;
+    private submitSessionAction;
     /**
      * Update account IDs for this user
      *
@@ -323,24 +303,6 @@ export declare class NordUser {
     removeTrigger(params: RemoveTriggerParams): Promise<{
         actionId: bigint;
     }>;
-    /**
-     * 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.
-     */
-    getAccountTriggers(params?: {
-        accountId?: number;
-    }): Promise<AccountTriggerInfo[]>;
-    /**
-     * 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.
-     */
-    getAccountTriggerHistory(params: HistoryTriggerQuery & {
-        accountId?: number;
-    }): Promise<TriggerHistoryPage>;
     /**
      * Transfer tokens to another account
      *
@@ -397,10 +359,4 @@ export declare class NordUser {
             [symbol: string]: string;
         };
     }>;
-    /**
-     * Get the Solana public key derived from the address
-     *
-     * @returns The Solana public key
-     */
-    getSolanaPublicKey(): PublicKey;
 }