@cubist-labs/cubesigner-sdk 0.4.241 → 0.4.244

package/src/client/base_client.ts

@@ -252,7 +252,7 @@ export class BaseClient extends EventEmitter<ClientEvents> {
           return status >= 500 && status < 600;
         },
       });
-      // Once we have a non-5XX response, we will assertOk (either throwing or yielding the reponse)
+      // Once we have a non-5XX response, we will assertOk (either throwing or yielding the response)
       return assertOk(resp);
     } catch (e) {
       if (e instanceof ErrResponse) {

package/src/fetch.ts

@@ -181,7 +181,7 @@ export type FetchResponseSuccessData<T> = Required<FetchResponse<T>>["data"];
 export function assertOk<T>(resp: FetchResponse<T>): FetchResponseSuccessData<T> {
   if (!resp.response.ok) {
     const errResp = resp.error as unknown as ErrorResponse | undefined;
-    const error = new ErrResponse({
+    throw new ErrResponse({
       requestId: errResp?.request_id,
       message: errResp?.message,
       statusText: resp.response?.statusText,
@@ -189,7 +189,6 @@ export function assertOk<T>(resp: FetchResponse<T>): FetchResponseSuccessData<T>
       url: resp.response?.url,
       errorCode: errResp?.error_code,
     });
-    throw error;
   }
   return resp.data!;
 }

package/src/key.ts

@@ -29,6 +29,7 @@ import type {
   DiffieHellmanResponse,
   KeyInfoJwt,
   KeyAttestationQuery,
+  BinanceApiProperties,
 } from "./schema_types";
 import type {
   ApiClient,
@@ -99,6 +100,7 @@ export enum Ed25519 {
   Stellar = "Ed25519StellarAddr",
   Substrate = "Ed25519SubstrateAddr",
   Tendermint = "Ed25519TendermintAddr",
+  BinanceApi = "Ed25519BinanceApi",
   Ton = "Ed25519TonAddr",
   Xrp = "Ed25519XrpAddr",
 }
@@ -125,6 +127,9 @@ export type BabyJubjub = typeof BabyJubjub;
 /** Key type */
 export type KeyType = Secp256k1 | Bls | Ed25519 | Mnemonic | Stark | P256 | BabyJubjub;
 
+/** The type representing all different kinds of key properties. */
+export type KeyPropertiesPatch = { kind: "BinanceApi" } & BinanceApiProperties;
+
 /**
  * A representation of a signing key.
  */
@@ -265,6 +270,23 @@ export class Key {
     return await this.update({ metadata }, mfaReceipt);
   }
 
+  /**
+   * Set key properties. Each field in the provided patch is independent: missing
+   * means leave alone, `null` clears, a value sets. Sending `null` for the whole
+   * field clears all properties on the key.
+   *
+   * @param patch Type-specific properties
+   * @param mfaReceipt Optional MFA receipt(s)
+   * @throws if MFA is required and no receipts are provided
+   * @returns The updated key info
+   */
+  async setProperties(
+    patch: KeyPropertiesPatch | null,
+    mfaReceipt?: MfaReceipts,
+  ): Promise<KeyInfo> {
+    return await this.update({ properties: patch }, mfaReceipt);
+  }
+
   /**
    * Retrieves the existing metadata, asserts that it is an object (throws if it is not),
    * then sets the value of the {@link name} property in that object to {@link value},
@@ -820,6 +842,8 @@ export function fromSchemaKeyType(ty: SchemaKeyType): KeyType {
       return Ed25519.Tendermint;
     case "Ed25519TonAddr":
       return Ed25519.Ton;
+    case "Ed25519BinanceApi":
+      return Ed25519.BinanceApi;
     case "Stark":
       return Stark;
     case "Mnemonic":

package/src/response.ts

@@ -1,7 +1,7 @@
 import type { MfaVote, EnvInterface, MfaReceipts, MfaRequired } from ".";
 import { CubeSignerClient, isManyMfaReceipts } from ".";
 import { encodeToBase64Url } from "./util";
-import type { AcceptedResponse } from "./schema_types";
+import type { AcceptedResponse, AcceptedValue, BinanceDryRun, SignDryRun } from "./schema_types";
 
 /**
  * Response type, which can be either a value of type {@link U}
@@ -29,46 +29,95 @@ export type MapFn<U, V> = (u: U) => V;
  * @returns Response whose value for status code 200 is mapped from U to V
  */
 export function mapResponse<U, V>(resp: Response<U>, mapFn: MapFn<U, V>): Response<V> {
-  if ((resp as AcceptedResponse).accepted?.MfaRequired) {
+  if (asAccepted(resp) !== undefined) {
     return resp as AcceptedResponse;
   } else {
     return mapFn(resp as U);
   }
 }
 
+/**
+ * @param resp The response to check
+ * @returns The {@link AcceptedValue} if the response status code is 202.
+ */
+function asAccepted<U>(resp: Response<U>): AcceptedValue | undefined {
+  const acceptedResp = resp as AcceptedResponse;
+  return acceptedResp.error_code === "SignDryRun" || acceptedResp.error_code === "MfaRequired"
+    ? (acceptedResp.accepted ?? undefined)
+    : undefined;
+}
+
 /**
  * A response of a CubeSigner request.
  */
 export class CubeSignerResponse<U> {
   readonly #env: EnvInterface;
   readonly #requestFn: RequestFn<U>;
-  readonly #resp: U | AcceptedResponse;
+  readonly #resp: Response<U>;
+
+  /**
+   * @returns The {@link AcceptedValue} if the response status code is 202.
+   */
+  asAccepted(): AcceptedValue | undefined {
+    return asAccepted(this.#resp);
+  }
+
+  /**
+   * @returns The associated {@link MfaRequired} value, if the response status code is 202 and the response indicates that MFA is required.
+   */
+  asMfaRequired(): MfaRequired | undefined {
+    return this.asAccepted()?.MfaRequired ?? undefined;
+  }
+
   /**
-   * Optional MFA id. Only set if there is an MFA request associated with the request
+   * @returns The associated {@link SignDryRun} value, if the response status code is 202 and the response is a dry run of a sign operation.
    */
-  readonly #mfaRequired?: MfaRequired;
+  asSignDryRun(): SignDryRun | undefined {
+    return this.asAccepted()?.SignDryRun ?? undefined;
+  }
+
+  /**
+   * @returns The associated {@link BinanceDryRun} value, if the response status code is 202 and the response is a dry run of a sign operation.
+   */
+  asBinanceDryRun(): BinanceDryRun | undefined {
+    return this.asAccepted()?.BinanceDryRun ?? undefined;
+  }
+
+  /**
+   * @returns Whether this response is a "200 Success" (in which case it is safe to call {@link data})
+   */
+  isSuccess(): boolean {
+    return this.asAccepted() === undefined;
+  }
+
+  /**
+   * @returns The underlying {@link MfaRequired} response (if any).
+   */
+  private get mfaRequired() {
+    return this.asAccepted()?.MfaRequired;
+  }
 
   /** @returns The first MFA id associated with this request (if any) */
   mfaId(): string | undefined {
-    return this.#mfaRequired?.id;
+    return this.mfaRequired?.id;
   }
 
   /** @returns The MFA ids associated with this request (if any) */
   mfaIds(): string[] {
-    return this.#mfaRequired?.ids ?? [];
+    return this.mfaRequired?.ids ?? [];
   }
 
   /** @returns True if this request requires an MFA approval */
   requiresMfa(): boolean {
-    return this.#mfaRequired !== undefined;
+    return this.mfaRequired !== undefined;
   }
 
   /**
    * @returns Session information to use for any MFA approval requests (if any was included in the response).
    */
   async mfaClient(): Promise<CubeSignerClient | undefined> {
-    if (this.#mfaRequired === undefined) return;
-    const session = (this.#resp as AcceptedResponse).accepted?.MfaRequired?.session ?? undefined;
+    if (this.mfaRequired === undefined) return;
+    const session = this.asMfaRequired()?.session ?? undefined;
     if (session === undefined) return;
 
     const env = this.#env;
@@ -76,7 +125,7 @@ export class CubeSignerResponse<U> {
       env: {
         "Dev-CubeSignerStack": env,
       },
-      org_id: this.#mfaRequired.org_id,
+      org_id: this.mfaRequired.org_id,
       session_exp: session.expiration,
       session_info: session.session_info,
       token: session.token,
@@ -86,8 +135,10 @@ export class CubeSignerResponse<U> {
 
   /** @returns The response data, if no MFA is required */
   data(): U {
-    if (this.requiresMfa()) {
-      throw new Error("Cannot call `data()` while MFA is required");
+    if (!this.isSuccess()) {
+      throw new Error(
+        "Cannot call `data()` on a 202 Accepted response; use `asMfaRequired()` or `asSignDryRun()`",
+      );
     }
     return this.#resp as U;
   }
@@ -131,7 +182,7 @@ export class CubeSignerResponse<U> {
       return this;
     }
 
-    const mfaOrgId = this.#mfaRequired!.org_id;
+    const mfaOrgId = this.mfaRequired!.org_id;
     const mfaApproval = await client.apiClient.mfaVoteTotp(mfaId, code, vote);
     const mfaConf = mfaApproval.receipt?.confirmation;
 
@@ -174,7 +225,7 @@ export class CubeSignerResponse<U> {
       return this;
     }
 
-    const mfaOrgId = this.#mfaRequired!.org_id;
+    const mfaOrgId = this.mfaRequired!.org_id;
 
     const mfaApproval = await client.apiClient.mfaVoteCs(mfaId, mfaVote);
     const mfaConf = mfaApproval.receipt?.confirmation;
@@ -211,11 +262,10 @@ export class CubeSignerResponse<U> {
    * @param resp The response as returned by the OpenAPI client.
    * @internal
    */
-  protected constructor(env: EnvInterface, requestFn: RequestFn<U>, resp: U | AcceptedResponse) {
+  protected constructor(env: EnvInterface, requestFn: RequestFn<U>, resp: Response<U>) {
     this.#env = env;
     this.#requestFn = requestFn;
     this.#resp = resp;
-    this.#mfaRequired = (this.#resp as AcceptedResponse).accepted?.MfaRequired;
   }
 
   /**