@n1xyz/nord-ts 0.1.5 → 0.1.6

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

@@ -2,6 +2,11 @@ import { PublicKey } from "@solana/web3.js";
 import * as proto from "../../gen/nord_pb";
 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.
  */
@@ -70,11 +75,13 @@ export interface UpdateFeeTierParams {
  */
 export declare class NordAdmin {
     private readonly nord;
+    private readonly admin;
     private readonly signFn;
     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
@@ -94,8 +101,9 @@ export declare class NordAdmin {
      *
      * where `nacl` is the tweetnacl library.
      */
-    static new({ nord, signFn, }: Readonly<{
+    static new({ nord, admin, signFn, }: Readonly<{
         nord: Nord;
+        admin: PublicKey;
         signFn: (m: Uint8Array) => Promise<Uint8Array>;
     }>): NordAdmin;
     /**
@@ -105,6 +113,21 @@ export declare class NordAdmin {
      * @throws {NordError} If signing or submission fails
      */
     private submitAction;
+    /** 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.
      *

package/dist/nord/client/NordAdmin.js

@@ -33,23 +33,34 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NordAdmin = void 0;
+exports.NordAdmin = exports.AclRole = 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");
+// NOTE: keep in sync with `acl.rs`.
+// NOTE: don't forget `number` as int is internally a u32.
+var AclRole;
+(function (AclRole) {
+    AclRole[AclRole["FEE_MANAGER"] = 1] = "FEE_MANAGER";
+    AclRole[AclRole["MARKET_MANAGER"] = 2] = "MARKET_MANAGER";
+    // TODO: unsure about this?
+    AclRole[AclRole["ADMIN"] = -2147483648] = "ADMIN";
+})(AclRole || (exports.AclRole = AclRole = {}));
 /**
  * Administrative client capable of submitting privileged configuration actions.
  */
 class NordAdmin {
-    constructor({ nord, 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.
      *
      * `signFn` must sign the _hex-encoded_ message, not the raw message itself, for
@@ -69,9 +80,10 @@ class NordAdmin {
      *
      * where `nacl` is the tweetnacl library.
      */
-    static new({ nord, signFn, }) {
+    static new({ nord, admin, signFn, }) {
         return new NordAdmin({
             nord,
+            admin,
             signFn,
         });
     }
@@ -92,6 +104,37 @@ class NordAdmin {
             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_1.NordError("duplicate roles in acl update; must be unique");
+        }
+        let mask = 0;
+        let values = 0;
+        for (const role of allRoles) {
+            mask |= role;
+        }
+        for (const role of addRoles) {
+            values |= role;
+        }
+        const receipt = await this.submitAction({
+            case: "updateAcl",
+            value: (0, protobuf_1.create)(proto.Action_UpdateAclSchema, {
+                aclPubkey: this.admin.toBytes(),
+                targetPubkey: target.toBytes(),
+            }),
+        });
+        (0, actions_1.expectReceiptKind)(receipt, "aclUpdated", "update acl");
+        return { ...receipt.kind.value, actionId: receipt.actionId };
+    }
     /**
      * Register a new token that can be listed on Nord.
      *
@@ -103,6 +146,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "createToken",
             value: (0, protobuf_1.create)(proto.Action_CreateTokenSchema, {
+                aclPubkey: this.admin.toBytes(),
                 tokenDecimals,
                 weightBps,
                 viewSymbol,
@@ -124,6 +168,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "createMarket",
             value: (0, protobuf_1.create)(proto.Action_CreateMarketSchema, {
+                aclPubkey: this.admin.toBytes(),
                 sizeDecimals: params.sizeDecimals,
                 priceDecimals: params.priceDecimals,
                 imfBps: params.imfBps,
@@ -165,6 +210,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "pythSetWormholeGuardians",
             value: (0, protobuf_1.create)(proto.Action_PythSetWormholeGuardiansSchema, {
+                aclPubkey: this.admin.toBytes(),
                 guardianSetIndex: params.guardianSetIndex,
                 addresses,
             }),
@@ -199,6 +245,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "pythSetSymbolFeed",
             value: (0, protobuf_1.create)(proto.Action_PythSetSymbolFeedSchema, {
+                aclPubkey: this.admin.toBytes(),
                 oracleSymbol: params.oracleSymbol,
                 priceFeedId,
             }),
@@ -215,7 +262,9 @@ class NordAdmin {
     async pause() {
         const receipt = await this.submitAction({
             case: "pause",
-            value: (0, protobuf_1.create)(proto.Action_PauseSchema, {}),
+            value: (0, protobuf_1.create)(proto.Action_PauseSchema, {
+                aclPubkey: this.admin.toBytes(),
+            }),
         });
         (0, actions_1.expectReceiptKind)(receipt, "paused", "pause");
         return { actionId: receipt.actionId };
@@ -229,7 +278,9 @@ class NordAdmin {
     async unpause() {
         const receipt = await this.submitAction({
             case: "unpause",
-            value: (0, protobuf_1.create)(proto.Action_UnpauseSchema, {}),
+            value: (0, protobuf_1.create)(proto.Action_UnpauseSchema, {
+                aclPubkey: this.admin.toBytes(),
+            }),
         });
         (0, actions_1.expectReceiptKind)(receipt, "unpaused", "unpause");
         return { actionId: receipt.actionId };
@@ -246,6 +297,7 @@ class NordAdmin {
             case: "freezeMarket",
             value: (0, protobuf_1.create)(proto.Action_FreezeMarketSchema, {
                 marketId: params.marketId,
+                aclPubkey: this.admin.toBytes(),
             }),
         });
         (0, actions_1.expectReceiptKind)(receipt, "marketFreezeUpdated", "freeze market");
@@ -263,6 +315,7 @@ class NordAdmin {
             case: "unfreezeMarket",
             value: (0, protobuf_1.create)(proto.Action_UnfreezeMarketSchema, {
                 marketId: params.marketId,
+                aclPubkey: this.admin.toBytes(),
             }),
         });
         (0, actions_1.expectReceiptKind)(receipt, "marketFreezeUpdated", "unfreeze market");
@@ -283,6 +336,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "addFeeTier",
             value: (0, protobuf_1.create)(proto.Action_AddFeeTierSchema, {
+                aclPubkey: this.admin.toBytes(),
                 config: (0, protobuf_1.create)(proto.FeeTierConfigSchema, params.config),
             }),
         });
@@ -303,6 +357,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "updateFeeTier",
             value: (0, protobuf_1.create)(proto.Action_UpdateFeeTierSchema, {
+                aclPubkey: this.admin.toBytes(),
                 id: params.tierId,
                 config: (0, protobuf_1.create)(proto.FeeTierConfigSchema, params.config),
             }),
@@ -326,6 +381,7 @@ class NordAdmin {
         const receipt = await this.submitAction({
             case: "updateAccountsTier",
             value: (0, protobuf_1.create)(proto.Action_UpdateAccountsTierSchema, {
+                aclPubkey: this.admin.toBytes(),
                 accounts,
                 tierId,
             }),

package/dist/nord/index.d.ts

@@ -1,6 +1,6 @@
 export { Nord } from "./client/Nord";
 export { NordUser } from "./client/NordUser";
-export { NordAdmin } from "./client/NordAdmin";
+export { NordAdmin, AclRole } from "./client/NordAdmin";
 export { NordClient } from "./client/NordClient";
 export type { NordClientParams } from "./client/NordClient";
 export type { CreateTokenParams, CreateMarketParams, PythSetWormholeGuardiansParams, PythSetSymbolFeedParams, FreezeMarketParams, UnfreezeMarketParams, } from "./client/NordAdmin";

package/dist/nord/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NordError = exports.NordClient = exports.NordAdmin = exports.NordUser = exports.Nord = void 0;
+exports.NordError = exports.NordClient = exports.AclRole = exports.NordAdmin = exports.NordUser = exports.Nord = void 0;
 // Export main client classes
 var Nord_1 = require("./client/Nord");
 Object.defineProperty(exports, "Nord", { enumerable: true, get: function () { return Nord_1.Nord; } });
@@ -22,6 +22,7 @@ var NordUser_1 = require("./client/NordUser");
 Object.defineProperty(exports, "NordUser", { enumerable: true, get: function () { return NordUser_1.NordUser; } });
 var NordAdmin_1 = require("./client/NordAdmin");
 Object.defineProperty(exports, "NordAdmin", { enumerable: true, get: function () { return NordAdmin_1.NordAdmin; } });
+Object.defineProperty(exports, "AclRole", { enumerable: true, get: function () { return NordAdmin_1.AclRole; } });
 var NordClient_1 = require("./client/NordClient");
 Object.defineProperty(exports, "NordClient", { enumerable: true, get: function () { return NordClient_1.NordClient; } });
 // Export utility classes

package/dist/types.d.ts

@@ -37,6 +37,8 @@ export interface NordConfig {
     app: string;
     /** Solana cluster URL */
     solanaUrl: string;
+    /** Proton URL, defaults to webServerUrl */
+    protonUrl?: string;
     /**
      * Whether to initialize WebSockets on creation, defaults to true
      * @deprecated this is a funky api we're gonna be removing it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n1xyz/nord-ts",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Typescript for Nord",
   "keywords": [],
   "author": "",