@bitgo/public-types 6.5.2 → 6.7.0

package/package.json

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

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

@@ -2,13 +2,20 @@ import * as t from "io-ts";
 import { BaseIntent } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Base codec for acceleration intents. Replaces a stuck pending EVM transaction
+ * with a higher-fee version to accelerate confirmation (replace-by-fee).
+ */
 export const AccelerationIntent = t.intersection([
   BaseIntent,
   t.type({
+    /** Must be "acceleration". */
     intentType: intentTypes.acceleration,
+    /** Transaction hash (0x-prefixed) of the pending transaction to accelerate. */
     txid: t.string,
   }),
   t.partial({
+    /** Sender address of the original transaction. */
     senderAddress: t.string,
   }),
 ]);

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

@@ -2,6 +2,7 @@ import * as t from "io-ts";
 import { Optional } from "../../../utils";
 
 export const AccountBaseBuildOptions = t.partial({
+  /** Override the on-chain nonce for this transaction. */
   nonce: Optional(t.union([t.string, t.number])),
 });
 

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

@@ -12,13 +12,19 @@ import { TokenRecipientEntry } from "./tokenRecipientEntry";
 export const AccountBaseConsolidateIntent = t.intersection([
   AccountBaseBuildOptions,
   t.type({
+    /** Must be "consolidate". */
     intentType: intentTypes.consolidate,
+    /** Destination address for consolidated funds. Must be a wallet-owned address. */
     receiveAddress: t.string,
   }),
   t.partial({
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
+    /** Opaque identifier used to correlate consolidation requests. */
     consolidateId: optionalString,
+    /** Token recipients for token consolidation flows. */
     recipients: Optional(t.array(TokenRecipientEntry)),
+    /** When true, leaves a small amount in the source address to keep it alive. */
     keepAlive: optionalBoolean,
   }),
 ]);

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

@@ -3,11 +3,16 @@ import { optionalString } from "../../../utils";
 import { PaymentIntent } from "./paymentIntent";
 
 /**
+ * Transfer tokens from a Cosmos-family wallet to one or more recipient
+ * addresses. Supported on all Cosmos-family chains. An optional memo may
+ * be included for exchange routing or identification.
+ *
  * @title Atom Payment Intent
  */
 export const AtomPaymentIntent = t.intersection([
   PaymentIntent,
   t.type({
+    /** Optional memo string attached to the transaction, used for routing or identification by exchanges. */
     memo: optionalString,
   }),
 ]);

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

