@cubist-labs/cubesigner-sdk 0.1.77 → 0.2.15

package/dist/src/response.js

@@ -0,0 +1,164 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _CubeSignerResponse_requestFn, _CubeSignerResponse_resp, _CubeSignerResponse_mfaRequired;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CubeSignerResponse = exports.mapResponse = void 0;
+/**
+ * Take a {@link Response<U>} and a {@link MapFn<U, V>} function and return
+ * a {@link Response<V>} that maps the value of the original response when its status code is 200.
+ *
+ * @param {Response<U>} resp Original response
+ * @param {Map<U, V>} mapFn Map to apply to the response value when its status code is 200.
+ * @return {Response<V>} Response whose value for status code 200 is mapped from U to V
+ */
+function mapResponse(resp, mapFn) {
+    if (resp.accepted?.MfaRequired) {
+        return resp;
+    }
+    else {
+        return mapFn(resp);
+    }
+}
+exports.mapResponse = mapResponse;
+/**
+ * A response of a CubeSigner request.
+ */
+class CubeSignerResponse {
+    /** @return {string} The MFA id associated with this request (if any) */
+    mfaId() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").id;
+    }
+    /** @return {boolean} True if this request requires an MFA approval */
+    requiresMfa() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f") !== undefined;
+    }
+    /**
+     * Return session information to use for any MFA approval requests (if any was included in the response).
+     * @return {ClientSessionInfo | undefined}
+     */
+    mfaSessionInfo() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f").accepted?.MfaRequired?.session ?? undefined;
+    }
+    /** @return {U} The response data, if no MFA is required */
+    data() {
+        if (this.requiresMfa()) {
+            throw new Error("Cannot call `data()` while MFA is required");
+        }
+        return __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f");
+    }
+    /**
+     * Approve the MFA request using a given session and a TOTP code.
+     *
+     * @param {SignerSession} session Signer session to use
+     * @param {string} code 6-digit TOTP code
+     * @return {CubeSignerResponse<U>} The result of signing with the approval
+     */
+    async approveTotp(session, code) {
+        if (!this.requiresMfa()) {
+            return this;
+        }
+        const mfaId = this.mfaId();
+        const mfaOrgId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").org_id;
+        const mfaApproval = await session.mfaApproveTotp(mfaId, code);
+        const mfaConf = mfaApproval.receipt?.confirmation;
+        if (!mfaConf) {
+            return this;
+        }
+        return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });
+    }
+    /**
+     * Approve the MFA request using a given `CubeSignerClient` instance (i.e., its session).
+     *
+     * @param {CubeSignerClient} cs CubeSigner whose session to use
+     * @return {CubeSignerResponse<U>} The result of signing with the approval
+     */
+    async approve(cs) {
+        if (!this.requiresMfa()) {
+            return this;
+        }
+        const mfaId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").id;
+        const mfaOrgId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").org_id;
+        const mfaApproval = await cs.mfaApprove(mfaId);
+        const mfaConf = mfaApproval.receipt?.confirmation;
+        if (!mfaConf) {
+            return this;
+        }
+        return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });
+    }
+    /**
+     * Resubmits the request with a given MFA receipt attached.
+     *
+     * @param {MfaReceipt} mfaReceipt The MFA receipt
+     * @return {Promise<CubeSignerResponse<U>>} The result of signing after MFA approval
+     */
+    async signWithMfaApproval(mfaReceipt) {
+        const headers = CubeSignerResponse.getMfaHeaders(mfaReceipt);
+        return new CubeSignerResponse(__classPrivateFieldGet(this, _CubeSignerResponse_requestFn, "f"), await __classPrivateFieldGet(this, _CubeSignerResponse_requestFn, "f").call(this, headers));
+    }
+    // --------------------------------------------------------------------------
+    // -- INTERNAL --------------------------------------------------------------
+    // --------------------------------------------------------------------------
+    /**
+     * Constructor.
+     *
+     * @param {RequestFn} requestFn
+     *    The signing function that this response is from.
+     *    This argument is used to resend requests with different headers if needed.
+     * @param {U | AcceptedResponse} resp The response as returned by the OpenAPI client.
+     * @internal
+     */
+    constructor(requestFn, resp) {
+        _CubeSignerResponse_requestFn.set(this, void 0);
+        _CubeSignerResponse_resp.set(this, void 0);
+        /**
+         * Optional MFA id. Only set if there is an MFA request associated with the
+         * signing request
+         */
+        _CubeSignerResponse_mfaRequired.set(this, void 0);
+        __classPrivateFieldSet(this, _CubeSignerResponse_requestFn, requestFn, "f");
+        __classPrivateFieldSet(this, _CubeSignerResponse_resp, resp, "f");
+        __classPrivateFieldSet(this, _CubeSignerResponse_mfaRequired, __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f").accepted?.MfaRequired, "f");
+    }
+    /**
+     * Static constructor.
+     * @param {RequestFn} requestFn
+     *    The request function that this response is from.
+     *    This argument is used to resend requests with different headers if needed.
+     * @param {MfaReceipt} mfaReceipt Optional MFA receipt
+     * @return {Promise<CubeSignerResponse<U>>} New instance of this class.
+     * @internal
+     */
+    static async create(requestFn, mfaReceipt) {
+        const seed = await requestFn(this.getMfaHeaders(mfaReceipt));
+        return new CubeSignerResponse(requestFn, seed);
+    }
+    /**
+     * Return HTTP headers containing a given MFA receipt.
+     *
+     * @param {MfaReceipt} mfaReceipt MFA receipt
+     * @return {HeadersInit} Headers including that receipt
+     * @internal
+     */
+    static getMfaHeaders(mfaReceipt) {
+        return mfaReceipt
+            ? {
+                "x-cubist-mfa-id": mfaReceipt.mfaId,
+                "x-cubist-mfa-org-id": mfaReceipt.mfaOrgId,
+                "x-cubist-mfa-confirmation": mfaReceipt.mfaConf,
+            }
+            : undefined;
+    }
+}
+exports.CubeSignerResponse = CubeSignerResponse;
+_CubeSignerResponse_requestFn = new WeakMap(), _CubeSignerResponse_resp = new WeakMap(), _CubeSignerResponse_mfaRequired = new WeakMap();
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/response.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAqBA;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAO,IAAiB,EAAE,KAAkB;IACrE,IAAK,IAAyB,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAC;QACrD,OAAO,IAAwB,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,IAAS,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAND,kCAMC;AAWD;;GAEG;AACH,MAAa,kBAAkB;IAS7B,wEAAwE;IACxE,KAAK;QACH,OAAO,uBAAA,IAAI,uCAAc,CAAC,EAAE,CAAC;IAC/B,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,OAAO,uBAAA,IAAI,uCAAa,KAAK,SAAS,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAQ,uBAAA,IAAI,gCAA2B,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,IAAI,SAAS,CAAC;IACtF,CAAC;IAED,2DAA2D;IAC3D,IAAI;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,uBAAA,IAAI,gCAAW,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAAsB,EAAE,IAAY;QACpD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,uBAAA,IAAI,uCAAc,CAAC,MAAM,CAAC;QAC3C,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;QAElD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAoB;QAChC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,uBAAA,IAAI,uCAAc,CAAC,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,uBAAA,IAAI,uCAAc,CAAC,MAAM,CAAC;QAE3C,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;QAElD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CAAC,UAAsB;QAC9C,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAI,kBAAkB,CAAC,uBAAA,IAAI,qCAAW,EAAE,MAAM,uBAAA,IAAI,qCAAW,MAAf,IAAI,EAAY,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,6EAA6E;IAC7E,6EAA6E;IAC7E,6EAA6E;IAE7E;;;;;;;;OAQG;IACH,YAAY,SAAuB,EAAE,IAA0B;QA1GtD,gDAAyB;QACzB,2CAA4B;QACrC;;;WAGG;QACM,kDAA2B;QAqGlC,uBAAA,IAAI,iCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,4BAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,mCAAiB,uBAAA,IAAI,gCAA2B,CAAC,QAAQ,EAAE,WAAW,MAAA,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,SAAuB,EACvB,UAAuB;QAEvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7D,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,UAAuB;QAC1C,OAAO,UAAU;YACf,CAAC,CAAC;gBACE,iBAAiB,EAAE,UAAU,CAAC,KAAK;gBACnC,qBAAqB,EAAE,UAAU,CAAC,QAAQ;gBAC1C,2BAA2B,EAAE,UAAU,CAAC,OAAO;aAChD;YACH,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;CACF;AAlJD,gDAkJC","sourcesContent":["import { CubeSignerClient, SignerSession } from \".\";\nimport { MfaReceipt } from \"./mfa\";\nimport { AcceptedResponse, NewSessionResponse } from \"./schema_types\";\n\n/**\n * Response type, which can be either a value of type {@link U}\n * or {@link AcceptedResponse} (status code 202) which requires MFA.\n */\nexport type Response<U> = U | AcceptedResponse;\n\n/**\n * Request function which optionally takes additional headers\n * (which, for example, can be used to attach an MFA receipt).\n */\nexport type RequestFn<U> = (headers?: HeadersInit) => Promise<Response<U>>;\n\n/**\n * Map function occasionally used to map a response from the API into a higher-level type.\n */\nexport type MapFn<U, V> = (u: U) => V;\n\n/**\n * Take a {@link Response<U>} and a {@link MapFn<U, V>} function and return\n * a {@link Response<V>} that maps the value of the original response when its status code is 200.\n *\n * @param {Response<U>} resp Original response\n * @param {Map<U, V>} mapFn Map to apply to the response value when its status code is 200.\n * @return {Response<V>} Response whose value for status code 200 is mapped from U to V\n */\nexport function mapResponse<U, V>(resp: Response<U>, mapFn: MapFn<U, V>): Response<V> {\n  if ((resp as AcceptedResponse).accepted?.MfaRequired) {\n    return resp as AcceptedResponse;\n  } else {\n    return mapFn(resp as U);\n  }\n}\n\nexport interface MfaRequired {\n  /** Org id */\n  org_id: string;\n  /** MFA request id */\n  id: string;\n  /** Optional MFA session */\n  session?: NewSessionResponse | null;\n}\n\n/**\n * A response of a CubeSigner request.\n */\nexport class CubeSignerResponse<U> {\n  readonly #requestFn: RequestFn<U>;\n  readonly #resp: U | AcceptedResponse;\n  /**\n   * Optional MFA id. Only set if there is an MFA request associated with the\n   * signing request\n   */\n  readonly #mfaRequired?: MfaRequired;\n\n  /** @return {string} The MFA id associated with this request (if any) */\n  mfaId(): string {\n    return this.#mfaRequired!.id;\n  }\n\n  /** @return {boolean} True if this request requires an MFA approval */\n  requiresMfa(): boolean {\n    return this.#mfaRequired !== undefined;\n  }\n\n  /**\n   * Return session information to use for any MFA approval requests (if any was included in the response).\n   * @return {ClientSessionInfo | undefined}\n   */\n  mfaSessionInfo(): NewSessionResponse | undefined {\n    return (this.#resp as AcceptedResponse).accepted?.MfaRequired?.session ?? undefined;\n  }\n\n  /** @return {U} The response data, if no MFA is required */\n  data(): U {\n    if (this.requiresMfa()) {\n      throw new Error(\"Cannot call `data()` while MFA is required\");\n    }\n    return this.#resp as U;\n  }\n\n  /**\n   * Approve the MFA request using a given session and a TOTP code.\n   *\n   * @param {SignerSession} session Signer session to use\n   * @param {string} code 6-digit TOTP code\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async approveTotp(session: SignerSession, code: string): Promise<CubeSignerResponse<U>> {\n    if (!this.requiresMfa()) {\n      return this;\n    }\n\n    const mfaId = this.mfaId();\n    const mfaOrgId = this.#mfaRequired!.org_id;\n    const mfaApproval = await session.mfaApproveTotp(mfaId, code);\n    const mfaConf = mfaApproval.receipt?.confirmation;\n\n    if (!mfaConf) {\n      return this;\n    }\n\n    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });\n  }\n\n  /**\n   * Approve the MFA request using a given `CubeSignerClient` instance (i.e., its session).\n   *\n   * @param {CubeSignerClient} cs CubeSigner whose session to use\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async approve(cs: CubeSignerClient): Promise<CubeSignerResponse<U>> {\n    if (!this.requiresMfa()) {\n      return this;\n    }\n\n    const mfaId = this.#mfaRequired!.id;\n    const mfaOrgId = this.#mfaRequired!.org_id;\n\n    const mfaApproval = await cs.mfaApprove(mfaId);\n    const mfaConf = mfaApproval.receipt?.confirmation;\n\n    if (!mfaConf) {\n      return this;\n    }\n\n    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });\n  }\n\n  /**\n   * Resubmits the request with a given MFA receipt attached.\n   *\n   * @param {MfaReceipt} mfaReceipt The MFA receipt\n   * @return {Promise<CubeSignerResponse<U>>} The result of signing after MFA approval\n   */\n  async signWithMfaApproval(mfaReceipt: MfaReceipt): Promise<CubeSignerResponse<U>> {\n    const headers = CubeSignerResponse.getMfaHeaders(mfaReceipt);\n    return new CubeSignerResponse(this.#requestFn, await this.#requestFn(headers));\n  }\n\n  // --------------------------------------------------------------------------\n  // -- INTERNAL --------------------------------------------------------------\n  // --------------------------------------------------------------------------\n\n  /**\n   * Constructor.\n   *\n   * @param {RequestFn} requestFn\n   *    The signing function that this response is from.\n   *    This argument is used to resend requests with different headers if needed.\n   * @param {U | AcceptedResponse} resp The response as returned by the OpenAPI client.\n   * @internal\n   */\n  constructor(requestFn: RequestFn<U>, resp: U | AcceptedResponse) {\n    this.#requestFn = requestFn;\n    this.#resp = resp;\n    this.#mfaRequired = (this.#resp as AcceptedResponse).accepted?.MfaRequired;\n  }\n\n  /**\n   * Static constructor.\n   * @param {RequestFn} requestFn\n   *    The request function that this response is from.\n   *    This argument is used to resend requests with different headers if needed.\n   * @param {MfaReceipt} mfaReceipt Optional MFA receipt\n   * @return {Promise<CubeSignerResponse<U>>} New instance of this class.\n   * @internal\n   */\n  static async create<U>(\n    requestFn: RequestFn<U>,\n    mfaReceipt?: MfaReceipt,\n  ): Promise<CubeSignerResponse<U>> {\n    const seed = await requestFn(this.getMfaHeaders(mfaReceipt));\n    return new CubeSignerResponse(requestFn, seed);\n  }\n\n  /**\n   * Return HTTP headers containing a given MFA receipt.\n   *\n   * @param {MfaReceipt} mfaReceipt MFA receipt\n   * @return {HeadersInit} Headers including that receipt\n   * @internal\n   */\n  static getMfaHeaders(mfaReceipt?: MfaReceipt): HeadersInit | undefined {\n    return mfaReceipt\n      ? {\n          \"x-cubist-mfa-id\": mfaReceipt.mfaId,\n          \"x-cubist-mfa-org-id\": mfaReceipt.mfaOrgId,\n          \"x-cubist-mfa-confirmation\": mfaReceipt.mfaConf,\n        }\n      : undefined;\n  }\n}\n"]}

