@bitgo/public-types 5.5.0 → 5.6.0

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

@@ -0,0 +1,19 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+
+/**
+ * @title BaseGoStakeIntent
+ *
+ * @description base interface for Go staking intents.
+ *
+ * @param {string} goStakingRequestId - The unique identifier for the Go staking request.
+ *
+ */
+export const BaseGoStakeIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    goStakingRequestId: t.string,
+  }),
+]);
+
+export type BaseGoStakeIntent = t.TypeOf<typeof BaseGoStakeIntent>;

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

@@ -0,0 +1,22 @@
+import * as t from "io-ts";
+import { RecipientEntry } from "./recipientEntry";
+import { intentTypes } from "./intentType";
+import { BaseGoStakeIntent } from "./baseGoStakeIntent";
+
+/**
+ * @title GoUnstakeIntent
+ *
+ * @description interface for Go unstake intents.
+ *
+ * @param {RecipientEntry[]} recipients - An array of recipient entries, for the address and amount.
+ *
+ */
+export const GoUnstakeIntent = t.intersection([
+  BaseGoStakeIntent,
+  t.type({
+    intentType: intentTypes.goUnstake,
+    recipients: t.array(RecipientEntry),
+  }),
+]);
+
+export type GoUnstakeIntent = t.TypeOf<typeof GoUnstakeIntent>;

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

@@ -79,6 +79,8 @@ import { BeraDelegateIntent } from "./beraDelegateIntent";
 import { WalrusStakingIntent } from "./walrusStakingIntent";
 import { WalrusUndelegateIntent } from "./walrusUndelegateIntent";
 import { WalrusWithdrawIntent } from "./walrusWithdrawIntent";
+import { SolGoUnstakeIntent } from "./solGoUnstakeIntent";
+import { SuiGoUnstakeIntent } from "./suiGoUnstakeIntent";
 
 export const TransactionIntent = t.union([
   AdaConsolidateIntent,
@@ -133,6 +135,7 @@ export const TransactionIntent = t.union([
   SolCreateAssociatedTokenAccountIntent,
   SolDeactivateIntent,
   SolDelegateIntent,
+  SolGoUnstakeIntent,
   SolPaymentIntent,
   SolStakeIntent,
   SolUnstakeIntent,
@@ -140,6 +143,7 @@ export const TransactionIntent = t.union([
   SubstratePaymentIntent,
   SuiConsolidateIntent,
   SuiCustomTxIntent,
+  SuiGoUnstakeIntent,
   SuiPaymentIntent,
   SuiStakingIntent,
   SuiUnstakingIntent,

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

@@ -34,6 +34,10 @@ export const intentTypes = {
   stakeWithCallData: t.literal("stakeWithCallData"),
   feeAddressTransfer: t.literal("feeAddressTransfer"),
   tokenApproval: t.literal("tokenApproval"),
+  /**
+   * Unstake and transfer funds from a staking wallet to a go account.
+   */
+  goUnstake: t.literal("goUnstake"),
   /**
    * Register a BTC delegation on the Babylon chain for Baby BTC staking.
    */

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

@@ -0,0 +1,16 @@
+import * as t from "io-ts";
+import { SolBuildOptions } from "./solBuildOptions";
+import { GoUnstakeIntent } from "./goUnstakeIntent";
+
+/**
+ * @title SolGoUnstakeIntent
+ *
+ * @description Unstake intent for GO wallets for the Solana blockchain.
+ *
+ */
+export const SolGoUnstakeIntent = t.intersection([
+  GoUnstakeIntent,
+  SolBuildOptions,
+]);
+
+export type SolGoUnstakeIntent = t.TypeOf<typeof SolGoUnstakeIntent>;

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

@@ -0,0 +1,16 @@
+import * as t from "io-ts";
+import { SuiBuildOptions } from "./suiBuildOptions";
+import { GoUnstakeIntent } from "./goUnstakeIntent";
+
+/**
+ * @title SuiGoUnstakeIntent
+ *
+ * @description Unstake intent for GO wallets for the Solana blockchain.
+ *
+ */
+export const SuiGoUnstakeIntent = t.intersection([
+  GoUnstakeIntent,
+  SuiBuildOptions,
+]);
+
+export type SuiGoUnstakeIntent = t.TypeOf<typeof SuiGoUnstakeIntent>;

package/src/schema/transactions/tronTransaction.ts

@@ -7,59 +7,34 @@ export const TronResourceType = t.keyof({
 });
 export type TronResourceType = t.TypeOf<typeof TronResourceType>;
 
-export const TronTransactionType = t.keyof({
-  freeze: 1,
-  unfreeze: 1,
-  vote: 1,
-  claimRewards: 1,
-  delegateResource: 1,
-  undelegateResource: 1,
-  withdrawExpireUnfreeze: 1,
+export const TronFreezeTransaction = t.type({
+  type: t.literal("freeze"),
+  owner_address: t.string,
+  frozen_balance: t.string,
+  resource: TronResourceType,
 });
-export type TronTransactionType = t.TypeOf<typeof TronTransactionType>;
 
-export const TronTransactionBase = t.type({
-  transactionType: TronTransactionType,
+export const TronUnfreezeTransaction = t.type({
+  type: t.literal("unfreeze"),
+  owner_address: t.string,
+  unfreeze_balance: t.string,
+  resource: TronResourceType,
 });
 
-export const TronFreezeTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("freeze"),
-    owner_address: t.string,
-    frozen_balance: t.string,
-    resource: TronResourceType,
-  }),
-]);
-
-export const TronUnfreezeTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("unfreeze"),
-    owner_address: t.string,
-    unfreeze_balance: t.string,
-    resource: TronResourceType,
-  }),
-]);
-
-export const TronVoteTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("vote"),
-    owner_address: t.string,
-    votes: t.array(
-      t.type({
-        vote_address: t.string,
-        vote_count: t.string,
-      }),
-    ),
-  }),
-]);
+export const TronVoteTransaction = t.type({
+  type: t.literal("vote"),
+  owner_address: t.string,
+  votes: t.array(
+    t.type({
+      vote_address: t.string,
+      vote_count: t.string,
+    }),
+  ),
+});
 
 export const TronDelegateResourceTransaction = t.intersection([
-  TronTransactionBase,
   t.type({
-    transactionType: t.literal("delegateResource"),
+    type: t.literal("delegateResource"),
     owner_address: t.string,
     resource: TronResourceType,
     receiver_address: t.string,
@@ -71,32 +46,23 @@ export const TronDelegateResourceTransaction = t.intersection([
   }),
 ]);
 
-export const TronUndelegateResourceTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("undelegateResource"),
-    owner_address: t.string,
-    resource: TronResourceType,
-    receiver_address: t.string,
-    balance: t.string,
-  }),
-]);
+export const TronUndelegateResourceTransaction = t.type({
+  type: t.literal("undelegateResource"),
+  owner_address: t.string,
+  resource: TronResourceType,
+  receiver_address: t.string,
+  balance: t.string,
+});
 
