@bitgo/public-types 6.86.0 → 6.87.0

package/dist/src/schema/transactionRequest/intents/icpPaymentIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"icpPaymentIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/icpPaymentIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,mDAAgD;AAChD,0CAAgD;AAKnC,QAAA,gBAAgB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC7C,6BAAa;IACb,CAAC,CAAC,OAAO,CAAC;QACR,IAAI,EAAE,sBAAc;KACrB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"icpPaymentIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/icpPaymentIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,mDAAgD;AAChD,0CAAgD;AAUnC,QAAA,gBAAgB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC7C,6BAAa;IACb,CAAC,CAAC,OAAO,CAAC;QAOR,IAAI,EAAE,sBAAc;KACrB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/icpSignatures.js.map

@@ -1 +1 @@
-{"version":3,"file":"icpSignatures.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/icpSignatures.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,CAAC,CAAC,OAAO,CAAC;IACtC,kBAAkB,EAAE,oBAAoB;IACxC,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,UAAU,EAAE,CAAC,CAAC,MAAM;CACrB,CAAC,CAAC;AAEU,QAAA,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC;IAClC,eAAe,EAAE,sBAAc;IAC/B,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAClC,UAAU,EAAE,YAAY;IACxB,SAAS,EAAE,CAAC,CAAC,MAAM;CACpB,CAAC,CAAC"}
+{"version":3,"file":"icpSignatures.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/icpSignatures.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAE3B,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAKU,QAAA,cAAc,GAAG,CAAC,CAAC,OAAO,CAAC;IAEtC,kBAAkB,EAAE,oBAAoB;IAExC,SAAS,EAAE,CAAC,CAAC,MAAM;IAEnB,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,UAAU,EAAE,CAAC,CAAC,MAAM;CACrB,CAAC,CAAC;AAMU,QAAA,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC;IAElC,eAAe,EAAE,sBAAc;IAE/B,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAElC,UAAU,EAAE,YAAY;IAExB,SAAS,EAAE,CAAC,CAAC,MAAM;CACpB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitgo/public-types",
-  "version": "6.86.0",
+  "version": "6.87.0",
   "description": "Collection of types exposed externally as part of the BitGo public API",
   "license": "UNLICENSED",
   "author": "",

package/src/schema/transactionRequest/intents/icpPaymentIntent.ts

@@ -3,11 +3,22 @@ import { PaymentIntent } from "./paymentIntent";
 import { optionalString } from "../../../utils";
 
 /**
+ * Transfer ICP tokens to a single recipient on the Internet Computer network.
+ * The wallet's root account identifier is the sender. Supports an optional
+ * numeric memo for sub-address routing (e.g. exchange deposit tags). Only one
+ * recipient is supported per transaction.
+ *
  * @title ICP Payment Intent
  */
 export const IcpPaymentIntent = t.intersection([
   PaymentIntent,
   t.partial({
+    /**
+     * Numeric sub-address memo encoded as a string (e.g. "42"). Used to
+     * distinguish deposits to the same root account identifier, similar to
+     * exchange deposit tags. Must parse as a non-negative integer —
+     * non-numeric strings are rejected at transaction build time.
+     */
     memo: optionalString,
   }),
 ]);

package/src/schema/transactionRequest/intents/icpSignatures.ts

@@ -4,9 +4,15 @@ const IcpAccountIdentifier = t.partial({
   address: t.string,
 });
 
+/**
+ * The payload submitted for signing in the ICP transaction flow.
+ */
 export const SigningPayload = t.partial({
+  /** Account identifier of the signing account. */
   account_identifier: IcpAccountIdentifier,
+  /** Raw hex bytes of the payload. */
   hex_bytes: t.string,
+  /** Signature scheme used to sign the payload. Always "ecdsa". */
   signature_type: t.literal("ecdsa"),
 });
 
@@ -15,10 +21,18 @@ const IcpPublicKey = t.partial({
   curve_type: t.string,
 });
 
+/**
+ * ECDSA signature produced by the ICP signing flow. Contains the raw hex
+ * bytes, the public key of the signer, and the payload that was signed.
+ */
 export const Signatures = t.partial({
+  /** The payload that was signed. */
   signing_payload: SigningPayload,
+  /** Signature scheme used. Always "ecdsa". */
   signature_type: t.literal("ecdsa"),
+  /** Public key of the signer. */
   public_key: IcpPublicKey,
+  /** Raw hex bytes of the signature. */
   hex_bytes: t.string,
 });