package/dist/src/role.d.ts

@@ -1,17 +1,17 @@
-import { CubeSigner, Key, MfaType, SignerSession, SignerSessionInfo, SignerSessionLifetime, SignerSessionStorage } from ".";
-import { components } from "./client";
-type KeyWithPoliciesInfo = components["schemas"]["KeyInRoleInfo"];
-export type RoleInfo = components["schemas"]["RoleInfo"];
-/** Restrict transaction receiver.
+import { Key, KeyWithPoliciesInfo, MfaType, PageOpts, RoleInfo, SignerSession, SignerSessionInfo, SignerSessionLifetime, SignerSessionStorage } from ".";
+import { CubeSignerClient } from "./client";
+/**
+ * Restrict transaction receiver.
+ *
  * @example { TxReceiver: "0x8c594691c0e592ffa21f153a16ae41db5befcaaa" }
- * */
+ */
 export type TxReceiver = {
     TxReceiver: string;
 };
 /** The kind of deposit contracts. */
 export declare enum DepositContract {
     /** Canonical deposit contract */
-    Canonical = 0,
+    Canonical = 0,// eslint-disable-line no-unused-vars
     /** Wrapper deposit contract */
     Wrapper = 1
 }
@@ -23,18 +23,22 @@ export type TxDepositBase = {
         kind: DepositContract;
     };
 };