@@ -5,15 +5,21 @@ import { StakeIntent } from "./stakeIntent";
 import { BaseIntentWithAmount } from "./baseIntent";
 
 /**
+ * Delegate (stake) tokens to one or more validators on ATOM. Use
+ * `validatorAddress` and `amount` for a single validator, or `recipients`
+ * for multi-validator delegation.
+ *
  * @title Atom Stake Intent
  */
 export const AtomStakeIntent = t.intersection([
   StakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Bech32 validator address to delegate tokens to (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator delegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -5,15 +5,21 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Undelegate (unstake) tokens from one or more validators on ATOM. Tokens
+ * enter the unbonding period. Use `validatorAddress` and `amount` for
+ * single validator or `recipients` for multi-validator.
+ *
  * @title Atom Unstake Intent
  */
 export const AtomUnstakeIntent = t.intersection([
   UnstakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Bech32 validator address to undelegate tokens from (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator undelegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -3,7 +3,13 @@ import { WithdrawIntent } from "./withdrawIntent";
 import { BaseIntentWithAmount } from "./baseIntent";
 
 /**
+ * Internal codec for ATOM staking reward claims. The `claim` intentType
+ * discriminant is not dispatched by the server — do not use directly. Use
+ * `CosmosStakeClaimRewardsIntent` with `intentType: stakeClaimRewards`
+ * instead.
+ *
  * @title Atom Withdraw Intent
+ * @deprecated
  */
 export const AtomWithdrawIntent = t.intersection([
   WithdrawIntent,

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

@@ -3,16 +3,15 @@ import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
- * @title Bridge Funds Intent
- * Intent for bridging assets across chains or protocols
+ * Base codec for bridge-funds intents across chains or protocols.
  *
- * The amount.symbol field identifies the asset to bridge (e.g., "ETH", "USDC")
- * The amount.value specifies how much to bridge
+ * @title Bridge Funds Intent
  */
 export const BaseBridgeFundsIntent = t.intersection([
   BaseIntent,
-  BaseIntentWithAmount, // Provides amount field with value + symbol (asset identifier)
+  BaseIntentWithAmount,
   t.type({
+    /** Must be "bridgeFunds". */
     intentType: intentTypes.bridgeFunds,
   }),
 ]);

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

@@ -13,8 +13,11 @@ export const BaseIntent = t.intersection([
     intentType: IntentType,
   }),
   t.partial({
+    /** Client-assigned sequence identifier for idempotency. */
     sequenceId: optionalString,
+    /** Human-readable memo attached to the transaction. */
     comment: optionalString,
+    /** Override the on-chain nonce for this transaction. */
     nonce: Optional(t.union([t.string, t.number])),
   }),
 ]);
@@ -26,7 +29,9 @@ export const BaseIntentWithoutNonce = t.intersection([
     intentType: IntentType,
   }),
   t.partial({
+    /** Client-assigned sequence identifier for idempotency. */
     sequenceId: optionalString,
+    /** Human-readable memo attached to the transaction. */
     comment: optionalString,
   }),
 ]);
@@ -63,6 +68,7 @@ export type BaseIntentWithoutNonce = t.TypeOf<typeof BaseIntentWithoutNonce>;
  * Asset extraction: Extracts `symbol` from each recipient's amount
  */
 export const BaseIntentWithRecipients = t.type({
+  /** Array of recipient addresses and amounts. */
   recipients: t.array(RecipientEntry),
 });
 
@@ -85,6 +91,7 @@ export type BaseIntentWithRecipients = t.TypeOf<
  * Note: This also matches BaseIntentWithRecipients since TokenRecipientEntry extends RecipientEntry
  */
 export const BaseIntentWithTokenRecipients = t.type({
+  /** Recipients of the token transfer. Each entry must include tokenData with tokenName and tokenContractAddress. */
   recipients: t.array(TokenRecipientEntry),
 });
 
@@ -120,6 +127,7 @@ export type BaseIntentWithTokenData = t.TypeOf<typeof BaseIntentWithTokenData>;
  * Asset extraction: Extracts tokenName
  */
 export const BaseIntentWithTokenName = t.type({
+  /** Name of the ERC-20 token to approve (e.g. "usdc", "weth"). */
   tokenName: t.string,
 });
 
@@ -141,6 +149,7 @@ export type BaseIntentWithTokenName = t.TypeOf<typeof BaseIntentWithTokenName>;
  * Asset extraction: Extracts symbol from the amount field
  */
 export const BaseIntentWithAmount = t.type({
+  /** Transaction amount. amount.symbol identifies the asset (e.g. "hypeevm:eth"); amount.value is the quantity in base units. */
   amount: Amount,
 });
 

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

@@ -5,9 +5,11 @@ import { StakingRequestSource } from "./stakingRequestSource";
 export const BaseStakeIntent = t.intersection([
   BaseIntent,
   t.type({
+    /** ID of the staking request, obtained from the BitGo staking service. */
     stakingRequestId: t.string,
   }),
   t.partial({
+    /** Origin of the staking request: MANUAL (user-initiated), AUTO_STAKE, or EXTERNAL. */
     source: StakingRequestSource,
   }),
 ]);

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

@@ -11,6 +11,7 @@ import { BaseStakeIntent } from "./baseStakeIntent";
 export const BaseStakeIntentWithCalldata = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Pre-computed ABI-encoded calldata for the staking contract interaction, provided by the BitGo staking service. */
     calldata: t.string,
   }),
 ]);

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

@@ -0,0 +1,20 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Claim unstaked or unbonded funds from an EVM validator after the
+ * undelegation cooldown period. Requires a staking request ID from the
+ * BitGo staking service.
+ *
+ * @title Claim Intent
+ */
+export const ClaimIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    /** Must be "claim". */
+    intentType: intentTypes.claim,
+  }),
+]);
+
+export type ClaimIntent = t.TypeOf<typeof ClaimIntent>;

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

