@bitgo/public-types 6.59.0 → 6.61.0

package/package.json

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

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

@@ -123,6 +123,7 @@ export type BaseIntentWithTokenData = t.TypeOf<typeof BaseIntentWithTokenData>;
  *
  * Used by:
  * - TokenApprovalIntent
+ * - WrapApproveIntent
  *
  * Asset extraction: Extracts tokenName
  */

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

@@ -65,6 +65,9 @@ export * from "./defiDepositIntent";
 export * from "./defiRedeemIntent";
 export * from "./defiApproveIntent";
 export * from "./defiWithdrawIntent";
+export * from "./wrapNativeIntent";
+export * from "./unwrapNativeIntent";
+export * from "./wrapApproveIntent";
 export * from "./dotAccountBaseBuildOptions";
 export * from "./dotBaseIntent";
 export * from "./dotConsolidateIntent";

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

@@ -21,6 +21,9 @@ import { DefiApproveIntent } from "./defiApproveIntent";
 import { DefiDepositIntent } from "./defiDepositIntent";
 import { DefiRedeemIntent } from "./defiRedeemIntent";
 import { DefiWithdrawIntent } from "./defiWithdrawIntent";
+import { WrapNativeIntent } from "./wrapNativeIntent";
+import { UnwrapNativeIntent } from "./unwrapNativeIntent";
+import { WrapApproveIntent } from "./wrapApproveIntent";
 import { CosmosContractCallIntent } from "./cosmosContractCallIntent";
 import { CosmosPaymentIntent } from "./cosmosPaymentIntent";
 import { CosmosStakeClaimRewardsIntent } from "./cosmosStakeClaimRewardsIntent";
@@ -195,6 +198,9 @@ export const TransactionIntent = t.union([
   DefiDepositIntent,
   DefiRedeemIntent,
   DefiWithdrawIntent,
+  WrapNativeIntent,
+  UnwrapNativeIntent,
+  WrapApproveIntent,
   DotConsolidateIntent,
   DotCreateAccountIntent,
   DotPaymentIntent,

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

@@ -95,6 +95,31 @@ export const intentTypes = {
    * protocol-keyed flow (vaultInternal.ts).
    */
   "defi-withdraw": t.literal("defi-withdraw"),
+  /**
+   * Wrap native currency into its canonical wrapped-native ERC-20 (e.g. ETH → WETH via WETH9 `deposit()`).
+   */
+  "wrap-native": t.literal("wrap-native"),
+  /**
+   * Unwrap the canonical wrapped-native ERC-20 back to native currency (e.g. WETH → ETH via WETH9 `withdraw(uint256)`).
+   */
+  "unwrap-native": t.literal("unwrap-native"),
+  /**
+   * ERC-20 approve for an ERC-7984 confidential wrapper (shield phase-1, client-created).
+   * Distinct from `tokenApproval` (batcher) and `defi-approve` (vault).
+   */
+  wrapApprove: t.literal("wrapApprove"),
+  /**
+   * Wrap (shield) underlying ERC-20 into an ERC-7984 confidential token (WP-created after approve confirm).
+   */
+  wrap: t.literal("wrap"),
+  /**
+   * Unwrap (unshield phase-1) an ERC-7984 confidential token (client-created).
+   */
+  unwrap: t.literal("unwrap"),
+  /**
+   * Finalize unwrap (unshield phase-2) after oracle decryption (WP-created).
+   */
+  finalizeUnwrap: t.literal("finalizeUnwrap"),
   delegateResource: t.literal("delegateResource"),
   undelegateResource: t.literal("undelegateResource"),
   /**

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

@@ -0,0 +1,14 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+
+export const UnwrapNativeIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: t.literal("unwrap-native"),
+    vaultId: t.string,
+    // Raw amount string in base units of the wrapped-native token (also 18dp for WETH).
+    amount: t.string,
+  }),
+]);
+
+export type UnwrapNativeIntent = t.TypeOf<typeof UnwrapNativeIntent>;

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

@@ -0,0 +1,24 @@
+import * as t from "io-ts";
+import { BaseIntent, BaseIntentWithTokenName } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Approve an underlying ERC-20 for an ERC-7984 confidential wrapper (shield phase-1).
+ * Client-created; WP mints wrapLinkId / wrapLinkExpiresAt on the txnReq.
+ *
+ * `tokenName` is the confidential wrapper (e.g. `hteth:cusdt`), not the underlying.
+ *
+ * @title Intent for ERC-7984 wrapApprove (shield allowance)
+ */
+export const WrapApproveIntent = t.intersection([
+  BaseIntent,
+  BaseIntentWithTokenName,
+  t.type({
+    /** Must be "wrapApprove". */
+    intentType: intentTypes.wrapApprove,
+    /** Exact approve amount in underlying base units (positive integer string). */
+    amount: t.string,
+  }),
+]);
+
+export type WrapApproveIntent = t.TypeOf<typeof WrapApproveIntent>;

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

@@ -0,0 +1,14 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+
+export const WrapNativeIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: t.literal("wrap-native"),
+    vaultId: t.string,
+    // Raw amount string in base units of the NATIVE coin (18dp for ETH).
+    amount: t.string,
+  }),
+]);
+
+export type WrapNativeIntent = t.TypeOf<typeof WrapNativeIntent>;