@bitgo/public-types 6.28.0 → 6.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/dist/src/schema/transactionRequest/intents/baseGoStakeIntent.js.map +1 -1
  2. package/dist/src/schema/transactionRequest/intents/enableTokenIntent.js.map +1 -1
  3. package/dist/src/schema/transactionRequest/intents/goUnstakeIntent.d.ts +1 -3
  4. package/dist/src/schema/transactionRequest/intents/goUnstakeIntent.js +2 -2
  5. package/dist/src/schema/transactionRequest/intents/goUnstakeIntent.js.map +1 -1
  6. package/dist/src/schema/transactionRequest/intents/intent.d.ts +82 -7
  7. package/dist/src/schema/transactionRequest/intents/solAuthorizeIntent.js.map +1 -1
  8. package/dist/src/schema/transactionRequest/intents/solBuildOptions.js.map +1 -1
  9. package/dist/src/schema/transactionRequest/intents/solClaimIntent.js.map +1 -1
  10. package/dist/src/schema/transactionRequest/intents/solCloseAssociatedTokenAccountIntent.js.map +1 -1
  11. package/dist/src/schema/transactionRequest/intents/solConsolidateIntent.js.map +1 -1
  12. package/dist/src/schema/transactionRequest/intents/solCreateAssociatedTokenAccountIntent.js.map +1 -1
  13. package/dist/src/schema/transactionRequest/intents/solCustomTxIntent.js.map +1 -1
  14. package/dist/src/schema/transactionRequest/intents/solDeactivateIntent.d.ts +1 -0
  15. package/dist/src/schema/transactionRequest/intents/solDeactivateIntent.js +2 -0
  16. package/dist/src/schema/transactionRequest/intents/solDeactivateIntent.js.map +1 -1
  17. package/dist/src/schema/transactionRequest/intents/solDelegateIntent.d.ts +1 -0
  18. package/dist/src/schema/transactionRequest/intents/solDelegateIntent.js +2 -0
  19. package/dist/src/schema/transactionRequest/intents/solDelegateIntent.js.map +1 -1
  20. package/dist/src/schema/transactionRequest/intents/solGoUnstakeIntent.d.ts +4 -4
  21. package/dist/src/schema/transactionRequest/intents/solGoUnstakeIntent.js +4 -0
  22. package/dist/src/schema/transactionRequest/intents/solGoUnstakeIntent.js.map +1 -1
  23. package/dist/src/schema/transactionRequest/intents/solPaymentIntent.js.map +1 -1
  24. package/dist/src/schema/transactionRequest/intents/solStakeIntent.js.map +1 -1
  25. package/dist/src/schema/transactionRequest/intents/solUnstakeIntent.js.map +1 -1
  26. package/dist/src/schema/transactionRequest/intents/solVersionedCustomTxIntent.js.map +1 -1
  27. package/dist/src/schema/transactionRequest/intents/suiGoUnstakeIntent.d.ts +76 -3
  28. package/dist/src/schema/transactionRequest/intents/suiGoUnstakeIntent.js +2 -0
  29. package/dist/src/schema/transactionRequest/intents/suiGoUnstakeIntent.js.map +1 -1
  30. package/dist/src/schema/transactionRequest/intents/unstakeIntent.js.map +1 -1
  31. package/dist/src/schema/transactionRequest/intents/withdrawIntent.js.map +1 -1
  32. package/dist/src/schema/transactionRequest/transactionRequest.d.ts +164 -14
  33. package/package.json +1 -1
  34. package/src/schema/transactionRequest/intents/baseGoStakeIntent.ts +4 -5
  35. package/src/schema/transactionRequest/intents/enableTokenIntent.ts +2 -0
  36. package/src/schema/transactionRequest/intents/goUnstakeIntent.ts +8 -7
  37. package/src/schema/transactionRequest/intents/solAuthorizeIntent.ts +11 -0
  38. package/src/schema/transactionRequest/intents/solBuildOptions.ts +1 -0
  39. package/src/schema/transactionRequest/intents/solClaimIntent.ts +3 -0
  40. package/src/schema/transactionRequest/intents/solCloseAssociatedTokenAccountIntent.ts +4 -0
  41. package/src/schema/transactionRequest/intents/solConsolidateIntent.ts +2 -0
  42. package/src/schema/transactionRequest/intents/solCreateAssociatedTokenAccountIntent.ts +2 -0
  43. package/src/schema/transactionRequest/intents/solCustomTxIntent.ts +10 -0
  44. package/src/schema/transactionRequest/intents/solDeactivateIntent.ts +7 -0
  45. package/src/schema/transactionRequest/intents/solDelegateIntent.ts +8 -0
  46. package/src/schema/transactionRequest/intents/solGoUnstakeIntent.ts +7 -3
  47. package/src/schema/transactionRequest/intents/solPaymentIntent.ts +5 -0
  48. package/src/schema/transactionRequest/intents/solStakeIntent.ts +4 -3
  49. package/src/schema/transactionRequest/intents/solUnstakeIntent.ts +7 -3
  50. package/src/schema/transactionRequest/intents/solVersionedCustomTxIntent.ts +18 -0
  51. package/src/schema/transactionRequest/intents/suiGoUnstakeIntent.ts +4 -1
  52. package/src/schema/transactionRequest/intents/unstakeIntent.ts +1 -0
  53. package/src/schema/transactionRequest/intents/withdrawIntent.ts +1 -0
