@n1xyz/nord-ts 0.1.4 → 0.1.6

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

@@ -1,14 +1,25 @@
+import { PublicKey } from "@solana/web3.js";
 import * as proto from "../../gen/nord_pb";
-import { NordClient } from "./NordClient";
-import type { NordClientParams } from "./NordClient";
-import type { NordUser } from "./NordUser";
+import { Nord } from "./Nord";
+import { FeeTierConfig } from "../../gen/nord_pb";
+export declare enum AclRole {
+    FEE_MANAGER = 1,
+    MARKET_MANAGER = 2,
+    ADMIN = -2147483648
+}
+/**
+ * Parameters required to register a new token via the admin API.
+ */
 export interface CreateTokenParams {
     tokenDecimals: number;
     weightBps: number;
     viewSymbol: string;
     oracleSymbol: string;
-    solAddr: Uint8Array;
+    mintAddr: PublicKey;
 }
+/**
+ * Parameters used when creating a new market.
+ */
 export interface CreateMarketParams {
     sizeDecimals: number;
     priceDecimals: number;
@@ -20,51 +31,229 @@ export interface CreateMarketParams {
     oracleSymbol: string;
     baseTokenId: number;
 }
+/**
+ * Configuration for updating the Wormhole guardian set on the oracle.
+ */
 export interface PythSetWormholeGuardiansParams {
     guardianSetIndex: number;
-    addresses: Uint8Array[];
+    addresses: string[];
 }
+/**
+ * Parameters required to link an oracle symbol to a Pyth price feed.
+ */
 export interface PythSetSymbolFeedParams {
     oracleSymbol: string;
-    priceFeedId: Uint8Array;
+    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;
 }
-export interface NordAdminParams extends NordClientParams {
-    signFn: (message: Uint8Array) => Promise<Uint8Array>;
+/**
+ * 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;
 }
-export declare class NordAdmin extends NordClient {
+/**
+ * Administrative client capable of submitting privileged configuration actions.
+ */
+export declare class NordAdmin {
+    private readonly nord;
+    private readonly admin;
     private readonly signFn;
-    constructor(params: NordAdminParams);
-    clone(): NordAdmin;
-    static fromUser(user: NordUser, adminSignFn: (message: Uint8Array) => Promise<Uint8Array>): NordAdmin;
+    private constructor();
+    /** Create a new admin client.
+     *
+     * @param nord - Nord instance
+     * @param admin - The user that will be signing actions.
+     * @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, admin, signFn, }: Readonly<{
+        nord: Nord;
+        admin: PublicKey;
+        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;
-    createToken(params: CreateTokenParams): Promise<{
+    /** Set acl permissions for a given user.
+     *
+     * If all roles are removed, the user is removed from the acl.
+     *
+     * @param target - User to update.
+     * @param addRoles - Roles to add to the user.
+     * @param removeRoles - Reles to remove from the user.
+     */
+    updateAcl({ target, addRoles, removeRoles, }: Readonly<{
+        target: PublicKey;
+        addRoles: AclRole[];
+        removeRoles: AclRole[];
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_AclUpdated>;
+    /**
+     * 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>;
 }