@n1xyz/nord-ts 0.2.0 → 0.3.2

package/dist/client/NordAdmin.js

@@ -1,362 +0,0 @@
-import { create } from "@bufbuild/protobuf";
-import * as proto from "../gen/nord_pb";
-import { decodeHex, signAdminPayload } from "../utils";
-import { createAction, sendAction, expectReceiptKind } from "../actions";
-import { NordError } from "../error";
-// NOTE: keep in sync with `acl.rs`.
-export var AclRole;
-(function (AclRole) {
-    // note: use 2 ** n instead of 1 << n since js internally
-    // casts number to a signed int for bitwise ops. when merging
-    // these roles, make sure to use += instead of |=. this will
-    // only work when the roles are powers of two.
-    AclRole[AclRole["FEE_MANAGER"] = 1] = "FEE_MANAGER";
-    AclRole[AclRole["MARKET_MANAGER"] = 2] = "MARKET_MANAGER";
-    AclRole[AclRole["ADMIN"] = 2147483648] = "ADMIN";
-})(AclRole || (AclRole = {}));
-/**
- * Administrative client capable of submitting privileged configuration actions.
- */
-export class NordAdmin {
-    nord;
-    admin;
-    signFn;
-    constructor({ nord, admin, signFn, }) {
-        this.nord = nord;
-        this.admin = admin;
-        this.signFn = signFn;
-    }
-    /** 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.
-     */
-    static async new({ nord, admin, signFn, }) {
-        return new NordAdmin({
-            nord,
-            admin,
-            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 = createAction(timestamp, 0, kind);
-        return sendAction(this.nord.httpClient, async (xs) => {
-            const signature = await signAdminPayload({
-                payload: xs,
-                user: this.admin,
-                signTransaction: this.signFn,
-            });
-            return Uint8Array.from([...xs, ...signature]);
-        }, action);
-    }
-    /** 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.
-     */
-    async updateAcl({ target, addRoles, removeRoles, }) {
-        const allRoles = addRoles.concat(removeRoles);
-        if (allRoles.length !== new Set(allRoles).size) {
-            throw new NordError("duplicate roles in acl update; must be unique");
-        }
-        let mask = 0;
-        let values = 0;
-        // using += instead of |= to avoid the internal cast to i32 >:(
-        // this works because our roles are powers of two.
-        for (const role of allRoles)
-            mask += role;
-        for (const role of addRoles)
-            values += role;
-        const receipt = await this.submitAction({
-            case: "updateAcl",
-            value: create(proto.Action_UpdateAclSchema, {
-                aclPubkey: this.admin.toBytes(),
-                targetPubkey: target.toBytes(),
-                rolesValue: values,
-                rolesMask: mask,
-            }),
-        });
-        expectReceiptKind(receipt, "aclUpdated", "update acl");
-        return { ...receipt.kind.value, actionId: receipt.actionId };
-    }
-    /**
-     * Register a new token that can be listed on Nord.
-     *
-     * @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
-     */
-    async createToken({ tokenDecimals, weightBps, viewSymbol, oracleSymbol, mintAddr, }) {
-        const receipt = await this.submitAction({
-            case: "createToken",
-            value: create(proto.Action_CreateTokenSchema, {
-                aclPubkey: this.admin.toBytes(),
-                tokenDecimals,
-                weightBps,
-                viewSymbol,
-                oracleSymbol,
-                solAddr: mintAddr.toBytes(),
-            }),
-        });
-        expectReceiptKind(receipt, "insertTokenResult", "create token");
-        return { actionId: receipt.actionId, ...receipt.kind.value };
-    }
-    /**
-     * Open a new market with the provided trading parameters.
-     *
-     * @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
-     */
-    async createMarket({ sizeDecimals, priceDecimals, imfBps, cmfBps, mmfBps, marketType, viewSymbol, oracleSymbol, baseTokenId, }) {
-        const receipt = await this.submitAction({
-            case: "createMarket",
-            value: create(proto.Action_CreateMarketSchema, {
-                aclPubkey: this.admin.toBytes(),
-                sizeDecimals,
-                priceDecimals,
-                imfBps,
-                cmfBps,
-                mmfBps,
-                marketType,
-                viewSymbol,
-                oracleSymbol,
-                baseTokenId,
-            }),
-        });
-        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 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
-     */
-    async pythSetWormholeGuardians({ guardianSetIndex, addresses, }) {
-        const parsedAddresses = addresses.map((address) => {
-            try {
-                const decoded = decodeHex(address);
-                if (decoded.length !== 20) {
-                    throw new Error("guardian address must be 20 bytes");
-                }
-                return decoded;
-            }
-            catch (e) {
-                throw new NordError("invalid guardian address; must be a 20 byte hex address", { cause: e });
-            }
-        });
-        const receipt = await this.submitAction({
-            case: "pythSetWormholeGuardians",
-            value: create(proto.Action_PythSetWormholeGuardiansSchema, {
-                aclPubkey: this.admin.toBytes(),
-                guardianSetIndex,
-                addresses: parsedAddresses,
-            }),
-        });
-        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 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
-     */
-    async pythSetSymbolFeed({ oracleSymbol, priceFeedId: priceFeedIdHex, }) {
-        let priceFeedId;
-        try {
-            priceFeedId = decodeHex(priceFeedIdHex);
-            if (priceFeedId.length !== 32) {
-                throw new Error("price feed id must be 32 bytes");
-            }
-        }
-        catch (e) {
-            throw new NordError("invalid price feed id; must be a 32 byte hex id", {
-                cause: e,
-            });
-        }
-        const receipt = await this.submitAction({
-            case: "pythSetSymbolFeed",
-            value: create(proto.Action_PythSetSymbolFeedSchema, {
-                aclPubkey: this.admin.toBytes(),
-                oracleSymbol,
-                priceFeedId,
-            }),
-        });
-        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: create(proto.Action_PauseSchema, {
-                aclPubkey: this.admin.toBytes(),
-            }),
-        });
-        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: create(proto.Action_UnpauseSchema, {
-                aclPubkey: this.admin.toBytes(),
-            }),
-        });
-        expectReceiptKind(receipt, "unpaused", "unpause");
-        return { actionId: receipt.actionId };
-    }
-    /**
-     * Freeze an individual market, preventing new trades and orders.
-     *
-     * @param marketId - Target market identifier
-     * @returns Action identifier and freeze receipt
-     * @throws {NordError} If the action submission fails
-     */
-    async freezeMarket({ marketId, }) {
-        const receipt = await this.submitAction({
-            case: "freezeMarket",
-            value: create(proto.Action_FreezeMarketSchema, {
-                marketId,
-                aclPubkey: this.admin.toBytes(),
-            }),
-        });
-        expectReceiptKind(receipt, "marketFreezeUpdated", "freeze market");
-        return { actionId: receipt.actionId, ...receipt.kind.value };
-    }
-    /**
-     * Unfreeze a market that was previously halted.
-     *
-     * @param marketId - Target market identifier
-     * @returns Action identifier and freeze receipt
-     * @throws {NordError} If the action submission fails
-     */
-    async unfreezeMarket({ marketId, }) {
-        const receipt = await this.submitAction({
-            case: "unfreezeMarket",
-            value: create(proto.Action_UnfreezeMarketSchema, {
-                marketId,
-                aclPubkey: this.admin.toBytes(),
-            }),
-        });
-        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 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).
-     */
-    async addFeeTier({ config, }) {
-        const receipt = await this.submitAction({
-            case: "addFeeTier",
-            value: create(proto.Action_AddFeeTierSchema, {
-                aclPubkey: this.admin.toBytes(),
-                config: create(proto.FeeTierConfigSchema, config),
-            }),
-        });
-        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 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.
-     */
-    async updateFeeTier({ tierId, config, }) {
-        const receipt = await this.submitAction({
-            case: "updateFeeTier",
-            value: create(proto.Action_UpdateFeeTierSchema, {
-                aclPubkey: this.admin.toBytes(),
-                id: tierId,
-                config: create(proto.FeeTierConfigSchema, config),
-            }),
-        });
-        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: create(proto.Action_UpdateAccountsTierSchema, {
-                aclPubkey: this.admin.toBytes(),
-                accounts,
-                tierId,
-            }),
-        });
-        expectReceiptKind(receipt, "accountsTierUpdated", "update accounts tier");
-        return { actionId: receipt.actionId, ...receipt.kind.value };
-    }
-}