@@ -7844,6 +7844,7 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
7844
7844
  memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
7845
7845
  }>]>, t.TypeC<{
7846
7846
  intentType: t.LiteralC<"deactivate">;
7847
+ }>, t.PartialC<{
7847
7848
  stakingAddresses: t.UnionC<[t.Type<string[], string[], unknown>, t.UndefinedC]>;
7848
7849
  stakingAddress: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
7849
7850
  }>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
@@ -7926,9 +7927,10 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
7926
7927
  }>]>, t.TypeC<{
7927
7928
  intentType: t.LiteralC<"delegate">;
7928
7929
  validatorAddress: t.StringC;
7930
+ }>, t.PartialC<{
7929
7931
  stakingAddresses: t.UnionC<[t.Type<string[], string[], unknown>, t.UndefinedC]>;
7930
7932
  stakingAddress: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
7931
- }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
7933
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
7932
7934
  intentType: t.KeyofC<{
7933
7935
  payment: t.LiteralC<"payment">;
7934
7936
  transferToken: t.LiteralC<"transferToken">;
@@ -8001,8 +8003,6 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
8001
8003
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8002
8004
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8003
8005
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
8004
- }>]>, t.TypeC<{
8005
- goStakingRequestId: t.StringC;
8006
8006
  }>]>, t.TypeC<{
8007
8007
  intentType: t.LiteralC<"goUnstake">;
8008
8008
  recipients: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -8025,7 +8025,9 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
8025
8025
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
8026
8026
  }>, t.TypeC<{
8027
8027
  memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8028
- }>]>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
8028
+ }>]>, t.PartialC<{
8029
+ goStakingRequestId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8030
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
8029
8031
  intentType: t.KeyofC<{
8030
8032
  payment: t.LiteralC<"payment">;
8031
8033
  transferToken: t.LiteralC<"transferToken">;
@@ -8909,7 +8911,7 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
8909
8911
  }>]>, t.TypeC<{
8910
8912
  intentType: t.LiteralC<"customTx">;
8911
8913
  rawTx: t.StringC;
8912
- }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
8914
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
8913
8915
  intentType: t.KeyofC<{
8914
8916
  payment: t.LiteralC<"payment">;
8915
8917
  transferToken: t.LiteralC<"transferToken">;
@@ -8982,8 +8984,6 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
8982
8984
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8983
8985
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
8984
8986
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
8985
- }>]>, t.TypeC<{
8986
- goStakingRequestId: t.StringC;
8987
8987
  }>]>, t.TypeC<{
8988
8988
  intentType: t.LiteralC<"goUnstake">;
8989
8989
  recipients: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -9075,6 +9075,81 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
9075
9075
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
9076
9076
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
9077
9077
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
9078
+ }>]>, t.TypeC<{
9079
+ goStakingRequestId: t.StringC;
9080
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
9081
+ intentType: t.KeyofC<{
9082
+ payment: t.LiteralC<"payment">;
9083
+ transferToken: t.LiteralC<"transferToken">;
9084
+ consolidate: t.LiteralC<"consolidate">;
9085
+ consolidateToken: t.LiteralC<"consolidateToken">;
9086
+ fanout: t.LiteralC<"fanout">;
9087
+ stake: t.LiteralC<"stake">;
9088
+ unstake: t.LiteralC<"unstake">;
9089
+ delegate: t.LiteralC<"delegate">;
9090
+ undelegate: t.LiteralC<"undelegate">;
9091
+ switchValidator: t.LiteralC<"switchValidator">;
9092
+ claim: t.LiteralC<"claim">;
9093
+ stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
9094
+ pledge: t.LiteralC<"pledge">;
9095
+ voteDelegation: t.LiteralC<"voteDelegation">;
9096
+ vote: t.LiteralC<"vote">;
9097
+ createAccount: t.LiteralC<"createAccount">;
9098
+ updateAccount: t.LiteralC<"updateAccount">;
9099
+ addTrustLine: t.LiteralC<"addTrustLine">;
9100
+ removeTrustLine: t.LiteralC<"removeTrustLine">;
9101
+ signMessage: t.LiteralC<"signMessage">;
9102
+ signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
9103
+ enableToken: t.LiteralC<"enableToken">;
9104
+ authorize: t.LiteralC<"authorize">;
9105
+ acceleration: t.LiteralC<"acceleration">;
9106
+ fillNonce: t.LiteralC<"fillNonce">;
9107
+ walletRecovery: t.LiteralC<"walletRecovery">;
9108
+ contractCall: t.LiteralC<"contractCall">;
9109
+ deactivate: t.LiteralC<"deactivate">;
9110
+ customTx: t.LiteralC<"customTx">;
9111
+ closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
9112
+ stakeWithCallData: t.LiteralC<"stakeWithCallData">;
9113
+ unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
9114
+ switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
9115
+ feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
9116
+ tokenApproval: t.LiteralC<"tokenApproval">;
9117
+ transferStake: t.LiteralC<"transferStake">;
9118
+ validatorRegistration: t.LiteralC<"validatorRegistration">;
9119
+ increaseStake: t.LiteralC<"increaseStake">;
9120
+ decreaseStake: t.LiteralC<"decreaseStake">;
9121
+ signalExit: t.LiteralC<"signalExit">;
9122
+ withdrawStake: t.LiteralC<"withdrawStake">;
9123
+ spotTransfer: t.LiteralC<"spotTransfer">;
9124
+ bridgeFunds: t.LiteralC<"bridgeFunds">;
9125
+ enableBridging: t.LiteralC<"enableBridging">;
9126
+ goUnstake: t.LiteralC<"goUnstake">;
9127
+ createBtcDelegation: t.LiteralC<"createBtcDelegation">;
9128
+ transferAccept: t.LiteralC<"transferAccept">;
9129
+ transferReject: t.LiteralC<"transferReject">;
9130
+ transferAcknowledge: t.LiteralC<"transferAcknowledge">;
9131
+ transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
9132
+ cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
9133
+ cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
9134
+ allocationRequest: t.LiteralC<"allocationRequest">;
9135
+ cantonCommand: t.LiteralC<"cantonCommand">;
9136
+ allocationAllocate: t.LiteralC<"allocationAllocate">;
9137
+ cantonEndInvestorOnboardingOffer: t.LiteralC<"cantonEndInvestorOnboardingOffer">;
9138
+ cantonEndInvestorOnboardingAccept: t.LiteralC<"cantonEndInvestorOnboardingAccept">;
9139
+ cantonEndInvestorOnboardingReject: t.LiteralC<"cantonEndInvestorOnboardingReject">;
9140
+ "defi-deposit": t.LiteralC<"defi-deposit">;
9141
+ "defi-redeem": t.LiteralC<"defi-redeem">;
9142
+ "defi-approve": t.LiteralC<"defi-approve">;
9143
+ delegateResource: t.LiteralC<"delegateResource">;
9144
+ undelegateResource: t.LiteralC<"undelegateResource">;
9145
+ export: t.LiteralC<"export">;
9146
+ import: t.LiteralC<"import">;
9147
+ importtoc: t.LiteralC<"importtoc">;
9148
+ }>;
9149
+ }>, t.PartialC<{
9150
+ sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
9151
+ comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
9152
+ nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
9078
9153
  }>]>, t.TypeC<{
9079
9154
  feeOptions: t.TypeC<{
9080
9155
  gasLimit: t.NumberC;
@@ -22073,6 +22148,7 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
22073
22148
  memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22074
22149
  }>]>, t.TypeC<{
22075
22150
  intentType: t.LiteralC<"deactivate">;
22151
+ }>, t.PartialC<{
22076
22152
  stakingAddresses: t.UnionC<[t.Type<string[], string[], unknown>, t.UndefinedC]>;
22077
22153
  stakingAddress: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22078
22154
  }>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
