@bitgo/public-types 6.78.3 → 6.79.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitgo/public-types",
-  "version": "6.78.3",
+  "version": "6.79.0",
   "description": "Collection of types exposed externally as part of the BitGo public API",
   "license": "UNLICENSED",
   "author": "",
@@ -11,14 +11,9 @@
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "source": "src/index.ts",
-  "customCodecFile": "openapi-gen.config.js",
-  "openapi-generator": {
-    "codec-file": "openapi-gen.config.js"
-  },
   "files": [
     "dist/src/",
-    "src",
-    "openapi-gen.config.js"
+    "src"
   ],
   "scripts": {
     "build": "tsc --build --incremental --verbose .",

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

@@ -4,27 +4,21 @@ import { intentTypes } from "./intentType";
 
 const CANTON_DECIMAL_AMOUNT = /^[+-]?(?:\d+(?:\.\d*)?|\.\d+)$/;
 
-function isCantonAmount(value: unknown): value is string | number {
-  if (typeof value === "string") {
-    return CANTON_DECIMAL_AMOUNT.test(value);
-  }
-  return typeof value === "number" && Number.isSafeInteger(value);
+export interface CantonAmountBrand {
+  readonly CantonAmount: unique symbol;
 }
 
 /**
  * Exact Canton decimal-string amount codec.
- * Safe integer numbers remain accepted for legacy in-process callers; wire/API amounts stay strings.
+ * API amounts remain strings so the OpenAPI schema stays backward compatible.
  */
-export const CantonAmount = new t.Type<
-  string | number,
-  string | number,
-  unknown
->(
+export const CantonAmount = t.brand(
+  t.string,
+  ((value: string): value is t.Branded<string, CantonAmountBrand> =>
+    CANTON_DECIMAL_AMOUNT.test(value)) as (
+    value: string,
+  ) => value is t.Branded<string, CantonAmountBrand>,
   "CantonAmount",
-  isCantonAmount,
-  (value, context) =>
-    isCantonAmount(value) ? t.success(value) : t.failure(value, context),
-  t.identity,
 );
 /**
  * @title Canton Transfer Acknowledge Intent

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

@@ -147,6 +147,7 @@ export * from "./solStakeIntent";
 export * from "./solStakingType";
 export * from "./solUnstakeIntent";
 export * from "./solVersionedCustomTxIntent";
+export * from "./stacksRegisterForBondIntent";
 export * from "./stakeClaimRewardsIntent";
 export * from "./stakeIntent";
 export * from "./stakeSwitchValidatorIntent";

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

@@ -102,6 +102,7 @@ import { DotConsolidateIntent } from "./dotConsolidateIntent";
 import { SolCloseAssociatedTokenAccountIntent } from "./solCloseAssociatedTokenAccountIntent";
 import { BaseStakeIntentWithCalldata } from "./baseStakeIntentWithCalldata";
 import { StakeWithCallDataIntent } from "./stakeWithCallDataIntent";
+import { StacksRegisterForBondIntent } from "./stacksRegisterForBondIntent";
 import { SwitchValidatorWithCallDataIntent } from "./switchValidatorWithCallDataIntent";
 import { CoreDaoDelegateIntent } from "./coredaoDelegateIntent";
 import { CoreDaoUndelegateIntent } from "./coredaoUndelegateIntent";
@@ -314,6 +315,7 @@ export const TransactionIntent = t.union([
   XdcProposeIntent,
   XdcResignIntent,
   XdcWithdrawIntent,
+  StacksRegisterForBondIntent,
 
   /**
    * Catch all for past intents that have not been converted to codecs

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

@@ -129,6 +129,11 @@ export const intentTypes = {
   finalizeUnwrap: t.literal("finalizeUnwrap"),
   delegateResource: t.literal("delegateResource"),
   undelegateResource: t.literal("undelegateResource"),
+  /**
+   * TXN 2 of Stacks PoX-5 staking: submit `register-for-bond` against the STX
+   * wallet that signs the registration (the BTC lock is TXN 1).
+   */
+  stacksRegisterForBond: t.literal("stacksRegisterForBond"),
   /**
    * Cross-chain export transaction (e.g. C-chain → P-chain or P-chain → C-chain on Flare/Avalanche).
    */

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

@@ -0,0 +1,57 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { optionalString } from "../../../utils";
+
+/**
+ * @title Stacks Register For Bond Intent
+ *
+ * @description TXN 2 of the Stacks PoX-5 BTC staking flow: submit `register-for-bond`
+ * against the STX wallet that signs and broadcasts the registration. The BTC-family
+ * staking wallet only carries the lock (TXN 1).
+ *
+ * The caller builds the Clarity arguments, so `functionArgs` carries **hex-encoded
+ * Clarity values in contract-argument order**. Wallet Platform decodes them into Clarity
+ * values and calls the contract — it does not need to know the `register-for-bond` ABI.
+ *
+ * ```clarity
+ * (register-for-bond
+ *   (bond-index uint)
+ *   (signer-manager <signer-manager-trait>)
+ *   (amount-ustx uint)
+ *   (btc-lockup (ok { outputs: (list 10 {...}), staker-unlock-bytes: (buff 683) }))
+ *   (signer-calldata (optional (buff 500))))
+ * ```
+ *
+ * @param {string} intentType - The type of intent (always set to stacksRegisterForBond)
+ * @param {string} stxWalletId - The Stacks wallet that signs and submits the registration
+ * @param {string} stxAddress - The resolved STX staker address (also the allowlist/membership key)
+ * @param {string | number} bondIndex - Bond index to register for
+ * @param {string} signerManager - The signer-manager contract principal
+ * @param {string | number} amountUstx - Stake amount in uSTX (the Clarity args carry the authoritative value)
+ * @param {string} contractName - Stacks contract name (e.g. "pox-5")
+ * @param {string} functionName - Contract function name (e.g. "register-for-bond")
+ * @param {string[]} functionArgs - Hex-encoded Clarity values in contract-argument order
+ * @param {string} [signerCalldata] - Optional `(buff 500)` calldata for the signer-manager's `validate-stake!`
+ */
+export const StacksRegisterForBondIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    intentType: intentTypes.stacksRegisterForBond,
+    stxWalletId: t.string,
+    stxAddress: t.string,
+    bondIndex: t.union([t.string, t.number]),
+    signerManager: t.string,
+    amountUstx: t.union([t.string, t.number]),
+    contractName: t.string,
+    functionName: t.string,
+    functionArgs: t.array(t.string),
+  }),
+  t.partial({
+    signerCalldata: optionalString,
+  }),
+]);
+
+export type StacksRegisterForBondIntent = t.TypeOf<
+  typeof StacksRegisterForBondIntent
+>;

package/openapi-gen.config.js

@@ -1,3 +0,0 @@
-module.exports = (E) => ({
-  CantonAmount: () => E.right({ type: "string" }),
-});