@bitgo/public-types 5.73.0 → 5.75.0

package/package.json

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

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

@@ -0,0 +1,28 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Transfer Offer Withdrawn Intent
+ *
+ * Intent for cancelling the 2-step offer that was sent out
+ * In canton, the `offer` can be withdrawn by doing a cancellation of offer transaction
+ *
+ * @param {String} intentType - The type of intent (always set to transferOfferWithdrawn)
+ * @param {string} transferId - The offer transferId that needs to be cancelled
+ * @param {String} [token] - The optional token
+ */
+export const CantonTransferOfferWithdrawnIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.transferOfferWithdrawn,
+    transferId: t.string,
+  }),
+  t.partial({
+    token: t.string,
+  }),
+]);
+
+export type CantonTransferOfferWithdrawnIntent = t.TypeOf<
+  typeof CantonTransferOfferWithdrawnIntent
+>;

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

@@ -35,6 +35,7 @@ export * from "./bscUndelegateIntent";
 export * from "./bscWithdrawUndelegateIntent";
 export * from "./cantonTransferAcceptIntent";
 export * from "./cantonTransferAcknowledgeIntent";
+export * from "./cantonTransferOfferWithdrawnIntent";
 export * from "./cantonTransferRejectIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";
@@ -172,3 +173,4 @@ export * from "./walrusUndelegateIntent";
 export * from "./walrusWithdrawIntent";
 export * from "./withdrawIntent";
 export * from "./xdcStakingIntent";
+export * from "./xdcUnstakingIntent";

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

@@ -101,12 +101,15 @@ import { VetDelegateIntent } from "./vetDelegateIntent";
 import { VetStakeClaimRewardsIntent } from "./vetStakeClaimRewardsIntent";
 import { VetValidatorRegistrationIntent } from "./vetValidatorRegistrationIntent";
 import { CantonTransferAcceptIntent } from "./cantonTransferAcceptIntent";
-import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
 import { CantonTransferAcknowledgeIntent } from "./cantonTransferAcknowledgeIntent";
+import { CantonTransferOfferWithdrawnIntent } from "./cantonTransferOfferWithdrawnIntent";
+import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
 import { TonWhalesDelegateIntent } from "./tonWhalesDelegateIntent";
 import { TonWhalesUndelegateIntent } from "./tonWhalesUndelegateIntent";
 import { XdcUploadKycIntent } from "./xdcStakingIntent";
 import { XdcProposeIntent } from "./xdcStakingIntent";
+import { XdcResignIntent } from "./xdcUnstakingIntent";
+import { XdcWithdrawIntent } from "./xdcUnstakingIntent";
 import { HypeevmBridgeFundsIntent } from "./hypeevmBridgeFundsIntent";
 
 export const TransactionIntent = t.union([
@@ -128,6 +131,7 @@ export const TransactionIntent = t.union([
   BscWithdrawUndelegateIntent,
   CantonTransferAcceptIntent,
   CantonTransferAcknowledgeIntent,
+  CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
   CosmosPaymentIntent,
   CosmosStakeIntent,
@@ -216,6 +220,8 @@ export const TransactionIntent = t.union([
   WalrusWithdrawIntent,
   XdcUploadKycIntent,
   XdcProposeIntent,
+  XdcResignIntent,
+  XdcWithdrawIntent,
 
   /**
    * Catch all for past intents that have not been converted to codecs

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

@@ -51,6 +51,7 @@ export const intentTypes = {
   transferAccept: t.literal("transferAccept"),
   transferReject: t.literal("transferReject"),
   transferAcknowledge: t.literal("transferAcknowledge"),
+  transferOfferWithdrawn: t.literal("transferOfferWithdrawn"),
 };
 
 export const IntentType = t.keyof(intentTypes);

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

@@ -0,0 +1,54 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+import { NonEmptyString } from "io-ts-types";
+import { BaseIntentWithAmount } from "./baseIntent";
+
+/**
+ * @title XDC Resign Intent
+ *
+ * Intent for resigning a masternode candidate on XDC network.
+ * This calls resign(address _candidate) on the system validator contract
+ * to initiate the unstaking process.
+ *
+ * @param {string} intentType - The type of intent (undelegate)
+ * @param {string} stakingRequestId - The staking request identifier
+ * @param {string} candidateAddress - The address of the masternode candidate to resign
+ * @param {string} validatorContractAddress - The address of the XDC Validator contract
+ */
+export const XdcResignIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    intentType: intentTypes.undelegate,
+    candidateAddress: NonEmptyString,
+    validatorContractAddress: NonEmptyString,
+  }),
+]);
+
+export type XdcResignIntent = t.TypeOf<typeof XdcResignIntent>;
+
+/**
+ * @title XDC Withdraw Intent
+ *
+ * Intent for withdrawing staked XDC after the lock period expires.
+ * This calls withdraw(uint256 _blockNumber, uint256 _index) on the
+ * system validator contract to reclaim the 10M XDC stake.
+ *
+ * @param {string} intentType - The type of intent (unstake)
+ * @param {string} stakingRequestId - The staking request identifier
+ * @param {string} blockNumber - The block number when the resignation was confirmed
+ * @param {string} index - The withdrawal index
+ * @param {string} validatorContractAddress - The address of the XDC Validator contract
+ */
+export const XdcWithdrawIntent = t.intersection([
+  BaseStakeIntent,
+  BaseIntentWithAmount,
+  t.type({
+    intentType: intentTypes.unstake,
+    blockNumber: NonEmptyString,
+    index: NonEmptyString,
+    validatorContractAddress: NonEmptyString,
+  }),
+]);
+
+export type XdcWithdrawIntent = t.TypeOf<typeof XdcWithdrawIntent>;