-export const TronClaimRewardsTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("claimRewards"),
-    owner_address: t.string,
-  }),
-]);
+export const TronClaimRewardsTransaction = t.type({
+  type: t.literal("claimRewards"),
+  owner_address: t.string,
+});
 
-export const TronWithdrawExpireUnfreezeTransaction = t.intersection([
-  TronTransactionBase,
-  t.type({
-    transactionType: t.literal("withdrawExpireUnfreeze"),
-    owner_address: t.string,
-  }),
-]);
+export const TronWithdrawExpireUnfreezeTransaction = t.type({
+  type: t.literal("withdrawExpireUnfreeze"),
+  owner_address: t.string,
+});
 
 export const TronTransaction = t.union([
   TronFreezeTransaction,
@@ -108,7 +74,6 @@ export const TronTransaction = t.union([
   TronWithdrawExpireUnfreezeTransaction,
 ]);
 
-export type TronTransactionBase = t.TypeOf<typeof TronTransactionBase>;
 export type TronFreezeTransaction = t.TypeOf<typeof TronFreezeTransaction>;
 export type TronUnfreezeTransaction = t.TypeOf<typeof TronUnfreezeTransaction>;
 export type TronVoteTransaction = t.TypeOf<typeof TronVoteTransaction>;

package/src/schema/webhook/addWalletWebhookRequest.ts

@@ -33,6 +33,9 @@ export const AddWalletWebhookRequestBody = {
   listenToFailureStates: Optional(t.boolean),
   txRequestStates: Optional(t.array(TransactionRequestState)),
   txRequestTransactionStates: Optional(t.array(TransactionState)),
+  /**
+   * Custom HTTP header key/values to be included with every notification for the webhook.
+   */
   customHttpHeaders: Optional(t.record(t.string, t.string)),
 };
 export const AddWalletWebhookRequestBodyC = t.type({