@@ -0,0 +1,30 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Execute a Wasm smart contract on a Cosmos-family chain. Supported on all
+ * Cosmos-family chains. The hash chain additionally supports fee-grant via
+ * the optional feeGranter field.
+ *
+ * @title Cosmos Contract Call Intent
+ */
+export const CosmosContractCallIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    /** Must be "contractCall" */
+    intentType: intentTypes.contractCall,
+    /** Bech32 contract address to execute */
+    contract: t.string,
+    /** Hex-encoded binary message to pass to the contract Execute entrypoint */
+    msgHex: t.string,
+  }),
+  t.partial({
+    /** Optional Bech32 address paying transaction fees on behalf of the submitter (fee-grant). Supported on hash chain; passed through for any chain. */
+    feeGranter: t.string,
+  }),
+]);
+
+export type CosmosContractCallIntent = t.TypeOf<
+  typeof CosmosContractCallIntent
+>;

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

@@ -3,11 +3,16 @@ import { PaymentIntent } from "./paymentIntent";
 import { optionalString } from "../../../utils";
 
 /**
+ * Transfer tokens from a Cosmos-family wallet to one or more recipient
+ * addresses. Supported on all Cosmos-family chains. An optional memo may
+ * be included for exchange routing or identification.
+ *
  * @title Cosmos Payment Intent
  */
 export const CosmosPaymentIntent = t.intersection([
   PaymentIntent,
   t.type({
+    /** Optional memo string attached to the transaction, used for routing or identification by exchanges. */
     memo: optionalString,
   }),
 ]);

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

@@ -0,0 +1,23 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Claim accumulated staking rewards from a validator on a Cosmos-family chain.
+ * Supported on all Cosmos-family chains. Submit with intentType stakeClaimRewards.
+ *
+ * @title Cosmos Stake Claim Rewards Intent
+ */
+export const CosmosStakeClaimRewardsIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    /** Must be "stakeClaimRewards" */
+    intentType: intentTypes.stakeClaimRewards,
+    /** Bech32 validator address to withdraw accumulated staking rewards from (e.g. cosmosvaloper1...) */
+    validatorAddress: t.string,
+  }),
+]);
+
+export type CosmosStakeClaimRewardsIntent = t.TypeOf<
+  typeof CosmosStakeClaimRewardsIntent
+>;

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

