@bitgo/public-types 5.34.0 → 5.36.0

package/package.json

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

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

@@ -0,0 +1,25 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Transfer Accept Intent
+ *
+ * Intent for accepting the incoming deposit 2-step transfers
+ * 2-step transfer in `Canton` chain means that the receiver has to explicitly accept/reject the deposit
+ * by sending out an acceptance/rejection transaction on-chain
+ *
+ * @param {String} intentType - The type of intent (always set to transferAccept)
+ * @param {string} txRequestId - The acknowledgement txRequestId
+ */
+export const CantonTransferAcceptIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.transferAccept,
+    txRequestId: t.string,
+  }),
+]);
+
+export type CantonTransferAcceptIntent = t.TypeOf<
+  typeof CantonTransferAcceptIntent
+>;

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

@@ -0,0 +1,34 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Transfer Acknowledge Intent
+ *
+ * Intent for auto creating a dummy txn for the user to either accept or reject
+ * 2-step transfer in `Canton` chain means that the receiver has to explicitly accept/reject the deposit
+ * by sending out an acceptance/rejection transaction on-chain so when there is a deposit, we automatically create a
+ * txRequest with the details needed for user to take action
+ *
+ * @param {String} intentType - The type of intent (always set to transferAcknowledge)
+ * @param {String} contractId - The contract id that needs to be acted on by the receiver
+ * @param {String} senderPartyId - The address (partyId) of the sender
+ * @param {String} updateId - The transaction id of the deposit
+ * @param {Number} amount - The deposit amount
+ * @param {Number} expiry - The expiry epoch
+ */
+export const CantonTransferAcknowledgeIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.transferAcknowledge,
+    contractId: t.string,
+    senderPartyId: t.string,
+    updateId: t.string,
+    amount: t.number,
+    expiry: t.number,
+  }),
+]);
+
+export type CantonTransferAcknowledgeIntent = t.TypeOf<
+  typeof CantonTransferAcknowledgeIntent
+>;

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

@@ -0,0 +1,25 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Transfer Reject Intent
+ *
+ * Intent for rejecting the incoming deposit 2-step transfers
+ * 2-step transfer in `Canton` chain means that the receiver has to explicitly accept/reject the deposit
+ * by sending out an acceptance/rejection transaction on-chain
+ *
+ * @param {String} intentType - The type of intent (always set to transferReject)
+ * @param {string} txRequestId - The acknowledgement txRequestId
+ */
+export const CantonTransferRejectIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.transferReject,
+    txRequestId: t.string,
+  }),
+]);
+
+export type CantonTransferRejectIntent = t.TypeOf<
+  typeof CantonTransferRejectIntent
+>;

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

@@ -12,6 +12,7 @@ export * from "./adaUnstakeIntent";
 export * from "./adaVoteDelegationIntent";
 export * from "./address";
 export * from "./amount";
+export * from "./aptBuildOptions";
 export * from "./aptCustomTxIntent";
 export * from "./atomPaymentIntent";
 export * from "./atomStakeIntent";
@@ -19,6 +20,7 @@ export * from "./atomUnstakeIntent";
 export * from "./atomWithdrawIntent";
 export * from "./babyCreateBtcDelegationIntent";
 export * from "./babyWithdrawRewardIntent";
+export * from "./baseGoStakeIntent";
 export * from "./baseIntent";
 export * from "./baseStakeIntent";
 export * from "./baseStakeIntentWithCalldata";
@@ -27,6 +29,9 @@ export * from "./bscDelegateIntent";
 export * from "./bscStakeClaimRewardsIntent";
 export * from "./bscUndelegateIntent";
 export * from "./bscWithdrawUndelegateIntent";
+export * from "./cantonTransferAcceptIntent";
+export * from "./cantonTransferAcknowledgeIntent";
+export * from "./cantonTransferRejectIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";
 export * from "./coredaoDelegateIntent";
@@ -64,6 +69,7 @@ export * from "./feeOptionFeeType";
 export * from "./feeOptionFormula";
 export * from "./feeOptionUnit";
 export * from "./fillNonceIntent";
+export * from "./goUnstakeIntent";
 export * from "./hopParams";
 export * from "./icpPaymentIntent";
 export * from "./icpSignatures";
@@ -75,13 +81,13 @@ export * from "./mmiSignTransactionIntent";
 export * from "./nearStakeIntent";
 export * from "./nearUnstakeIntent";
 export * from "./nearWithdrawIntent";