@@ -22155,9 +22231,10 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
22155
22231
  }>]>, t.TypeC<{
22156
22232
  intentType: t.LiteralC<"delegate">;
22157
22233
  validatorAddress: t.StringC;
22234
+ }>, t.PartialC<{
22158
22235
  stakingAddresses: t.UnionC<[t.Type<string[], string[], unknown>, t.UndefinedC]>;
22159
22236
  stakingAddress: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22160
- }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
22237
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
22161
22238
  intentType: t.KeyofC<{
22162
22239
  payment: t.LiteralC<"payment">;
22163
22240
  transferToken: t.LiteralC<"transferToken">;
@@ -22230,8 +22307,6 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
22230
22307
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22231
22308
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22232
22309
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
22233
- }>]>, t.TypeC<{
22234
- goStakingRequestId: t.StringC;
22235
22310
  }>]>, t.TypeC<{
22236
22311
  intentType: t.LiteralC<"goUnstake">;
22237
22312
  recipients: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -22254,7 +22329,9 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
22254
22329
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
22255
22330
  }>, t.TypeC<{
22256
22331
  memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22257
- }>]>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
22332
+ }>]>, t.PartialC<{
22333
+ goStakingRequestId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
22334
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
22258
22335
  intentType: t.KeyofC<{
22259
22336
  payment: t.LiteralC<"payment">;
22260
22337
  transferToken: t.LiteralC<"transferToken">;
@@ -23138,7 +23215,7 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
23138
23215
  }>]>, t.TypeC<{
23139
23216
  intentType: t.LiteralC<"customTx">;
23140
23217
  rawTx: t.StringC;
23141
- }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
23218
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
23142
23219
  intentType: t.KeyofC<{
23143
23220
  payment: t.LiteralC<"payment">;
23144
23221
  transferToken: t.LiteralC<"transferToken">;
@@ -23211,8 +23288,6 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
23211
23288
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23212
23289
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23213
23290
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
23214
- }>]>, t.TypeC<{
23215
- goStakingRequestId: t.StringC;
23216
23291
  }>]>, t.TypeC<{
23217
23292
  intentType: t.LiteralC<"goUnstake">;
23218
23293
  recipients: t.ArrayC<t.IntersectionC<[t.TypeC<{
@@ -23304,6 +23379,81 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
23304
23379
  sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23305
23380
  comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23306
23381
  nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
23382
+ }>]>, t.TypeC<{
23383
+ goStakingRequestId: t.StringC;
23384
+ }>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
23385
+ intentType: t.KeyofC<{
23386
+ payment: t.LiteralC<"payment">;
23387
+ transferToken: t.LiteralC<"transferToken">;
23388
+ consolidate: t.LiteralC<"consolidate">;
23389
+ consolidateToken: t.LiteralC<"consolidateToken">;
23390
+ fanout: t.LiteralC<"fanout">;
23391
+ stake: t.LiteralC<"stake">;
23392
+ unstake: t.LiteralC<"unstake">;
23393
+ delegate: t.LiteralC<"delegate">;
23394
+ undelegate: t.LiteralC<"undelegate">;
23395
+ switchValidator: t.LiteralC<"switchValidator">;
23396
+ claim: t.LiteralC<"claim">;
23397
+ stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
23398
+ pledge: t.LiteralC<"pledge">;
23399
+ voteDelegation: t.LiteralC<"voteDelegation">;
23400
+ vote: t.LiteralC<"vote">;
23401
+ createAccount: t.LiteralC<"createAccount">;
23402
+ updateAccount: t.LiteralC<"updateAccount">;
23403
+ addTrustLine: t.LiteralC<"addTrustLine">;
23404
+ removeTrustLine: t.LiteralC<"removeTrustLine">;
23405
+ signMessage: t.LiteralC<"signMessage">;
23406
+ signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
23407
+ enableToken: t.LiteralC<"enableToken">;
23408
+ authorize: t.LiteralC<"authorize">;
23409
+ acceleration: t.LiteralC<"acceleration">;
23410
+ fillNonce: t.LiteralC<"fillNonce">;
23411
+ walletRecovery: t.LiteralC<"walletRecovery">;
23412
+ contractCall: t.LiteralC<"contractCall">;
23413
+ deactivate: t.LiteralC<"deactivate">;
23414
+ customTx: t.LiteralC<"customTx">;
23415
+ closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
23416
+ stakeWithCallData: t.LiteralC<"stakeWithCallData">;
23417
+ unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
23418
+ switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
23419
+ feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
23420
+ tokenApproval: t.LiteralC<"tokenApproval">;
23421
+ transferStake: t.LiteralC<"transferStake">;
23422
+ validatorRegistration: t.LiteralC<"validatorRegistration">;
23423
+ increaseStake: t.LiteralC<"increaseStake">;
23424
+ decreaseStake: t.LiteralC<"decreaseStake">;
23425
+ signalExit: t.LiteralC<"signalExit">;
23426
+ withdrawStake: t.LiteralC<"withdrawStake">;
23427
+ spotTransfer: t.LiteralC<"spotTransfer">;
23428
+ bridgeFunds: t.LiteralC<"bridgeFunds">;
23429
+ enableBridging: t.LiteralC<"enableBridging">;
23430
+ goUnstake: t.LiteralC<"goUnstake">;
23431
+ createBtcDelegation: t.LiteralC<"createBtcDelegation">;
23432
+ transferAccept: t.LiteralC<"transferAccept">;
23433
+ transferReject: t.LiteralC<"transferReject">;
23434
+ transferAcknowledge: t.LiteralC<"transferAcknowledge">;
23435
+ transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
23436
+ cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
23437
+ cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
23438
+ allocationRequest: t.LiteralC<"allocationRequest">;
23439
+ cantonCommand: t.LiteralC<"cantonCommand">;
23440
+ allocationAllocate: t.LiteralC<"allocationAllocate">;
23441
+ cantonEndInvestorOnboardingOffer: t.LiteralC<"cantonEndInvestorOnboardingOffer">;
23442
+ cantonEndInvestorOnboardingAccept: t.LiteralC<"cantonEndInvestorOnboardingAccept">;
23443
+ cantonEndInvestorOnboardingReject: t.LiteralC<"cantonEndInvestorOnboardingReject">;
23444
+ "defi-deposit": t.LiteralC<"defi-deposit">;
23445
+ "defi-redeem": t.LiteralC<"defi-redeem">;
23446
+ "defi-approve": t.LiteralC<"defi-approve">;
23447
+ delegateResource: t.LiteralC<"delegateResource">;
23448
+ undelegateResource: t.LiteralC<"undelegateResource">;
23449
+ export: t.LiteralC<"export">;
23450
+ import: t.LiteralC<"import">;
23451
+ importtoc: t.LiteralC<"importtoc">;
23452
+ }>;
23453
+ }>, t.PartialC<{
23454
+ sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23455
+ comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
23456
+ nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
23307
23457
  }>]>, t.TypeC<{
23308
23458
  feeOptions: t.TypeC<{
23309
23459
  gasLimit: t.NumberC;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bitgo/public-types",
3
- "version": "6.28.0",
3
+ "version": "6.29.0",
4
4
  "description": "Collection of types exposed externally as part of the BitGo public API",
5
5
  "license": "UNLICENSED",
6
6
  "author": "",
@@ -2,16 +2,15 @@ import * as t from "io-ts";
2
2
  import { BaseIntent } from "./baseIntent";
3
3
 
4
4
  /**
5
- * @title BaseGoStakeIntent
6
- *
7
- * @description base interface for Go staking intents.
8
- *
9
- * @param {string} goStakingRequestId - The unique identifier for the Go staking request.
5
+ * Base interface for GO wallet staking intents that require a GO staking
6
+ * request identifier (e.g. admin/internal go-unstake flows such as Sui).
10
7
  *
8
+ * @title BaseGoStakeIntent
11
9
  */
12
10
  export const BaseGoStakeIntent = t.intersection([
13
11
  BaseIntent,
14
12
  t.type({
13
+ /** Internal coordination identifier for the GO staking request. */
15
14
  goStakingRequestId: t.string,
16
15
  }),
17
16
  ]);
@@ -6,7 +6,9 @@ import { TokenEnablement } from "./tokenEnablement";
6
6
  export const EnableTokenIntent = t.intersection([
7
7
  BaseIntent,
8
8
  t.type({
9
+ /** Must be "enableToken". */
9
10
  intentType: intentTypes.enableToken,
11
+ /** One or more token entries specifying which tokens to enable. */
10
12
  enableTokens: t.array(TokenEnablement),
11
13
  }),
12
14
  ]);
@@ -1,20 +1,21 @@
1
1
  import * as t from "io-ts";
2
2
  import { RecipientEntry } from "./recipientEntry";
3
3
  import { intentTypes } from "./intentType";
4
- import { BaseGoStakeIntent } from "./baseGoStakeIntent";
4
+ import { BaseIntent } from "./baseIntent";
5
5
 
6
6
  /**
7
- * @title GoUnstakeIntent
8
- *
9
- * @description interface for Go unstake intents.
10
- *
11
- * @param {RecipientEntry[]} recipients - An array of recipient entries, for the address and amount.
7
+ * Base intent for GO wallet unstaking operations. Chain-specific go-unstake
8
+ * intents (e.g. Sol, Sui) compose this and declare `goStakingRequestId`
9
+ * according to their own requirements (optional for Sol, required for Sui).
12
10
  *
11
+ * @title GoUnstakeIntent
13
12
  */
14
13
  export const GoUnstakeIntent = t.intersection([
15
- BaseGoStakeIntent,
14
+ BaseIntent,
16
15
  t.type({
16
+ /** Must be "goUnstake". */
17
17
  intentType: intentTypes.goUnstake,
18
+ /** The recipients to send unstaked funds to. */
18
19
  recipients: t.array(RecipientEntry),
19
20
  }),
20
21
  ]);
@@ -4,20 +4,31 @@ import { BaseIntent } from "./baseIntent";
4
4
  import { intentTypes } from "./intentType";
5
5
 
6
6
  /**
7
+ * Transfer the withdrawal and lockup authority of a SOL stake account to new public keys on Solana. The transactionMessage must be a pre-signed serialized transaction validated by the platform against all provided address fields. Spending policy is not evaluated for this intent. Requires the solStakingAuthorize enterprise feature flag.
8
+ *
7
9
  * @title SOL Authorize Intent
8
10
  */
9
11
  export const SolAuthorizeIntent = t.intersection([
10
12
  BaseIntent,
11
13
  SolBuildOptions,
12
14
  t.type({
15
+ /** Must be "authorize". */
13
16
  intentType: intentTypes.authorize,
17
+ /** The pre-signed serialized transaction message, validated by the platform against the provided address fields. */
14
18
  transactionMessage: t.string,
19
+ /** The on-chain stake account whose authority is being transferred. */
15
20
  stakeAccount: t.string,
21
+ /** The current withdrawal authority public key. */
16
22
  oldWithdrawPublicKey: t.string,
23
+ /** The new withdrawal authority public key. */
17
24
  newWithdrawPublicKey: t.string,
25
+ /** The lockup authority public key. */
18
26
  lockupPublicKey: t.string,
27
+ /** The durable nonce account used for this transaction. */
19
28
  nonceAccount: t.string,
29
+ /** The authority of the nonce account. */
20
30
  nonceAuthority: t.string,
31
+ /** The recent blockhash used in the transaction message. */
21
32
  blockhash: t.string,
22
33
  }),
23
34
  ]);
@@ -19,6 +19,7 @@ import { AccountBaseBuildOptions } from "./accountBaseBuildOptions";
19
19
  export const SolBuildOptions = t.intersection([
20
20
  AccountBaseBuildOptions,
21
21
  t.type({
22
+ /** Memo string for the transaction. The key must be present; pass an empty string (or omit the value) if unused. */
22
23
  memo: optionalString,
23
24
  }),
24
25
  ]);
@@ -4,6 +4,8 @@ import { WithdrawIntent } from "./withdrawIntent";
4
4
  import { BaseIntentWithAmount } from "./baseIntent";
5
5
 
6
6
  /**
7
+ * Withdraw the balance from a deactivated SOL stake account back to the wallet on Solana. The stake account must have been deactivated (unstaked) before claiming. Spending policy is not evaluated for this intent.
8
+ *
7
9
  * @title SOL Claim Intent
8
10
  */
9
11
  export const SolClaimIntent = t.intersection([
@@ -11,6 +13,7 @@ export const SolClaimIntent = t.intersection([
11
13
  SolBuildOptions,
12
14
  BaseIntentWithAmount,
13
15
  t.type({
16
+ /** The on-chain stake account address to withdraw from. */
14
17
  stakingAddress: t.string,
15
18
  }),
16
19
  ]);
@@ -117,6 +117,8 @@ const solCloseAssociatedTokenAccountRecipients = t.brand(
117
117
  );
118
118
 
119
119
  /**
120
+ * Close one or more zero-balance SPL Associated Token Accounts (ATAs) on Solana and recover their rent lamports to the wallet root address. All ATAs must have a zero token balance (consolidate tokens first), share the same on-chain owner, and be owned by this wallet. Maximum 27 distinct ATAs per transaction. Spending policy is not evaluated for this intent.
121
+ *
120
122
  * @title SOL Close Associated Token Account Intent
121
123
  *
122
124
  * After `decode`, prefer annotating or threading values as the exported
@@ -129,7 +131,9 @@ export const SolCloseAssociatedTokenAccountIntent = t.intersection([
129
131
  BaseIntent,
130
132
  SolBuildOptions,
131
133
  t.type({
134
+ /** Must be "closeAssociatedTokenAccount". */
132
135
  intentType: intentTypes.closeAssociatedTokenAccount,
136
+ /** One or more zero-balance ATAs to close. Each entry must have amount.value === "0", must not carry tokenName or tokenData, and all entries must share the same on-chain owner. Maximum 27 ATAs per transaction. */
133
137
  recipients: solCloseAssociatedTokenAccountRecipients,
134
138
  }),
135
139
  ]);
