feat(sdk-core): add optional StakeOptions fields

to support STX staking TICKET: EA-2430 TICKET: EA-2430
BitGo · Dec 7, 2023 · bff557c · bff557c
1 parent 8ff1d25
commit bff557c
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/modules/sdk-core/src/bitgo/staking/iStakingWallet.ts b/modules/sdk-core/src/bitgo/staking/iStakingWallet.ts
@@ -23,11 +23,22 @@ export interface DelegationRequest {
   validator: string;
 }
 
+/**
+ * Represents the options for staking.
+ * @typedef {Object} StakeOptions
+ * @property {string} [amount] - amount to stake
+ * @property {string} [clientId] - clientId
+ * @property {string} [validator] - chosen validator
+ * @property {string} [duration] - delegation duration: a numeric string, in days or cycles
+ * @property {string} [subType] - coin sepcific staking subtype
+ * @property {DelegationRequest[]} [delegationRequests] - The delegation requests
+ */
 export interface StakeOptions {
   amount?: string;
   clientId?: string;
   validator?: string;
-  durationSeconds?: string;
+  duration?: string;
+  subType?: string;
   delegationRequests?: DelegationRequest[];
 }