@n1xyz/nord-ts 0.1.6 → 0.1.8

package/dist/{nord/client → client}/NordAdmin.d.ts

@@ -1,74 +1,11 @@
-import { PublicKey } from "@solana/web3.js";
-import * as proto from "../../gen/nord_pb";
+import { PublicKey, Transaction } from "@solana/web3.js";
+import * as proto from "../gen/nord_pb";
 import { Nord } from "./Nord";
-import { FeeTierConfig } from "../../gen/nord_pb";
+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;
-    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;
+    ADMIN = 2147483648
 }
 /**
  * Administrative client capable of submitting privileged configuration actions.
@@ -83,29 +20,12 @@ export declare class NordAdmin {
      * @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;
+        signFn: (m: Transaction) => Promise<Transaction>;
+    }>): Promise<NordAdmin>;
     /**
      * Submit an action and append the admin signature before sending it to Nord.
      *
@@ -131,21 +51,49 @@ export declare class NordAdmin {
     /**
      * Register a new token that can be listed on Nord.
      *
-     * @param params - Token configuration values
+     * @param tokenDecimals - Decimal shift used when parsing deposits/withdrawals
+     * @param weightBps - Risk weight in basis points applied in account value calculations
+     * @param viewSymbol - Symbol surfaced to Nord clients
+     * @param oracleSymbol - Symbol resolved by the oracle adapter
+     * @param mintAddr - Solana mint backing this token
      * @returns Action identifier and resulting token metadata
      * @throws {NordError} If the action submission fails
      */
-    createToken({ tokenDecimals, weightBps, viewSymbol, oracleSymbol, mintAddr, }: CreateTokenParams): Promise<{
+    createToken({ tokenDecimals, weightBps, viewSymbol, oracleSymbol, mintAddr, }: Readonly<{
+        tokenDecimals: number;
+        weightBps: number;
+        viewSymbol: string;
+        oracleSymbol: string;
+        mintAddr: PublicKey;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_InsertTokenResult>;
     /**
      * Open a new market with the provided trading parameters.
      *
-     * @param params - Market configuration to apply
+     * @param sizeDecimals - Decimal shift for contract sizes
+     * @param priceDecimals - Decimal shift for price ticks
+     * @param imfBps - Base initial margin fraction (IMF) in basis points, see docs/MARKETS.md
+     * @param cmfBps - Cancel margin fraction (CMF) in basis points, see docs/MARKETS.md
+     * @param mmfBps - Maintenance margin fraction (MMF) in basis points, see docs/MARKETS.md
+     * @param marketType - Spot or perpetual market type
+     * @param viewSymbol - Symbol exposed to Nord clients
+     * @param oracleSymbol - Symbol resolved by the oracle adapter
+     * @param baseTokenId - Registered base token backing this market
      * @returns Action identifier and resulting market metadata
      * @throws {NordError} If the action submission fails
      */
-    createMarket(params: CreateMarketParams): Promise<{
+    createMarket({ sizeDecimals, priceDecimals, imfBps, cmfBps, mmfBps, marketType, viewSymbol, oracleSymbol, baseTokenId, }: Readonly<{
+        sizeDecimals: number;
+        priceDecimals: number;
+        imfBps: number;
+        cmfBps: number;
+        mmfBps: number;
+        marketType: proto.MarketType;
+        viewSymbol: string;
+        oracleSymbol: string;
+        baseTokenId: number;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_InsertMarketResult>;
     /**
@@ -155,11 +103,15 @@ export declare class NordAdmin {
      * leading `0x` prefix). The engine validates the supplied guardian set index
      * before applying the update.
      *
-     * @param params - Guardian set index and guardian addresses
+     * @param guardianSetIndex - Wormhole guardian set index that must already exist
+     * @param addresses - 20-byte hex-encoded guardian addresses
      * @returns Action identifier and guardian update receipt
      * @throws {NordError} If the action submission fails
      */
-    pythSetWormholeGuardians(params: PythSetWormholeGuardiansParams): Promise<{
+    pythSetWormholeGuardians({ guardianSetIndex, addresses, }: Readonly<{
+        guardianSetIndex: number;
+        addresses: readonly string[];
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_UpdateGuardianSetResult>;
     /**
@@ -169,11 +121,15 @@ export declare class NordAdmin {
      * 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
+     * @param oracleSymbol - Symbol resolved by the oracle adapter
+     * @param priceFeedId - 32-byte hex-encoded Pyth price feed identifier
      * @returns Action identifier and symbol feed receipt
      * @throws {NordError} If the action submission fails
      */
-    pythSetSymbolFeed(params: PythSetSymbolFeedParams): Promise<{
+    pythSetSymbolFeed({ oracleSymbol, priceFeedId: priceFeedIdHex, }: Readonly<{
+        oracleSymbol: string;
+        priceFeedId: string;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_OracleSymbolFeedResult>;
     /**
@@ -197,21 +153,25 @@ export declare class NordAdmin {
     /**
      * Freeze an individual market, preventing new trades and orders.
      *
-     * @param params - Target market identifier
+     * @param marketId - Target market identifier
      * @returns Action identifier and freeze receipt
      * @throws {NordError} If the action submission fails
      */
-    freezeMarket(params: FreezeMarketParams): Promise<{
+    freezeMarket({ marketId, }: Readonly<{
+        marketId: number;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_MarketFreezeUpdated>;
     /**
      * Unfreeze a market that was previously halted.
      *
-     * @param params - Target market identifier
+     * @param marketId - Target market identifier
      * @returns Action identifier and freeze receipt
      * @throws {NordError} If the action submission fails
      */
-    unfreezeMarket(params: UnfreezeMarketParams): Promise<{
+    unfreezeMarket({ marketId, }: Readonly<{
+        marketId: number;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_MarketFreezeUpdated>;
     /**
@@ -221,11 +181,13 @@ export declare class NordAdmin {
      *   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
+     * @param config - 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<{
+    addFeeTier({ config, }: Readonly<{
+        config: FeeTierConfig;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_FeeTierAdded>;
     /**
@@ -234,11 +196,15 @@ export declare class NordAdmin {
      * Tier identifiers must already exist; attempting to update a missing tier
      * causes the action to fail.
      *
-     * @param params - Fee tier identifier and updated configuration
+     * @param tierId - Existing fee tier identifier to update
+     * @param config - Replacement configuration for the tier
      * @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<{
+    updateFeeTier({ tierId, config, }: Readonly<{
+        tierId: number;
+        config: FeeTierConfig;
+    }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_FeeTierUpdated>;
     /**