@@ -6,6 +6,10 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Delegate (stake) tokens to one or more validators on a Cosmos-family
+ * chain. Use `validatorAddress` and `amount` for a single validator, or
+ * `recipients` for multi-validator delegation in a single transaction.
+ *
  * @title Cosmos Stake Intent
  */
 export const CosmosStakeIntent = t.intersection([
@@ -13,9 +17,11 @@ export const CosmosStakeIntent = t.intersection([
   BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.delegate,
+    /** Bech32 validator address to delegate tokens to (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator delegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -2,6 +2,10 @@ import * as t from "io-ts";
 import { StakeSwitchValidatorIntent } from "./stakeSwitchValidatorIntent";
 
 /**
+ * Atomically move a delegation from one validator to another (redelegate)
+ * on a Cosmos-family chain. The redelegation is subject to the chain's
+ * redelegation cooldown rules.
+ *
  * @title Cosmos Switch Validator Intent
  */
 export const CosmosSwitchValidatorIntent = StakeSwitchValidatorIntent;

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

@@ -6,6 +6,11 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Undelegate (unstake) tokens from one or more validators on a
+ * Cosmos-family chain. Tokens enter the chain's unbonding period and are
+ * not immediately available. Use `validatorAddress` and `amount` for a
+ * single validator, or `recipients` for multi-validator undelegation.
+ *
  * @title Cosmos Unstake Intent
  */
 export const CosmosUnstakeIntent = t.intersection([
@@ -13,9 +18,11 @@ export const CosmosUnstakeIntent = t.intersection([
   BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.undelegate,
+    /** Bech32 validator address to undelegate tokens from (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator undelegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -2,7 +2,13 @@ import * as t from "io-ts";
 import { WithdrawIntent } from "./withdrawIntent";
 
 /**
+ * Internal codec for cosmos-family staking reward claims. The `claim`
+ * intentType discriminant is not dispatched by the server — do not use
+ * directly. Use `CosmosStakeClaimRewardsIntent` with
+ * `intentType: stakeClaimRewards` instead.
+ *
  * @title Cosmos Withdraw Intent
+ * @deprecated
  */
 export const CosmosWithdrawIntent = t.intersection([
   WithdrawIntent,

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

@@ -2,9 +2,15 @@ import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Delegate staked assets to a validator on EVM-compatible chains that support
+ * delegated proof-of-stake (e.g. BSC). Requires a staking request ID from the
+ * BitGo staking service.
+ */
 export const DelegateIntent = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Must be "delegate". */
     intentType: intentTypes.delegate,
   }),
 ]);

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

@@ -5,12 +5,17 @@ import { FeeOption } from "./feeOption";
 import { EIP1559FeeOptions } from "./eip1559FeeOptions";
 
 /**
+ * Replace a stuck pending EVM transaction with a higher-fee version to
+ * accelerate confirmation. Supply the original transaction's txid and new
+ * feeOptions that exceed the original.
+ *
  * @title ETH Acceleration Intent
  */
 export const EthAccelerationIntent = t.intersection([
   AccelerationIntent,
   EthBuildOptionsWithoutFeeOptions,
   t.type({
+    /** New fee settings (must be higher than the original transaction). Use EIP1559FeeOptions for London-compatible chains. */
     feeOptions: t.union([FeeOption, EIP1559FeeOptions]),
   }),
 ]);

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

@@ -8,9 +8,13 @@ import { HopParams } from "./hopParams";
 export const EthBuildOptions = t.intersection([
   AccountBaseBuildOptions,
   t.partial({
+    /** Override gas estimation. Provide EIP1559FeeOptions for EIP-1559 chains or FeeOption for legacy. */
     feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
+    /** Parameters for BitGo Hop transactions (cross-chain bridging via the Hop protocol). */
     hopParams: Optional(HopParams),
+    /** Target receive address override. Defaults to wallet's primary receive address. */
     receiveAddress: optionalString,
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
   }),
 ]);
@@ -20,8 +24,11 @@ export type EthBuildOptions = t.TypeOf<typeof EthBuildOptions>;
 export const EthBuildOptionsWithoutFeeOptions = t.intersection([
   AccountBaseBuildOptions,
   t.partial({
+    /** Parameters for BitGo Hop transactions (cross-chain bridging via the Hop protocol). */
     hopParams: Optional(HopParams),
+    /** Target receive address override. Defaults to wallet's primary receive address. */
     receiveAddress: optionalString,
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
   }),
 ]);
@@ -33,8 +40,11 @@ export type EthBuildOptionsWithoutFeeOptions = t.TypeOf<
 // This is the same as Omit<EthBuildOptions, 'hopParams' | 'nonce'>
 // but `omit` is not easily available in io-ts
 export const EthFillNonceBuildOptions = t.partial({
+  /** Override gas estimation for the fill-nonce transaction. */
   feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
+  /** Target receive address override. Defaults to wallet's primary receive address. */
   receiveAddress: optionalString,
+  /** Index of the wallet address to use as the sender. */
   senderAddressIndex: optionalNumber,
 });
 

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

@@ -3,6 +3,10 @@ import { AccountBaseConsolidateIntent } from "./accountBaseConsolidateIntent";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Consolidate ETH from multiple receive addresses into the wallet's main
+ * address on EVM-compatible chains. Used for wallet housekeeping. Provide
+ * receiveAddress as the sweep destination.
+ *
  * @title ETH Consolidate Intent
  */
 export const EthConsolidateIntent = t.intersection([

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

@@ -6,15 +6,23 @@ import { TokenRecipientEntry } from "./tokenRecipientEntry";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Consolidate ERC-20 tokens from receive addresses into the wallet's main
+ * address on EVM-compatible chains. Supply token details in the
+ * recipients[].tokenData field.
+ *
  * @title ETH Consolidate Token Intent
  */
 export const EthConsolidateTokenIntent = t.intersection([
   BaseIntent,
   EthBuildOptions,
   t.type({
+    /** Must be "consolidateToken". */
     intentType: intentTypes.consolidateToken,
+    /** Array of token recipients. Each entry specifies the token contract and amount via tokenData. */
     recipients: t.array(TokenRecipientEntry),
+    /** Opaque identifier to correlate consolidation requests. */
     consolidateId: optionalString,
+    /** When true, leaves a minimal token balance in the source address. */
     keepAlive: optionalBoolean,
   }),
 ]);

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

@@ -3,6 +3,10 @@ import { FillNonceIntent } from "./fillNonceIntent";
 import { EthFillNonceBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Submit a zero-value self-send to consume a specific nonce on
+ * EVM-compatible chains. Used to unblock transaction queues when a nonce gap
+ * has formed.
+ *
  * @title ETH Fill Nonce Intent
  */
 export const EthFillNonceIntent = t.intersection([

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

@@ -4,12 +4,17 @@ import { EthBuildOptions } from "./ethBuildOptions";
 import { optionalBoolean } from "../../../utils";
 
 /**
+ * Transfer ETH or ERC-20 tokens to one or more recipients on EVM-compatible
+ * chains. Specify recipients with their address and amount. Optionally
+ * override fee settings via feeOptions.
+ *
  * @title ETH Payment Intent
  */
 export const EthPaymentIntent = t.intersection([
   PaymentIntent,
   EthBuildOptions,
   t.type({
+    /** When true, sends to the wallet's own receive address. */
     selfSend: optionalBoolean,
   }),
 ]);

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

@@ -3,15 +3,24 @@ import { StakeIntent } from "./stakeIntent";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Submit an ETH 2.0 validator staking deposit on Ethereum. Requires a
+ * pre-created staking request from the BitGo staking service. All validator
+ * fields (pubkey, withdrawalCredentials, signature, depositDataRoot) are
+ * provided by the staking service.
+ *
  * @title ETH Staking Intent
  */
 export const EthStakingIntent = t.intersection([
   StakeIntent,
   EthBuildOptions,
   t.type({
+    /** BLS public key of the validator (hex-encoded, provided by the staking service). */
     pubkey: t.string,
+    /** Withdrawal credentials for the validator (provided by the staking service). */
     withdrawalCredentials: t.string,
+    /** BLS signature over the deposit data (provided by the staking service). */
     signature: t.string,
+    /** SHA-256 hash of the deposit data (provided by the staking service). */
     depositDataRoot: t.string,
   }),
 ]);

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

@@ -3,6 +3,10 @@ import { EthBuildOptions } from "./ethBuildOptions";
 import { TransferTokenIntent } from "./transferTokenIntent";
 
 /**
+ * Transfer ERC-20 tokens to one or more recipients on EVM-compatible chains.
+ * Each recipient entry must include tokenData specifying the token contract
+ * and amount.
+ *
  * @title ETH Transfer Token Intent
  */
 export const EthTransferTokenIntent = t.intersection([

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

@@ -2,13 +2,21 @@ import * as t from "io-ts";
 import { BaseIntentWithoutNonce } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Base codec for fill-nonce intents. Submits a zero-value self-send to consume
+ * a specific nonce on EVM-compatible chains. Used to unblock transaction queues
+ * when a nonce gap has formed.
+ */
 export const FillNonceIntent = t.intersection([
   BaseIntentWithoutNonce,
   t.type({
+    /** Must be "fillNonce". */
     intentType: intentTypes.fillNonce,
+    /** The nonce value to fill. The transaction will be a self-send that consumes this nonce. */
     nonce: t.union([t.string, t.number]),
   }),
   t.partial({
+    /** Sender address with the stuck nonce. Defaults to the wallet's base address. */
     senderAddress: t.string,
   }),
 ]);

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

@@ -6,15 +6,15 @@ import { FeeOption } from "./feeOption";
 import { EIP1559FeeOptions } from "./eip1559FeeOptions";
 
 /**
- * @title Hypeevm Bridge Funds Intent
- * Intent for bridging assets from HyperCore to HyperEVM
+ * Bridge funds between HypeEVM L2 and L1. Specify the amount and asset via
+ * the amount field. Used exclusively on the HypeEVM chain.
  *
- * The amount.symbol field identifies the asset to bridge (e.g., "HYPE", "USDC")
- * The amount.value specifies how much to bridge
+ * @title Hypeevm Bridge Funds Intent
  */
 export const HypeevmBridgeFundsIntent = t.intersection([
   BaseBridgeFundsIntent,
   t.partial({
+    /** Override gas estimation for the bridge transaction. */
     feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
   }),
 ]);

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

@@ -3,12 +3,16 @@ import { BaseIntent, BaseIntentWithRecipients } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Transfer assets via the HypeEVM spot trading mechanism. Provide recipients
+ * with their address and amount. Used exclusively on the HypeEVM chain.
+ *
  * @title Hypeevm Spot Transfer Intent
  */
 export const HypeevmSpotTransferIntent = t.intersection([
   BaseIntent,
   BaseIntentWithRecipients,
   t.type({
+    /** Must be "spotTransfer". */
     intentType: intentTypes.spotTransfer,
   }),
 ]);