-/** Restrict transactions to calls to deposit contract with fixed validator (pubkey):
- *  @example { TxDeposit: { kind: DespositContract.Canonical, validator: { pubkey: "8879...8"} }}
- * */
+/**
+ * Restrict transactions to calls to deposit contract with fixed validator (pubkey):
+ *
+ * @example { TxDeposit: { kind: DespositContract.Canonical, validator: { pubkey: "8879...8"} }}
+ */
 export type TxDepositPubkey = {
     TxDeposit: {
         kind: DepositContract;
         pubkey: string;
     };
 };
-/** Restrict transactions to calls to deposit contract with any validator key in a role:
+/**
+ * Restrict transactions to calls to deposit contract with any validator key in a role:
+ *
  * @example { TxDeposit: { kind: DespositContract.Canonical, validator: { role_id: "Role#c63...af"} }}
- * */
+ */
 export type TxDepositRole = {
     TxDeposit: {
         kind: DepositContract;
@@ -43,14 +47,16 @@ export type TxDepositRole = {
 };
 /** All different kinds of sensitive operations. */
 export declare enum OperationKind {
-    BlobSign = "BlobSign",
-    EvmSign = "Eth1Sign",
-    Eth2Sign = "Eth2Sign",
-    Eth2Stake = "Eth2Stake",
-    Eth2Unstake = "Eth2Unstake",
+    BlobSign = "BlobSign",// eslint-disable-line no-unused-vars
+    EvmSign = "Eth1Sign",// eslint-disable-line no-unused-vars
+    Eth2Sign = "Eth2Sign",// eslint-disable-line no-unused-vars
+    Eth2Stake = "Eth2Stake",// eslint-disable-line no-unused-vars
+    Eth2Unstake = "Eth2Unstake",// eslint-disable-line no-unused-vars
     SolanaSign = "SolanaSign"
 }
-/** MFA policy
+/**
+ * MFA policy
+ *
  * @example {
  * {
  *   count: 1,
@@ -58,7 +64,7 @@ export declare enum OperationKind {
  *   allowed_mfa_types: [ "Totp" ],
  *   allowed_approvers: [ "User#123" ],
  * }
- * */
+ */
 export type MfaPolicy = {
     count?: number;
     num_auth_factors?: number;
@@ -66,7 +72,9 @@ export type MfaPolicy = {
     allowed_mfa_types?: MfaType[];
     restricted_operations?: OperationKind[];
 };
-/** Require MFA for transactions.
+/**
+ * Require MFA for transactions.
+ *
  * @example {
  *     RequireMfa: {
  *       count: 1,
@@ -78,14 +86,16 @@ export type MfaPolicy = {
  *       ]
  *     }
  *   }
- * */
+ */
 export type RequireMfa = {
     RequireMfa: MfaPolicy;
 };
 /** Allow raw blob signing */
 export declare const AllowRawBlobSigning: "AllowRawBlobSigning";
 export type AllowRawBlobSigning = typeof AllowRawBlobSigning;
-/** Key policy
+/**
+ * Key policy
+ *
  * @example [
  *   {
  *     "TxReceiver": "0x8c594691c0e592ffa21f153a16ae41db5befcaaa"
@@ -106,7 +116,7 @@ export type AllowRawBlobSigning = typeof AllowRawBlobSigning;
  *     }
  *   }
  * ]
- * */
+ */
 export type KeyPolicy = (TxReceiver | TxDeposit | RequireMfa | AllowRawBlobSigning)[];
 /** A key guarded by a policy. */
 export declare class KeyWithPolicies {
@@ -115,13 +125,13 @@ export declare class KeyWithPolicies {
     readonly policy?: KeyPolicy;
     /** @return {Promise<Key>} The key */
     getKey(): Promise<Key>;
-    /** Constructor.
-     * @param {CubeSigner} cs The CubeSigner instance to use for signing.
-     * @param {string} orgId The id of the organization to which the key belongs.
+    /**
+     * Constructor.
+     * @param {CubeSignerClient} csc The CubeSigner instance to use for signing.
      * @param {KeyWithPoliciesInfo} keyWithPolicies The key and its policies
      * @internal
-     * */
-    constructor(cs: CubeSigner, orgId: string, keyWithPolicies: KeyWithPoliciesInfo);
+     */
+    constructor(csc: CubeSignerClient, keyWithPolicies: KeyWithPoliciesInfo);
 }
 /** Roles. */
 export declare class Role {
@@ -131,7 +141,7 @@ export declare class Role {
     /**
      * The ID of the role.
      * @example Role#bfe3eccb-731e-430d-b1e5-ac1363e6b06b
-     * */
+     */
     readonly id: string;
     /** Delete the role. */
     delete(): Promise<void>;
@@ -141,96 +151,90 @@ export declare class Role {
     enable(): Promise<void>;
     /** Disable the role. */
     disable(): Promise<void>;
-    /** The list of users with access to the role.
+    /**
+     * The list of all users with access to the role.
      * @example [
      *   "User#c3b9379c-4e8c-4216-bd0a-65ace53cf98f",
      *   "User#5593c25b-52e2-4fb5-b39b-96d41d681d82"
      * ]
-     * */
-    users(): Promise<string[]>;
-    /** Add a user to the role.
-     * Adds an existing user to an existing role.
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all users.
+     */
+    users(page?: PageOpts): Promise<string[]>;
+    /**
+     * Add an existing user to an existing role.
+     *
      * @param {string} userId The user-id of the user to add to the role.
-     * */
+     */
     addUser(userId: string): Promise<void>;
-    /** The list of keys in the role.
+    /**
+     * The list of keys in the role.
      * @example [
      *    {
      *     id: "Key#bfe3eccb-731e-430d-b1e5-ac1363e6b06b",
      *     policy: { TxReceiver: "0x8c594691c0e592ffa21f153a16ae41db5befcaaa" }
      *    },
      *  ]
-     * */
-    keys(): Promise<KeyWithPolicies[]>;
-    /** Add keys to the role.
-     * Adds a list of existing keys to an existing role.
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all keys in this role.
+     */
+    keys(page?: PageOpts): Promise<KeyWithPolicies[]>;
+    /**
+     * Add a list of existing keys to an existing role.
+     *
      * @param {Key[]} keys The list of keys to add to the role.
      * @param {KeyPolicy?} policy The optional policy to apply to each key.
-     * */
+     */
     addKeys(keys: Key[], policy?: KeyPolicy): Promise<void>;
-    /** Add a key to the role.
-     * Adds an existing key to an existing role.
+    /**
+     * Add an existing key to an existing role.
+     *
      * @param {Key} key The key to add to the role.
      * @param {KeyPolicy?} policy The optional policy to apply to the key.
-     * */
+     */
     addKey(key: Key, policy?: KeyPolicy): Promise<void>;
-    /** Remove key from the role.
-     * Removes an existing key from an existing role.
+    /**
+     * Remove an existing key from an existing role.
+     *
      * @param {Key} key The key to remove from the role.
-     * */
+     */
     removeKey(key: Key): Promise<void>;
     /**
      * Create a new session for this role.
      * @param {SignerSessionStorage} storage The session storage to use
      * @param {string} purpose Descriptive purpose.
-     * @param {SignerSessionLifetime} ttl Optional session lifetimes.
+     * @param {SignerSessionLifetime} lifetimes Optional session lifetimes.
+     * @param {string[]} scopes Session scopes. Only `sign:*` scopes are allowed.
      * @return {Promise<SignerSession>} New signer session.
      */
-    createSession(storage: SignerSessionStorage, purpose: string, ttl?: SignerSessionLifetime): Promise<SignerSession>;
+    createSession(storage: SignerSessionStorage, purpose: string, lifetimes?: SignerSessionLifetime, scopes?: string[]): Promise<SignerSession>;
     /**
      * List all signer sessions for this role. Returned objects can be used to
      * revoke individual sessions, but they cannot be used for authentication.
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all sessions.
      * @return {Promise<SignerSessionInfo[]>} Signer sessions for this role.
      */
-    sessions(): Promise<SignerSessionInfo[]>;
-    /** Create a new role.
-     * @param {CubeSigner} cs The CubeSigner instance to use for signing.
-     * @param {string} orgId The id of the organization to which the role belongs.
+    sessions(page?: PageOpts): Promise<SignerSessionInfo[]>;
+    /**
+     * Constructor.
+     * @param {CubeSignerClient} csc The CubeSigner instance to use for signing.
      * @param {RoleInfo} data The JSON response from the API server.
      * @internal
-     * */
-    constructor(cs: CubeSigner, orgId: string, data: RoleInfo);
-    /** Update the role.
+     */
+    constructor(csc: CubeSignerClient, data: RoleInfo);
+    /**
+     * Update the role.
+     *
      * @param {UpdateRoleRequest} request The JSON request to send to the API server.
-     * */
+     * @return {Promise<RoleInfo>} The updated role information.
+     */
     private update;
-    /** Create new role.
-     * @param {CubeSigner} cs The CubeSigner instance to use for signing.
-     * @param {string} orgId The id of the organization to which the role belongs.
-     * @param {string?} name The optional name of the role.
-     * @return {Role} The new role.
-     * @internal
-     * */
-    static createRole(cs: CubeSigner, orgId: string, name?: string): Promise<Role>;
-    /** Get a role by id.
-     * @param {CubeSigner} cs The CubeSigner instance to use for signing.
-     * @param {string} orgId The id of the organization to which the role belongs.
-     * @param {string} roleId The id of the role to get.
-     * @return {Role} The role.
-     * @internal
-     * */
-    static getRole(cs: CubeSigner, orgId: string, roleId: string): Promise<Role>;
-    /** Fetches the role information.
+    /**
+     * Fetches the role information.
+     *
      * @return {RoleInfo} The role information.
      * @internal
-     * */
+     */
     private fetch;
-    /** Delete role.
-     * @param {CubeSigner} cs The CubeSigner instance to use for signing.
-     * @param {string} orgId The id of the organization to which the role belongs.
-     * @param {string} roleId The id of the role to delete.
-     * @internal
-     * */
-    private static deleteRole;
 }
-export {};