+export * from "./paymentIntent";
 export * from "./polyxBaseIntent";
 export * from "./polyxCreateAccountIntent";
 export * from "./polyxPreApproveAssetIntent";
 export * from "./polyxStakeIntent";
 export * from "./polyxUnstakeIntent";
 export * from "./polyxWithdrawIntent";
-export * from "./paymentIntent";
 export * from "./recipientEntry";
 export * from "./signMessageIntent";
 export * from "./solAuthorizeIntent";
@@ -93,10 +99,10 @@ export * from "./solCreateAssociatedTokenAccountIntent";
 export * from "./solCustomTxIntent";
 export * from "./solDeactivateIntent";
 export * from "./solDelegateIntent";
-export * from "./solStakingType";
 export * from "./solGoUnstakeIntent";
 export * from "./solPaymentIntent";
 export * from "./solStakeIntent";
+export * from "./solStakingType";
 export * from "./solUnstakeIntent";
 export * from "./solVersionedCustomTxIntent";
 export * from "./stakeClaimRewardsIntent";
@@ -108,10 +114,6 @@ export * from "./substrateConsolidateIntent";
 export * from "./substrateFeeOptionFormula";
 export * from "./substrateFeeOptions";
 export * from "./substratePaymentIntent";
-export * from "./taoStakingBaseIntent";
-export * from "./taoStakeIntent";
-export * from "./taoSwitchValidatorIntent";
-export * from "./taoUnstakeIntent";
 export * from "./suiBuildOptions";
 export * from "./suiConsolidateIntent";
 export * from "./suiCustomTxIntent";
@@ -121,6 +123,11 @@ export * from "./suiPaymentIntent";
 export * from "./suiStakingIntent";
 export * from "./suiUnstakingIntent";
 export * from "./supportedTokenRecipientEntryItem";
+export * from "./taoStakeIntent";
+export * from "./taoStakingBaseIntent";
+export * from "./taoSwitchValidatorIntent";
+export * from "./taoUnstakeIntent";
+export * from "./tokenApprovalIntent";
 export * from "./tokenData";
 export * from "./tokenEnablement";
 export * from "./tokenRecipientEntry";
@@ -132,13 +139,12 @@ export * from "./tonUndelegateIntent";
 export * from "./transferTokenIntent";
 export * from "./unstakeIntent";
 export * from "./unsupportedTokenRecipientEntryItem";
-export * from "./vetStakingIntent";
 export * from "./vetStakeClaimRewardsIntent";
+export * from "./vetStakingIntent";
+export * from "./vetUnstakingIntent";
 export * from "./voteDelegationIntent";
 export * from "./walletRecoveryIntent";
 export * from "./walrusStakingIntent";
 export * from "./walrusUndelegateIntent";
 export * from "./walrusWithdrawIntent";
 export * from "./withdrawIntent";
-export * from "./tokenApprovalIntent";
-export * from "./vetUnstakingIntent";

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

@@ -92,6 +92,9 @@ import { SolGoUnstakeIntent } from "./solGoUnstakeIntent";
 import { SuiGoUnstakeIntent } from "./suiGoUnstakeIntent";
 import { VetStakingIntent } from "./vetStakingIntent";
 import { VetStakeClaimRewardsIntent } from "./vetStakeClaimRewardsIntent";
+import { CantonTransferAcceptIntent } from "./cantonTransferAcceptIntent";
+import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
+import { CantonTransferAcknowledgeIntent } from "./cantonTransferAcknowledgeIntent";
 
 export const TransactionIntent = t.union([
   AdaConsolidateIntent,
@@ -110,6 +113,9 @@ export const TransactionIntent = t.union([
   BscDelegateIntent,
   BscUnDelegateIntent,
   BscWithdrawUndelegateIntent,
+  CantonTransferAcceptIntent,
+  CantonTransferAcknowledgeIntent,
+  CantonTransferRejectIntent,
   CosmosPaymentIntent,
   CosmosStakeIntent,
   CosmosSwitchValidatorIntent,

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

@@ -43,6 +43,9 @@ export const intentTypes = {
    * Register a BTC delegation on the Babylon chain for Baby BTC staking.
    */
   createBtcDelegation: t.literal("createBtcDelegation"),
+  transferAccept: t.literal("transferAccept"),
+  transferReject: t.literal("transferReject"),
+  transferAcknowledge: t.literal("transferAcknowledge"),
 };
 
 export const IntentType = t.keyof(intentTypes);