@@ -2,6 +2,8 @@ import * as t from "io-ts";
2
2
  import { AccountBaseConsolidateIntent } from "./accountBaseConsolidateIntent";
3
3
 
4
4
  /**
5
+ * Sweep native SOL and SPL token balances from a receive address into the wallet's root address on Solana. The platform automatically calculates transferable amounts, reserving rent-exempt minimums and transaction fees.
6
+ *
5
7
  * @title SOL Consolidate Intent
6
8
  */
7
9
  export const SolConsolidateIntent = AccountBaseConsolidateIntent;
@@ -3,6 +3,8 @@ import { SolBuildOptions } from "./solBuildOptions";
3
3
  import { EnableTokenIntent } from "./enableTokenIntent";
4
4
 
5
5
  /**
6
+ * Initialize one or more Associated Token Accounts (ATAs) on Solana so the wallet can receive SPL tokens. All entries in enableTokens must target the same wallet address. Spending policy is not evaluated for this intent.
7
+ *
6
8
  * @title SOL Create Associated Token Account Intent
7
9
  */
8
10
  export const SolCreateAssociatedTokenAccountIntent = t.intersection([
@@ -4,23 +4,33 @@ import { BaseIntent } from "./baseIntent";
4
4
  import { intentTypes } from "./intentType";
5
5
 
6
6
  /**
7
+ * Submit a custom Solana transaction using raw legacy program instructions. Use this intent for legacy (non-versioned) transactions; for versioned transactions (address lookup tables, v0 messages) use the customTx intent with solVersionedTransactionData instead. Wallets without the enableSolCustomTx flag require a second admin approval before the transaction is processed.
8
+ *
7
9
  * @title SOL Custom Transaction Intent
8
10
  */
9
11
  export const SolCustomTxIntent = t.intersection([
10
12
  BaseIntent,
11
13
  SolBuildOptions,
12
14
  t.type({
15
+ /** Must be "customTx". For legacy (non-versioned) transactions only; use SolVersionedCustomTxIntent for versioned transactions. */
13
16
  intentType: intentTypes.customTx,
17
+ /** Array of raw Solana program instructions to include in the transaction. Use for legacy (non-versioned) transactions only. */
14
18
  solInstructions: t.array(
15
19
  t.type({
20
+ /** The program ID to invoke. */
16
21
  programId: t.string,
22
+ /** Account keys referenced by this instruction. */
17
23
  keys: t.array(
18
24
  t.type({
25
+ /** The account public key. */
19
26
  pubkey: t.string,
27
+ /** Whether this account is a signer. */
20
28
  isSigner: t.boolean,
29
+ /** Whether this account is writable. */
21
30
  isWritable: t.boolean,
22
31
  }),
23
32
  ),
33
+ /** Instruction data encoded as base58 or hex. */
24
34
  data: t.string,
25
35
  }),
26
36
  ),
@@ -5,14 +5,21 @@ import { intentTypes } from "./intentType";
5
5
  import { optionalString, optionalStringArray } from "../../../utils";
6
6
 
7
7
  /**
8
+ * Deactivate one or more SOL stake accounts on Solana to begin the cooldown period before funds can be claimed. No value is transferred. Provide either stakingAddress (single account) or stakingAddresses (batch). After cooldown completes, use the claim intent to withdraw. Spending policy is not evaluated for this intent. Requires the solStakingAuthorize enterprise feature flag.
9
+ *
8
10
  * @title SOL Deactivate Intent
9
11
  */
10
12
  export const SolDeactivateIntent = t.intersection([
11
13
  BaseIntent,
12
14
  SolBuildOptions,
13
15
  t.type({
16
+ /** Must be "deactivate". */
14
17
  intentType: intentTypes.deactivate,
18
+ }),
19
+ t.partial({
20
+ /** Batch of stake account addresses to deactivate. Provide either this or stakingAddress. */
15
21
  stakingAddresses: optionalStringArray,
22
+ /** A single stake account address to deactivate. Provide either this or stakingAddresses. */
16
23
  stakingAddress: optionalString,
17
24
  }),
18
25
  ]);
@@ -5,15 +5,23 @@ import { intentTypes } from "./intentType";
5
5
  import { optionalString, optionalStringArray } from "../../../utils";
6
6
 
7
7
  /**
8
+ * Delegate one or more deactivated SOL stake accounts to a validator on Solana. No value is transferred; this intent re-activates an existing stake account under a new or the same validator. Provide either stakingAddress (single account) or stakingAddresses (batch). Spending policy is not evaluated for this intent. Requires the solStakingAuthorize enterprise feature flag.
9
+ *
8
10
  * @title SOL Delegate Intent
9
11
  */
10
12
  export const SolDelegateIntent = t.intersection([
11
13
  BaseIntent,
12
14
  SolBuildOptions,
13
15
  t.type({
16
+ /** Must be "delegate". */
14
17
  intentType: intentTypes.delegate,
18
+ /** The validator vote account address to delegate to. */
15
19
  validatorAddress: t.string,
20
+ }),
21
+ t.partial({
22
+ /** Batch of stake account addresses to delegate. Provide either this or stakingAddress. */
16
23
  stakingAddresses: optionalStringArray,
24
+ /** A single stake account address to delegate. Provide either this or stakingAddresses. */
17
25
  stakingAddress: optionalString,
18
26
  }),
19
27
  ]);
@@ -1,16 +1,20 @@
1
1
  import * as t from "io-ts";
2
2
  import { SolBuildOptions } from "./solBuildOptions";
3
3
  import { GoUnstakeIntent } from "./goUnstakeIntent";
4
+ import { optionalString } from "../../../utils";
4
5
 
5
6
  /**
6
- * @title SolGoUnstakeIntent
7
- *
8
- * @description Unstake intent for GO wallets for the Solana blockchain.
7
+ * Unstake SOL via the GO wallet program on Solana and transfer the proceeds to the specified recipients. This intent uses the same transfer path as the payment intent.
9
8
  *
9
+ * @title SOL Go Unstake Intent
10
10
  */
11
11
  export const SolGoUnstakeIntent = t.intersection([
12
12
  GoUnstakeIntent,
13
13
  SolBuildOptions,
14
+ t.partial({
15
+ /** Internal coordination identifier for the GO staking request. Accepted by the schema but only processed on admin/internal routes — external API consumers should omit this field. */
16
+ goStakingRequestId: optionalString,
17
+ }),
14
18
  ]);
15
19
 
16
20
  export type SolGoUnstakeIntent = t.TypeOf<typeof SolGoUnstakeIntent>;
@@ -2,6 +2,11 @@ import * as t from "io-ts";
2
2
  import { PaymentIntent } from "./paymentIntent";
3
3
  import { SolBuildOptions } from "./solBuildOptions";
4
4
 
5
+ /**
6
+ * Transfer native SOL or SPL tokens to one or more recipients on Solana. For token transfers, the recipient amount symbol must use the "sol:tokenName" format (e.g. "sol:usdc"). Native SOL recipients must not be Associated Token Account (ATA) addresses.
7
+ *
8
+ * @title SOL Payment Intent
9
+ */
5
10
  export const SolPaymentIntent = t.intersection([
6
11
  PaymentIntent,
7
12
  SolBuildOptions,
@@ -6,6 +6,8 @@ import { Optional } from "../../../utils";
6
6
  import { SolStakingType } from "./solStakingType";
7
7
 
8
8
  /**
9
+ * Stake SOL to a validator on Solana by creating a new stake account. The platform generates an ephemeral keypair for the stake account and whitelists it on the wallet. Requires the enterprise to have staking permissions. Supports native, Marinade liquid, and Jito staking via the stakingType field.
10
+ *
9
11
  * @title SOL Stake Intent
10
12
  */
11
13
  export const SolStakeIntent = t.intersection([
@@ -13,14 +15,13 @@ export const SolStakeIntent = t.intersection([
13
15
  SolBuildOptions,
14
16
  BaseIntentWithAmount,
15
17
  t.type({
18
+ /** The validator vote account address to stake SOL with. */
16
19
  validatorAddress: t.string,
17
20
  /**
18
21
  * @deprecated Use `stakingType` instead.
19
22
  */
20
23
  isMarinade: Optional(t.boolean),
21
- /**
22
- * @todo Remove Optional once staking-service is updated.
23
- */
24
+ /** The staking provider type. Accepted values: "NATIVE", "MARINADE", "JITO". Supersedes the deprecated isMarinade field. */
24
25
  stakingType: Optional(SolStakingType),
25
26
  }),
26
27
  ]);
@@ -7,25 +7,29 @@ import { RecipientEntry } from "./recipientEntry";
7
7
  import { SolStakingType } from "./solStakingType";
8
8
 
9
9
  /**
10
+ * Begin deactivating a SOL stake account on Solana. For native staking, the stake account enters a cooldown period before funds can be claimed. For partial unstakes, provide both amount and remainingStakingAmount to split the stake account. Supports native, Marinade liquid, and Jito staking via the stakingType field. Requires the enterprise to have staking permissions.
11
+ *
10
12
  * @title SOL Unstake Intent
11
13
  */
12
14
  export const SolUnstakeIntent = t.intersection([
13
15
  UnstakeIntent,
14
16
  SolBuildOptions,
15
17
  t.type({
18
+ /** The stake account address to deactivate. */
16
19
  stakingAddress: t.string,
17
20
  }),
18
21
  t.partial({
22
+ /** For partial unstake: the amount to remove from the stake account. Must be provided together with remainingStakingAmount. */
19
23
  amount: Optional(Amount),
24
+ /** For partial unstake: the amount to keep in the existing stake account after the split. Must be provided together with amount. */
20
25
  remainingStakingAmount: Optional(Amount),
21
26
  /**
22
27
  * @deprecated Use `stakingType` instead.
23
28
  */
24
29
  isMarinade: Optional(t.boolean),
25
- /**
26
- * @todo Remove Optional once staking-service is updated.
27
- */
30
+ /** The staking provider type. Accepted values: "NATIVE", "MARINADE", "JITO". Supersedes the deprecated isMarinade field. */
28
31
  stakingType: Optional(SolStakingType),
32
+ /** Required for Marinade unstaking: the recipient address to receive the unstaked SOL. */
29
33
  recipients: Optional(t.array(RecipientEntry)),
30
34
  }),
31
35
  ]);