@cobo/cobo-waas2 1.1.1
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.
- package/README.md +414 -0
- package/dist/ApiClient.js +747 -0
- package/dist/Env.js +19 -0
- package/dist/api/DevelopersWebhooksApi.js +508 -0
- package/dist/api/OAuthApi.js +145 -0
- package/dist/api/TransactionsApi.js +542 -0
- package/dist/api/WalletsApi.js +1200 -0
- package/dist/api/WalletsMPCWalletsApi.js +955 -0
- package/dist/crypto/ApiSigner.js +52 -0
- package/dist/index.js +1742 -0
- package/dist/model/Activity.js +302 -0
- package/dist/model/ActivityAction.js +66 -0
- package/dist/model/ActivityInitiator.js +87 -0
- package/dist/model/ActivityStatus.js +66 -0
- package/dist/model/ActivityTimeline.js +140 -0
- package/dist/model/ActivityType.js +81 -0
- package/dist/model/AddressEncoding.js +86 -0
- package/dist/model/AddressInfo.js +174 -0
- package/dist/model/AddressTransferDestination.js +182 -0
- package/dist/model/AddressTransferDestinationAccountOutput.js +138 -0
- package/dist/model/AddressTransferDestinationUtxoOutputsInner.js +136 -0
- package/dist/model/AmountDetailsInner.js +134 -0
- package/dist/model/AmountStatus.js +96 -0
- package/dist/model/AssetBalance.js +127 -0
- package/dist/model/AssetInfo.js +150 -0
- package/dist/model/BabylonStakeExtra.js +142 -0
- package/dist/model/BabylonValidator.js +199 -0
- package/dist/model/BaseContractCallSource.js +137 -0
- package/dist/model/BaseEstimateStakingFee.js +106 -0
- package/dist/model/BaseStakeExtra.js +107 -0
- package/dist/model/ChainInfo.js +172 -0
- package/dist/model/CheckAddressValidity200Response.js +106 -0
- package/dist/model/CoboSafeDelegate.js +143 -0
- package/dist/model/CoboSafeDelegateType.js +61 -0
- package/dist/model/ContractCallDestination.js +149 -0
- package/dist/model/ContractCallDestinationType.js +56 -0
- package/dist/model/ContractCallParams.js +198 -0
- package/dist/model/ContractCallSource.js +171 -0
- package/dist/model/ContractCallSourceType.js +66 -0
- package/dist/model/CreateAddressRequest.js +131 -0
- package/dist/model/CreateCustodialWalletParams.js +133 -0
- package/dist/model/CreateExchangeWalletParams.js +257 -0
- package/dist/model/CreateKeyShareHolder.js +119 -0
- package/dist/model/CreateKeyShareHolderGroupRequest.js +160 -0
- package/dist/model/CreateMpcProjectRequest.js +132 -0
- package/dist/model/CreateMpcVaultRequest.js +134 -0
- package/dist/model/CreateMpcWalletParams.js +166 -0
- package/dist/model/CreateSafeWalletParams.js +220 -0
- package/dist/model/CreateSmartContractWalletParams.js +185 -0
- package/dist/model/CreateStakeActivity.js +171 -0
- package/dist/model/CreateStakeActivityExtra.js +187 -0
- package/dist/model/CreateTransferTransaction201Response.js +136 -0
- package/dist/model/CreateTssRequestRequest.js +135 -0
- package/dist/model/CreateUnstakeActivity.js +137 -0
- package/dist/model/CreateWalletParams.js +229 -0
- package/dist/model/CreateWebhookEndpointRequest.js +139 -0
- package/dist/model/CreateWithdrawActivity.js +152 -0
- package/dist/model/CreatedWalletInfo.js +217 -0
- package/dist/model/CurveType.js +61 -0
- package/dist/model/CustodialTransferSource.js +122 -0
- package/dist/model/CustodialWalletInfo.js +163 -0
- package/dist/model/DeleteKeyShareHolderGroupById201Response.js +106 -0
- package/dist/model/DeleteWalletById201Response.js +106 -0
- package/dist/model/EigenLayerLstStakeExtra.js +129 -0
- package/dist/model/EigenLayerNativeStakeExtra.js +125 -0
- package/dist/model/EigenlayerValidator.js +159 -0
- package/dist/model/ErrorResponse.js +137 -0
- package/dist/model/EstimateContractCallFeeParams.js +178 -0
- package/dist/model/EstimateFeeParams.js +183 -0
- package/dist/model/EstimateFeeRequestType.js +61 -0
- package/dist/model/EstimateStakeFee.js +219 -0
- package/dist/model/EstimateTransferFeeParams.js +178 -0
- package/dist/model/EstimateUnstakeFee.js +177 -0
- package/dist/model/EstimateWithdrawFee.js +197 -0
- package/dist/model/EstimatedEvmEip1559Fee.js +164 -0
- package/dist/model/EstimatedEvmEip1559FeeSlow.js +168 -0
- package/dist/model/EstimatedEvmLegacyFee.js +164 -0
- package/dist/model/EstimatedEvmLegacyFeeSlow.js +148 -0
- package/dist/model/EstimatedFee.js +213 -0
- package/dist/model/EstimatedFixedFee.js +157 -0
- package/dist/model/EstimatedUtxoFee.js +164 -0
- package/dist/model/EstimatedUtxoFeeSlow.js +146 -0
- package/dist/model/EvmContractCallDestination.js +146 -0
- package/dist/model/EvmEIP191MessageSignDestination.js +122 -0
- package/dist/model/EvmEIP712MessageSignDestination.js +120 -0
- package/dist/model/EvmEip1559FeeBasePrice.js +101 -0
- package/dist/model/EvmEip1559FeeRate.js +164 -0
- package/dist/model/EvmLegacyFeeBasePrice.js +88 -0
- package/dist/model/EvmLegacyFeeRate.js +164 -0
- package/dist/model/ExchangeId.js +76 -0
- package/dist/model/ExchangeTransferDestination.js +152 -0
- package/dist/model/ExchangeTransferSource.js +137 -0
- package/dist/model/ExchangeWalletInfo.js +230 -0
- package/dist/model/ExtendedTokenInfo.js +294 -0
- package/dist/model/FeeAmount.js +88 -0
- package/dist/model/FeeGasLimit.js +88 -0
- package/dist/model/FeeRate.js +207 -0
- package/dist/model/FeeType.js +71 -0
- package/dist/model/FixedFeeRate.js +146 -0
- package/dist/model/GetToken200Response.js +135 -0
- package/dist/model/GetToken4XXResponse.js +124 -0
- package/dist/model/KeyShareHolder.js +137 -0
- package/dist/model/KeyShareHolderGroup.js +196 -0
- package/dist/model/KeyShareHolderGroupStatus.js +66 -0
- package/dist/model/KeyShareHolderGroupType.js +66 -0
- package/dist/model/KeyShareHolderStatus.js +71 -0
- package/dist/model/KeyShareHolderType.js +66 -0
- package/dist/model/ListAddresses200Response.js +121 -0
- package/dist/model/ListKeyShareHolderGroups200Response.js +121 -0
- package/dist/model/ListMpcProjects200Response.js +121 -0
- package/dist/model/ListMpcVaults200Response.js +121 -0
- package/dist/model/ListSupportedChains200Response.js +121 -0
- package/dist/model/ListSupportedTokens200Response.js +121 -0
- package/dist/model/ListTokenBalancesForAddress200Response.js +121 -0
- package/dist/model/ListTransactions200Response.js +121 -0
- package/dist/model/ListTssRequests200Response.js +121 -0
- package/dist/model/ListUtxos200Response.js +121 -0
- package/dist/model/ListWallets200Response.js +121 -0
- package/dist/model/ListWebhookEndpoints200Response.js +121 -0
- package/dist/model/ListWebhookEventDefinitions200ResponseInner.js +96 -0
- package/dist/model/ListWebhookEventLogs200Response.js +121 -0
- package/dist/model/ListWebhookEvents200Response.js +121 -0
- package/dist/model/LockUtxos201Response.js +83 -0
- package/dist/model/LockUtxosRequest.js +127 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +136 -0
- package/dist/model/MPCDelegate.js +137 -0
- package/dist/model/MPCProject.js +141 -0
- package/dist/model/MPCVault.js +165 -0
- package/dist/model/MPCVaultType.js +61 -0
- package/dist/model/MPCWalletInfo.js +219 -0
- package/dist/model/MaxFeeAmount.js +88 -0
- package/dist/model/MaxTransferableValue.js +115 -0
- package/dist/model/MessageSignDestination.js +159 -0
- package/dist/model/MessageSignDestinationType.js +61 -0
- package/dist/model/MessageSignParams.js +184 -0
- package/dist/model/MessageSignSource.js +143 -0
- package/dist/model/MessageSignSourceType.js +61 -0
- package/dist/model/MpcContractCallSource.js +165 -0
- package/dist/model/MpcMessageSignSource.js +136 -0
- package/dist/model/MpcSigningGroup.js +101 -0
- package/dist/model/MpcTransferSource.js +194 -0
- package/dist/model/Pagination.js +137 -0
- package/dist/model/PoolDetails.js +363 -0
- package/dist/model/PoolDetailsAllOfValidatorsInfo.js +183 -0
- package/dist/model/PoolSummary.js +214 -0
- package/dist/model/RefreshTokenRequest.js +113 -0
- package/dist/model/ReplaceType.js +66 -0
- package/dist/model/RetryWebhookEventById201Response.js +83 -0
- package/dist/model/RootPubkey.js +97 -0
- package/dist/model/SafeContractCallSource.js +173 -0
- package/dist/model/SafeTransferSource.js +153 -0
- package/dist/model/SafeWallet.js +248 -0
- package/dist/model/SmartContractInitiator.js +126 -0
- package/dist/model/SmartContractWalletInfo.js +197 -0
- package/dist/model/SmartContractWalletOperationType.js +56 -0
- package/dist/model/SmartContractWalletType.js +56 -0
- package/dist/model/SourceGroup.js +124 -0
- package/dist/model/StakingPoolType.js +66 -0
- package/dist/model/StakingSource.js +171 -0
- package/dist/model/Stakings.js +295 -0
- package/dist/model/StakingsValidatorInfo.js +135 -0
- package/dist/model/SubWalletAssetBalance.js +140 -0
- package/dist/model/TSSGroups.js +110 -0
- package/dist/model/TSSRequest.js +133 -0
- package/dist/model/TSSRequestStatus.js +76 -0
- package/dist/model/TSSRequestType.js +66 -0
- package/dist/model/TokenBalance.js +127 -0
- package/dist/model/TokenBalanceBalance.js +154 -0
- package/dist/model/TokenInfo.js +231 -0
- package/dist/model/Transaction.js +443 -0
- package/dist/model/TransactionApprover.js +129 -0
- package/dist/model/TransactionBlockInfo.js +106 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +122 -0
- package/dist/model/TransactionDepositFromAddressSource.js +153 -0
- package/dist/model/TransactionDepositFromLoopSource.js +107 -0
- package/dist/model/TransactionDepositFromWalletSource.js +157 -0
- package/dist/model/TransactionDepositToAddressDestination.js +185 -0
- package/dist/model/TransactionDepositToWalletDestination.js +181 -0
- package/dist/model/TransactionDestination.js +329 -0
- package/dist/model/TransactionDestinationType.js +86 -0
- package/dist/model/TransactionDetail.js +607 -0
- package/dist/model/TransactionDetails.js +742 -0
- package/dist/model/TransactionEvmContractDestination.js +146 -0
- package/dist/model/TransactionEvmEip1559Fee.js +226 -0
- package/dist/model/TransactionEvmLegacyFee.js +195 -0
- package/dist/model/TransactionExchangeWalletSource.js +146 -0
- package/dist/model/TransactionFee.js +240 -0
- package/dist/model/TransactionFeeStationWalletSource.js +122 -0
- package/dist/model/TransactionFixedFee.js +157 -0
- package/dist/model/TransactionInitiatorType.js +71 -0
- package/dist/model/TransactionMPCWalletSource.js +194 -0
- package/dist/model/TransactionMessageSignEIP191Destination.js +122 -0
- package/dist/model/TransactionMessageSignEIP712Destination.js +120 -0
- package/dist/model/TransactionRawTxInfo.js +131 -0
- package/dist/model/TransactionRbf.js +167 -0
- package/dist/model/TransactionRbfSource.js +154 -0
- package/dist/model/TransactionReplacement.js +143 -0
- package/dist/model/TransactionRequestEvmEip1559Fee.js +182 -0
- package/dist/model/TransactionRequestEvmLegacyFee.js +162 -0
- package/dist/model/TransactionRequestFee.js +222 -0
- package/dist/model/TransactionRequestFixedFee.js +146 -0
- package/dist/model/TransactionRequestUtxoFee.js +161 -0
- package/dist/model/TransactionResend.js +111 -0
- package/dist/model/TransactionResult.js +137 -0
- package/dist/model/TransactionResultType.js +56 -0
- package/dist/model/TransactionSignatureResult.js +120 -0
- package/dist/model/TransactionSigner.js +147 -0
- package/dist/model/TransactionSmartContractSafeWalletSource.js +153 -0
- package/dist/model/TransactionSource.js +286 -0
- package/dist/model/TransactionSourceType.js +96 -0
- package/dist/model/TransactionStatus.js +106 -0
- package/dist/model/TransactionSubStatus.js +166 -0
- package/dist/model/TransactionTimeline.js +102 -0
- package/dist/model/TransactionTokeApproval.js +313 -0
- package/dist/model/TransactionTokenAmount.js +139 -0
- package/dist/model/TransactionTransferToAddressDestination.js +182 -0
- package/dist/model/TransactionTransferToAddressDestinationAccountOutput.js +113 -0
- package/dist/model/TransactionTransferToAddressDestinationUtxoOutputsInner.js +113 -0
- package/dist/model/TransactionTransferToWalletDestination.js +159 -0
- package/dist/model/TransactionType.js +76 -0
- package/dist/model/TransactionUtxo.js +97 -0
- package/dist/model/TransactionUtxoFee.js +170 -0
- package/dist/model/TransactionWebhookEventData.js +620 -0
- package/dist/model/TransferDestination.js +195 -0
- package/dist/model/TransferDestinationType.js +61 -0
- package/dist/model/TransferParams.js +198 -0
- package/dist/model/TransferSource.js +214 -0
- package/dist/model/UTXO.js +163 -0
- package/dist/model/UpdateCustodialWalletParams.js +120 -0
- package/dist/model/UpdateExchangeWalletParams.js +120 -0
- package/dist/model/UpdateGroupAction.js +56 -0
- package/dist/model/UpdateKeyShareHolderGroupByIdRequest.js +106 -0
- package/dist/model/UpdateMpcProjectByIdRequest.js +110 -0
- package/dist/model/UpdateMpcVaultByIdRequest.js +110 -0
- package/dist/model/UpdateMpcWalletParams.js +120 -0
- package/dist/model/UpdateSmartContractWalletParams.js +120 -0
- package/dist/model/UpdateWalletParams.js +185 -0
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +132 -0
- package/dist/model/UtxoFeeBasePrice.js +88 -0
- package/dist/model/UtxoFeeRate.js +164 -0
- package/dist/model/WalletInfo.js +235 -0
- package/dist/model/WalletSubtype.js +86 -0
- package/dist/model/WalletType.js +71 -0
- package/dist/model/WebhookEndpoint.js +175 -0
- package/dist/model/WebhookEndpointStatus.js +81 -0
- package/dist/model/WebhookEvent.js +189 -0
- package/dist/model/WebhookEventData.js +299 -0
- package/dist/model/WebhookEventDataType.js +129 -0
- package/dist/model/WebhookEventLog.js +204 -0
- package/dist/model/WebhookEventStatus.js +66 -0
- package/dist/model/WebhookEventType.js +71 -0
- package/docs/Activity.md +23 -0
- package/docs/ActivityAction.md +14 -0
- package/docs/ActivityInitiator.md +9 -0
- package/docs/ActivityStatus.md +14 -0
- package/docs/ActivityTimeline.md +12 -0
- package/docs/ActivityType.md +20 -0
- package/docs/AddressEncoding.md +22 -0
- package/docs/AddressInfo.md +14 -0
- package/docs/AddressTransferDestination.md +14 -0
- package/docs/AddressTransferDestinationAccountOutput.md +11 -0
- package/docs/AddressTransferDestinationUtxoOutputsInner.md +11 -0
- package/docs/AmountDetailsInner.md +11 -0
- package/docs/AmountStatus.md +26 -0
- package/docs/AssetBalance.md +10 -0
- package/docs/AssetInfo.md +12 -0
- package/docs/BabylonStakeExtra.md +11 -0
- package/docs/BabylonValidator.md +27 -0
- package/docs/BaseContractCallSource.md +11 -0
- package/docs/BaseEstimateStakingFee.md +9 -0
- package/docs/BaseStakeExtra.md +9 -0
- package/docs/ChainInfo.md +14 -0
- package/docs/CheckAddressValidity200Response.md +9 -0
- package/docs/CoboSafeDelegate.md +11 -0
- package/docs/CoboSafeDelegateType.md +12 -0
- package/docs/ContractCallDestination.md +12 -0
- package/docs/ContractCallDestinationType.md +10 -0
- package/docs/ContractCallParams.md +15 -0
- package/docs/ContractCallSource.md +13 -0
- package/docs/ContractCallSourceType.md +14 -0
- package/docs/CreateAddressRequest.md +11 -0
- package/docs/CreateCustodialWalletParams.md +11 -0
- package/docs/CreateExchangeWalletParams.md +19 -0
- package/docs/CreateKeyShareHolder.md +12 -0
- package/docs/CreateKeyShareHolderGroupRequest.md +12 -0
- package/docs/CreateMpcProjectRequest.md +11 -0
- package/docs/CreateMpcVaultRequest.md +11 -0
- package/docs/CreateMpcWalletParams.md +12 -0
- package/docs/CreateSafeWalletParams.md +18 -0
- package/docs/CreateSmartContractWalletParams.md +18 -0
- package/docs/CreateStakeActivity.md +13 -0
- package/docs/CreateStakeActivityExtra.md +13 -0
- package/docs/CreateTransferTransaction201Response.md +11 -0
- package/docs/CreateTssRequestRequest.md +11 -0
- package/docs/CreateUnstakeActivity.md +11 -0
- package/docs/CreateWalletParams.md +20 -0
- package/docs/CreateWebhookEndpointRequest.md +11 -0
- package/docs/CreateWithdrawActivity.md +12 -0
- package/docs/CreatedWalletInfo.md +18 -0
- package/docs/CurveType.md +12 -0
- package/docs/CustodialTransferSource.md +10 -0
- package/docs/CustodialWalletInfo.md +13 -0
- package/docs/DeleteKeyShareHolderGroupById201Response.md +9 -0
- package/docs/DeleteWalletById201Response.md +9 -0
- package/docs/DevelopersWebhooksApi.md +496 -0
- package/docs/EigenLayerLstStakeExtra.md +10 -0
- package/docs/EigenLayerNativeStakeExtra.md +10 -0
- package/docs/EigenlayerValidator.md +13 -0
- package/docs/ErrorResponse.md +11 -0
- package/docs/EstimateContractCallFeeParams.md +14 -0
- package/docs/EstimateFeeParams.md +15 -0
- package/docs/EstimateFeeRequestType.md +12 -0
- package/docs/EstimateStakeFee.md +14 -0
- package/docs/EstimateTransferFeeParams.md +14 -0
- package/docs/EstimateUnstakeFee.md +12 -0
- package/docs/EstimateWithdrawFee.md +13 -0
- package/docs/EstimatedEvmEip1559Fee.md +13 -0
- package/docs/EstimatedEvmEip1559FeeSlow.md +11 -0
- package/docs/EstimatedEvmLegacyFee.md +13 -0
- package/docs/EstimatedEvmLegacyFeeSlow.md +10 -0
- package/docs/EstimatedFee.md +15 -0
- package/docs/EstimatedFixedFee.md +12 -0
- package/docs/EstimatedUtxoFee.md +13 -0
- package/docs/EstimatedUtxoFeeSlow.md +10 -0
- package/docs/EvmContractCallDestination.md +12 -0
- package/docs/EvmEIP191MessageSignDestination.md +10 -0
- package/docs/EvmEIP712MessageSignDestination.md +10 -0
- package/docs/EvmEip1559FeeBasePrice.md +10 -0
- package/docs/EvmEip1559FeeRate.md +13 -0
- package/docs/EvmLegacyFeeBasePrice.md +9 -0
- package/docs/EvmLegacyFeeRate.md +13 -0
- package/docs/ExchangeId.md +18 -0
- package/docs/ExchangeTransferDestination.md +12 -0
- package/docs/ExchangeTransferSource.md +11 -0
- package/docs/ExchangeWalletInfo.md +16 -0
- package/docs/ExtendedTokenInfo.md +19 -0
- package/docs/FeeAmount.md +9 -0
- package/docs/FeeGasLimit.md +9 -0
- package/docs/FeeRate.md +14 -0
- package/docs/FeeType.md +16 -0
- package/docs/FixedFeeRate.md +11 -0
- package/docs/GetToken200Response.md +13 -0
- package/docs/GetToken4XXResponse.md +10 -0
- package/docs/KeyShareHolder.md +14 -0
- package/docs/KeyShareHolderGroup.md +16 -0
- package/docs/KeyShareHolderGroupStatus.md +14 -0
- package/docs/KeyShareHolderGroupType.md +14 -0
- package/docs/KeyShareHolderStatus.md +16 -0
- package/docs/KeyShareHolderType.md +14 -0
- package/docs/ListAddresses200Response.md +10 -0
- package/docs/ListKeyShareHolderGroups200Response.md +10 -0
- package/docs/ListMpcProjects200Response.md +10 -0
- package/docs/ListMpcVaults200Response.md +10 -0
- package/docs/ListSupportedChains200Response.md +10 -0
- package/docs/ListSupportedTokens200Response.md +10 -0
- package/docs/ListTokenBalancesForAddress200Response.md +10 -0
- package/docs/ListTransactions200Response.md +10 -0
- package/docs/ListTssRequests200Response.md +10 -0
- package/docs/ListUtxos200Response.md +10 -0
- package/docs/ListWallets200Response.md +10 -0
- package/docs/ListWebhookEndpoints200Response.md +10 -0
- package/docs/ListWebhookEventDefinitions200ResponseInner.md +10 -0
- package/docs/ListWebhookEventLogs200Response.md +10 -0
- package/docs/ListWebhookEvents200Response.md +10 -0
- package/docs/LockUtxos201Response.md +9 -0
- package/docs/LockUtxosRequest.md +9 -0
- package/docs/LockUtxosRequestUtxosInner.md +11 -0
- package/docs/MPCDelegate.md +11 -0
- package/docs/MPCProject.md +14 -0
- package/docs/MPCVault.md +14 -0
- package/docs/MPCVaultType.md +12 -0
- package/docs/MPCWalletInfo.md +15 -0
- package/docs/MaxFeeAmount.md +9 -0
- package/docs/MaxTransferableValue.md +11 -0
- package/docs/MessageSignDestination.md +11 -0
- package/docs/MessageSignDestinationType.md +12 -0
- package/docs/MessageSignParams.md +14 -0
- package/docs/MessageSignSource.md +11 -0
- package/docs/MessageSignSourceType.md +12 -0
- package/docs/MpcContractCallSource.md +12 -0
- package/docs/MpcMessageSignSource.md +11 -0
- package/docs/MpcSigningGroup.md +10 -0
- package/docs/MpcTransferSource.md +13 -0
- package/docs/OAuthApi.md +112 -0
- package/docs/Pagination.md +11 -0
- package/docs/PoolDetails.md +24 -0
- package/docs/PoolDetailsAllOfValidatorsInfo.md +28 -0
- package/docs/PoolSummary.md +16 -0
- package/docs/RefreshTokenRequest.md +11 -0
- package/docs/ReplaceType.md +14 -0
- package/docs/RetryWebhookEventById201Response.md +9 -0
- package/docs/RootPubkey.md +10 -0
- package/docs/SafeContractCallSource.md +12 -0
- package/docs/SafeTransferSource.md +12 -0
- package/docs/SafeWallet.md +20 -0
- package/docs/SmartContractInitiator.md +10 -0
- package/docs/SmartContractWalletInfo.md +20 -0
- package/docs/SmartContractWalletOperationType.md +10 -0
- package/docs/SmartContractWalletType.md +10 -0
- package/docs/SourceGroup.md +10 -0
- package/docs/StakingPoolType.md +14 -0
- package/docs/StakingSource.md +13 -0
- package/docs/Stakings.md +22 -0
- package/docs/StakingsValidatorInfo.md +13 -0
- package/docs/SubWalletAssetBalance.md +11 -0
- package/docs/TSSGroups.md +11 -0
- package/docs/TSSRequest.md +13 -0
- package/docs/TSSRequestStatus.md +18 -0
- package/docs/TSSRequestType.md +14 -0
- package/docs/TokenBalance.md +10 -0
- package/docs/TokenBalanceBalance.md +12 -0
- package/docs/TokenInfo.md +19 -0
- package/docs/Transaction.md +36 -0
- package/docs/TransactionApprover.md +25 -0
- package/docs/TransactionBlockInfo.md +11 -0
- package/docs/TransactionCustodialAssetWalletSource.md +10 -0
- package/docs/TransactionDepositFromAddressSource.md +13 -0
- package/docs/TransactionDepositFromLoopSource.md +9 -0
- package/docs/TransactionDepositFromWalletSource.md +13 -0
- package/docs/TransactionDepositToAddressDestination.md +15 -0
- package/docs/TransactionDepositToWalletDestination.md +15 -0
- package/docs/TransactionDestination.md +26 -0
- package/docs/TransactionDestinationType.md +22 -0
- package/docs/TransactionDetail.md +37 -0
- package/docs/TransactionDetails.md +45 -0
- package/docs/TransactionEvmContractDestination.md +12 -0
- package/docs/TransactionEvmEip1559Fee.md +16 -0
- package/docs/TransactionEvmLegacyFee.md +14 -0
- package/docs/TransactionExchangeWalletSource.md +12 -0
- package/docs/TransactionFee.md +19 -0
- package/docs/TransactionFeeStationWalletSource.md +10 -0
- package/docs/TransactionFixedFee.md +12 -0
- package/docs/TransactionInitiatorType.md +16 -0
- package/docs/TransactionMPCWalletSource.md +13 -0
- package/docs/TransactionMessageSignEIP191Destination.md +10 -0
- package/docs/TransactionMessageSignEIP712Destination.md +10 -0
- package/docs/TransactionRawTxInfo.md +11 -0
- package/docs/TransactionRbf.md +13 -0
- package/docs/TransactionRbfSource.md +13 -0
- package/docs/TransactionReplacement.md +14 -0
- package/docs/TransactionRequestEvmEip1559Fee.md +13 -0
- package/docs/TransactionRequestEvmLegacyFee.md +12 -0
- package/docs/TransactionRequestFee.md +16 -0
- package/docs/TransactionRequestFixedFee.md +11 -0
- package/docs/TransactionRequestUtxoFee.md +12 -0
- package/docs/TransactionResend.md +9 -0
- package/docs/TransactionResult.md +10 -0
- package/docs/TransactionResultType.md +10 -0
- package/docs/TransactionSignatureResult.md +10 -0
- package/docs/TransactionSigner.md +28 -0
- package/docs/TransactionSmartContractSafeWalletSource.md +12 -0
- package/docs/TransactionSource.md +19 -0
- package/docs/TransactionSourceType.md +26 -0
- package/docs/TransactionStatus.md +30 -0
- package/docs/TransactionSubStatus.md +54 -0
- package/docs/TransactionTimeline.md +11 -0
- package/docs/TransactionTokeApproval.md +21 -0
- package/docs/TransactionTokenAmount.md +11 -0
- package/docs/TransactionTransferToAddressDestination.md +14 -0
- package/docs/TransactionTransferToAddressDestinationAccountOutput.md +11 -0
- package/docs/TransactionTransferToAddressDestinationUtxoOutputsInner.md +11 -0
- package/docs/TransactionTransferToWalletDestination.md +13 -0
- package/docs/TransactionType.md +18 -0
- package/docs/TransactionUtxo.md +10 -0
- package/docs/TransactionUtxoFee.md +13 -0
- package/docs/TransactionWebhookEventData.md +48 -0
- package/docs/TransactionsApi.md +562 -0
- package/docs/TransferDestination.md +17 -0
- package/docs/TransferDestinationType.md +12 -0
- package/docs/TransferParams.md +15 -0
- package/docs/TransferSource.md +15 -0
- package/docs/UTXO.md +16 -0
- package/docs/UpdateCustodialWalletParams.md +10 -0
- package/docs/UpdateExchangeWalletParams.md +10 -0
- package/docs/UpdateGroupAction.md +10 -0
- package/docs/UpdateKeyShareHolderGroupByIdRequest.md +9 -0
- package/docs/UpdateMpcProjectByIdRequest.md +9 -0
- package/docs/UpdateMpcVaultByIdRequest.md +9 -0
- package/docs/UpdateMpcWalletParams.md +10 -0
- package/docs/UpdateSmartContractWalletParams.md +10 -0
- package/docs/UpdateWalletParams.md +10 -0
- package/docs/UpdateWebhookEndpointByIdRequest.md +22 -0
- package/docs/UtxoFeeBasePrice.md +9 -0
- package/docs/UtxoFeeRate.md +13 -0
- package/docs/WalletInfo.md +18 -0
- package/docs/WalletSubtype.md +22 -0
- package/docs/WalletType.md +16 -0
- package/docs/WalletsApi.md +1198 -0
- package/docs/WalletsMPCWalletsApi.md +974 -0
- package/docs/WebhookEndpoint.md +14 -0
- package/docs/WebhookEndpointStatus.md +20 -0
- package/docs/WebhookEvent.md +16 -0
- package/docs/WebhookEventData.md +48 -0
- package/docs/WebhookEventDataType.md +20 -0
- package/docs/WebhookEventLog.md +17 -0
- package/docs/WebhookEventStatus.md +14 -0
- package/docs/WebhookEventType.md +16 -0
- package/package.json +49 -0
|
@@ -0,0 +1,974 @@
|
|
|
1
|
+
# CoboWaas2.WalletsMPCWalletsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**cancelTssRequestById**](WalletsMPCWalletsApi.md#cancelTssRequestById) | **POST** /wallets/mpc/vaults/{vault_id}/tss_requests/{tss_request_id}/cancel | Cancel TSS request
|
|
8
|
+
[**createKeyShareHolderGroup**](WalletsMPCWalletsApi.md#createKeyShareHolderGroup) | **POST** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups | Create key share holder group
|
|
9
|
+
[**createMpcProject**](WalletsMPCWalletsApi.md#createMpcProject) | **POST** /wallets/mpc/projects | Create project
|
|
10
|
+
[**createMpcVault**](WalletsMPCWalletsApi.md#createMpcVault) | **POST** /wallets/mpc/vaults | Create vault
|
|
11
|
+
[**createTssRequest**](WalletsMPCWalletsApi.md#createTssRequest) | **POST** /wallets/mpc/vaults/{vault_id}/tss_requests | Create TSS request
|
|
12
|
+
[**deleteKeyShareHolderGroupById**](WalletsMPCWalletsApi.md#deleteKeyShareHolderGroupById) | **POST** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id}/delete | Delete key share holder group
|
|
13
|
+
[**getKeyShareHolderGroupById**](WalletsMPCWalletsApi.md#getKeyShareHolderGroupById) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id} | Get key share holder group information
|
|
14
|
+
[**getMpcProjectById**](WalletsMPCWalletsApi.md#getMpcProjectById) | **GET** /wallets/mpc/projects/{project_id} | Get project information
|
|
15
|
+
[**getMpcVaultById**](WalletsMPCWalletsApi.md#getMpcVaultById) | **GET** /wallets/mpc/vaults/{vault_id} | Get vault information
|
|
16
|
+
[**getTssRequestById**](WalletsMPCWalletsApi.md#getTssRequestById) | **GET** /wallets/mpc/vaults/{vault_id}/tss_requests/{tss_request_id} | Get TSS request
|
|
17
|
+
[**listCoboKeyHolders**](WalletsMPCWalletsApi.md#listCoboKeyHolders) | **GET** /wallets/mpc/cobo_key_share_holders | List all Cobo key share holders
|
|
18
|
+
[**listKeyShareHolderGroups**](WalletsMPCWalletsApi.md#listKeyShareHolderGroups) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups | List all key share holder groups
|
|
19
|
+
[**listMpcProjects**](WalletsMPCWalletsApi.md#listMpcProjects) | **GET** /wallets/mpc/projects | List all projects
|
|
20
|
+
[**listMpcVaults**](WalletsMPCWalletsApi.md#listMpcVaults) | **GET** /wallets/mpc/vaults | List all vaults
|
|
21
|
+
[**listTssRequests**](WalletsMPCWalletsApi.md#listTssRequests) | **GET** /wallets/mpc/vaults/{vault_id}/tss_requests | List TSS requests
|
|
22
|
+
[**updateKeyShareHolderGroupById**](WalletsMPCWalletsApi.md#updateKeyShareHolderGroupById) | **PUT** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id} | Update key share holder group
|
|
23
|
+
[**updateMpcProjectById**](WalletsMPCWalletsApi.md#updateMpcProjectById) | **PUT** /wallets/mpc/projects/{project_id} | Update project name
|
|
24
|
+
[**updateMpcVaultById**](WalletsMPCWalletsApi.md#updateMpcVaultById) | **PUT** /wallets/mpc/vaults/{vault_id} | Update vault name
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## cancelTssRequestById
|
|
29
|
+
|
|
30
|
+
> TSSRequest cancelTssRequestById(vault_id, tss_request_id)
|
|
31
|
+
|
|
32
|
+
Cancel TSS request
|
|
33
|
+
|
|
34
|
+
This operation cancels a TSS request.
|
|
35
|
+
|
|
36
|
+
### Example
|
|
37
|
+
|
|
38
|
+
```javascript
|
|
39
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
40
|
+
// initial default api client
|
|
41
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
42
|
+
// for dev env
|
|
43
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
44
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
45
|
+
// call api
|
|
46
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
47
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
48
|
+
const tss_request_id = "20240711114129000132315000003970"; // String | The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests).
|
|
49
|
+
apiInstance.cancelTssRequestById(vault_id, tss_request_id).then((data) => {
|
|
50
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
51
|
+
}, (error) => {
|
|
52
|
+
console.error(error);
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
Name | Type | Description | Notes
|
|
61
|
+
------------- | ------------- | ------------- | -------------
|
|
62
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
63
|
+
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
[**TSSRequest**](TSSRequest.md)
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: Not defined
|
|
76
|
+
- **Accept**: application/json
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## createKeyShareHolderGroup
|
|
80
|
+
|
|
81
|
+
> KeyShareHolderGroup createKeyShareHolderGroup(vault_id, opts)
|
|
82
|
+
|
|
83
|
+
Create key share holder group
|
|
84
|
+
|
|
85
|
+
This operation creates a key share holder group for a specified vault.
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```javascript
|
|
90
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
91
|
+
// initial default api client
|
|
92
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
93
|
+
// for dev env
|
|
94
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
95
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
96
|
+
// call api
|
|
97
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
98
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
99
|
+
const opts = {
|
|
100
|
+
'CreateKeyShareHolderGroupRequest': new CoboWaas2.CreateKeyShareHolderGroupRequest() // CreateKeyShareHolderGroupRequest | The request body to create a key share holder group.
|
|
101
|
+
};
|
|
102
|
+
apiInstance.createKeyShareHolderGroup(vault_id, opts).then((data) => {
|
|
103
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
104
|
+
}, (error) => {
|
|
105
|
+
console.error(error);
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Parameters
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
Name | Type | Description | Notes
|
|
114
|
+
------------- | ------------- | ------------- | -------------
|
|
115
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
116
|
+
**CreateKeyShareHolderGroupRequest** | [**CreateKeyShareHolderGroupRequest**](CreateKeyShareHolderGroupRequest.md)| The request body to create a key share holder group. | [optional]
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
[**KeyShareHolderGroup**](KeyShareHolderGroup.md)
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: application/json
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
## createMpcProject
|
|
133
|
+
|
|
134
|
+
> MPCProject createMpcProject(opts)
|
|
135
|
+
|
|
136
|
+
Create project
|
|
137
|
+
|
|
138
|
+
This operation creates a project. <Info>This operation applies to MPC Wallets (User-Controlled Wallets) only.</Info>
|
|
139
|
+
|
|
140
|
+
### Example
|
|
141
|
+
|
|
142
|
+
```javascript
|
|
143
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
144
|
+
// initial default api client
|
|
145
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
146
|
+
// for dev env
|
|
147
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
148
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
149
|
+
// call api
|
|
150
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
151
|
+
const opts = {
|
|
152
|
+
'CreateMpcProjectRequest': new CoboWaas2.CreateMpcProjectRequest() // CreateMpcProjectRequest | The request body to create a project.
|
|
153
|
+
};
|
|
154
|
+
apiInstance.createMpcProject(opts).then((data) => {
|
|
155
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
156
|
+
}, (error) => {
|
|
157
|
+
console.error(error);
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
Name | Type | Description | Notes
|
|
166
|
+
------------- | ------------- | ------------- | -------------
|
|
167
|
+
**CreateMpcProjectRequest** | [**CreateMpcProjectRequest**](CreateMpcProjectRequest.md)| The request body to create a project. | [optional]
|
|
168
|
+
|
|
169
|
+
### Return type
|
|
170
|
+
|
|
171
|
+
[**MPCProject**](MPCProject.md)
|
|
172
|
+
|
|
173
|
+
### Authorization
|
|
174
|
+
|
|
175
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
176
|
+
|
|
177
|
+
### HTTP request headers
|
|
178
|
+
|
|
179
|
+
- **Content-Type**: application/json
|
|
180
|
+
- **Accept**: application/json
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
## createMpcVault
|
|
184
|
+
|
|
185
|
+
> MPCVault createMpcVault(opts)
|
|
186
|
+
|
|
187
|
+
Create vault
|
|
188
|
+
|
|
189
|
+
This operation creates a vault.
|
|
190
|
+
|
|
191
|
+
### Example
|
|
192
|
+
|
|
193
|
+
```javascript
|
|
194
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
195
|
+
// initial default api client
|
|
196
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
197
|
+
// for dev env
|
|
198
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
199
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
200
|
+
// call api
|
|
201
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
202
|
+
const opts = {
|
|
203
|
+
'CreateMpcVaultRequest': new CoboWaas2.CreateMpcVaultRequest() // CreateMpcVaultRequest | The request body to create a vault.
|
|
204
|
+
};
|
|
205
|
+
apiInstance.createMpcVault(opts).then((data) => {
|
|
206
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
207
|
+
}, (error) => {
|
|
208
|
+
console.error(error);
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
Name | Type | Description | Notes
|
|
217
|
+
------------- | ------------- | ------------- | -------------
|
|
218
|
+
**CreateMpcVaultRequest** | [**CreateMpcVaultRequest**](CreateMpcVaultRequest.md)| The request body to create a vault. | [optional]
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
[**MPCVault**](MPCVault.md)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: application/json
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## createTssRequest
|
|
235
|
+
|
|
236
|
+
> TSSRequest createTssRequest(vault_id, opts)
|
|
237
|
+
|
|
238
|
+
Create TSS request
|
|
239
|
+
|
|
240
|
+
This operation creates a TSS request under a specified vault. You can use this operation to perform actions such as key generation and recovery.
|
|
241
|
+
|
|
242
|
+
### Example
|
|
243
|
+
|
|
244
|
+
```javascript
|
|
245
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
246
|
+
// initial default api client
|
|
247
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
248
|
+
// for dev env
|
|
249
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
250
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
251
|
+
// call api
|
|
252
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
253
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
254
|
+
const opts = {
|
|
255
|
+
'CreateTssRequestRequest': new CoboWaas2.CreateTssRequestRequest() // CreateTssRequestRequest | The request body to create a TSS request.
|
|
256
|
+
};
|
|
257
|
+
apiInstance.createTssRequest(vault_id, opts).then((data) => {
|
|
258
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
259
|
+
}, (error) => {
|
|
260
|
+
console.error(error);
|
|
261
|
+
});
|
|
262
|
+
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Parameters
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
Name | Type | Description | Notes
|
|
269
|
+
------------- | ------------- | ------------- | -------------
|
|
270
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
271
|
+
**CreateTssRequestRequest** | [**CreateTssRequestRequest**](CreateTssRequestRequest.md)| The request body to create a TSS request. | [optional]
|
|
272
|
+
|
|
273
|
+
### Return type
|
|
274
|
+
|
|
275
|
+
[**TSSRequest**](TSSRequest.md)
|
|
276
|
+
|
|
277
|
+
### Authorization
|
|
278
|
+
|
|
279
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
280
|
+
|
|
281
|
+
### HTTP request headers
|
|
282
|
+
|
|
283
|
+
- **Content-Type**: application/json
|
|
284
|
+
- **Accept**: application/json
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
## deleteKeyShareHolderGroupById
|
|
288
|
+
|
|
289
|
+
> DeleteKeyShareHolderGroupById201Response deleteKeyShareHolderGroupById(vault_id, key_share_holder_group_id)
|
|
290
|
+
|
|
291
|
+
Delete key share holder group
|
|
292
|
+
|
|
293
|
+
This operation deletes a specified key share holder group.
|
|
294
|
+
|
|
295
|
+
### Example
|
|
296
|
+
|
|
297
|
+
```javascript
|
|
298
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
299
|
+
// initial default api client
|
|
300
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
301
|
+
// for dev env
|
|
302
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
303
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
304
|
+
// call api
|
|
305
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
306
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
307
|
+
const key_share_holder_group_id = "e8257ac8-76b8-4d1e-a1f9-eec4cb931dce"; // String | The key share holder group ID.
|
|
308
|
+
apiInstance.deleteKeyShareHolderGroupById(vault_id, key_share_holder_group_id).then((data) => {
|
|
309
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
310
|
+
}, (error) => {
|
|
311
|
+
console.error(error);
|
|
312
|
+
});
|
|
313
|
+
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Parameters
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
Name | Type | Description | Notes
|
|
320
|
+
------------- | ------------- | ------------- | -------------
|
|
321
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
322
|
+
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
323
|
+
|
|
324
|
+
### Return type
|
|
325
|
+
|
|
326
|
+
[**DeleteKeyShareHolderGroupById201Response**](DeleteKeyShareHolderGroupById201Response.md)
|
|
327
|
+
|
|
328
|
+
### Authorization
|
|
329
|
+
|
|
330
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
331
|
+
|
|
332
|
+
### HTTP request headers
|
|
333
|
+
|
|
334
|
+
- **Content-Type**: Not defined
|
|
335
|
+
- **Accept**: application/json
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
## getKeyShareHolderGroupById
|
|
339
|
+
|
|
340
|
+
> KeyShareHolderGroup getKeyShareHolderGroupById(vault_id, key_share_holder_group_id)
|
|
341
|
+
|
|
342
|
+
Get key share holder group information
|
|
343
|
+
|
|
344
|
+
This operation retrieves detailed information about a specified key share holder group.
|
|
345
|
+
|
|
346
|
+
### Example
|
|
347
|
+
|
|
348
|
+
```javascript
|
|
349
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
350
|
+
// initial default api client
|
|
351
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
352
|
+
// for dev env
|
|
353
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
354
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
355
|
+
// call api
|
|
356
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
357
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
358
|
+
const key_share_holder_group_id = "e8257ac8-76b8-4d1e-a1f9-eec4cb931dce"; // String | The key share holder group ID.
|
|
359
|
+
apiInstance.getKeyShareHolderGroupById(vault_id, key_share_holder_group_id).then((data) => {
|
|
360
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
361
|
+
}, (error) => {
|
|
362
|
+
console.error(error);
|
|
363
|
+
});
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Parameters
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
Name | Type | Description | Notes
|
|
371
|
+
------------- | ------------- | ------------- | -------------
|
|
372
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
373
|
+
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
374
|
+
|
|
375
|
+
### Return type
|
|
376
|
+
|
|
377
|
+
[**KeyShareHolderGroup**](KeyShareHolderGroup.md)
|
|
378
|
+
|
|
379
|
+
### Authorization
|
|
380
|
+
|
|
381
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
382
|
+
|
|
383
|
+
### HTTP request headers
|
|
384
|
+
|
|
385
|
+
- **Content-Type**: Not defined
|
|
386
|
+
- **Accept**: application/json
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
## getMpcProjectById
|
|
390
|
+
|
|
391
|
+
> MPCProject getMpcProjectById(project_id)
|
|
392
|
+
|
|
393
|
+
Get project information
|
|
394
|
+
|
|
395
|
+
This operation retrieves detailed information about a project. <Info>This operation applies to MPC Wallets (User-Controlled Wallets) only.</Info>
|
|
396
|
+
|
|
397
|
+
### Example
|
|
398
|
+
|
|
399
|
+
```javascript
|
|
400
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
401
|
+
// initial default api client
|
|
402
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
403
|
+
// for dev env
|
|
404
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
405
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
406
|
+
// call api
|
|
407
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
408
|
+
const project_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
409
|
+
apiInstance.getMpcProjectById(project_id).then((data) => {
|
|
410
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
411
|
+
}, (error) => {
|
|
412
|
+
console.error(error);
|
|
413
|
+
});
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
Name | Type | Description | Notes
|
|
421
|
+
------------- | ------------- | ------------- | -------------
|
|
422
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
423
|
+
|
|
424
|
+
### Return type
|
|
425
|
+
|
|
426
|
+
[**MPCProject**](MPCProject.md)
|
|
427
|
+
|
|
428
|
+
### Authorization
|
|
429
|
+
|
|
430
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
431
|
+
|
|
432
|
+
### HTTP request headers
|
|
433
|
+
|
|
434
|
+
- **Content-Type**: Not defined
|
|
435
|
+
- **Accept**: application/json
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
## getMpcVaultById
|
|
439
|
+
|
|
440
|
+
> MPCVault getMpcVaultById(vault_id)
|
|
441
|
+
|
|
442
|
+
Get vault information
|
|
443
|
+
|
|
444
|
+
This operation retrieves detailed information about a vault.
|
|
445
|
+
|
|
446
|
+
### Example
|
|
447
|
+
|
|
448
|
+
```javascript
|
|
449
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
450
|
+
// initial default api client
|
|
451
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
452
|
+
// for dev env
|
|
453
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
454
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
455
|
+
// call api
|
|
456
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
457
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
458
|
+
apiInstance.getMpcVaultById(vault_id).then((data) => {
|
|
459
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
460
|
+
}, (error) => {
|
|
461
|
+
console.error(error);
|
|
462
|
+
});
|
|
463
|
+
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
### Parameters
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
Name | Type | Description | Notes
|
|
470
|
+
------------- | ------------- | ------------- | -------------
|
|
471
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
472
|
+
|
|
473
|
+
### Return type
|
|
474
|
+
|
|
475
|
+
[**MPCVault**](MPCVault.md)
|
|
476
|
+
|
|
477
|
+
### Authorization
|
|
478
|
+
|
|
479
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
480
|
+
|
|
481
|
+
### HTTP request headers
|
|
482
|
+
|
|
483
|
+
- **Content-Type**: Not defined
|
|
484
|
+
- **Accept**: application/json
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
## getTssRequestById
|
|
488
|
+
|
|
489
|
+
> TSSRequest getTssRequestById(vault_id, tss_request_id)
|
|
490
|
+
|
|
491
|
+
Get TSS request
|
|
492
|
+
|
|
493
|
+
This operation retrieves detailed information about a TSS request.
|
|
494
|
+
|
|
495
|
+
### Example
|
|
496
|
+
|
|
497
|
+
```javascript
|
|
498
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
499
|
+
// initial default api client
|
|
500
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
501
|
+
// for dev env
|
|
502
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
503
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
504
|
+
// call api
|
|
505
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
506
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
507
|
+
const tss_request_id = "20240711114129000132315000003970"; // String | The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests).
|
|
508
|
+
apiInstance.getTssRequestById(vault_id, tss_request_id).then((data) => {
|
|
509
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
510
|
+
}, (error) => {
|
|
511
|
+
console.error(error);
|
|
512
|
+
});
|
|
513
|
+
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
### Parameters
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
Name | Type | Description | Notes
|
|
520
|
+
------------- | ------------- | ------------- | -------------
|
|
521
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
522
|
+
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
523
|
+
|
|
524
|
+
### Return type
|
|
525
|
+
|
|
526
|
+
[**TSSRequest**](TSSRequest.md)
|
|
527
|
+
|
|
528
|
+
### Authorization
|
|
529
|
+
|
|
530
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
531
|
+
|
|
532
|
+
### HTTP request headers
|
|
533
|
+
|
|
534
|
+
- **Content-Type**: Not defined
|
|
535
|
+
- **Accept**: application/json
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
## listCoboKeyHolders
|
|
539
|
+
|
|
540
|
+
> [KeyShareHolder] listCoboKeyHolders()
|
|
541
|
+
|
|
542
|
+
List all Cobo key share holders
|
|
543
|
+
|
|
544
|
+
This operation retrieves a list of all Cobo key share holders and their information. <Info>When using this operation, `type` will only return `Cobo` and will never return `Mobile` or `API`.</Info>
|
|
545
|
+
|
|
546
|
+
### Example
|
|
547
|
+
|
|
548
|
+
```javascript
|
|
549
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
550
|
+
// initial default api client
|
|
551
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
552
|
+
// for dev env
|
|
553
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
554
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
555
|
+
// call api
|
|
556
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
557
|
+
apiInstance.listCoboKeyHolders().then((data) => {
|
|
558
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
559
|
+
}, (error) => {
|
|
560
|
+
console.error(error);
|
|
561
|
+
});
|
|
562
|
+
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Parameters
|
|
566
|
+
|
|
567
|
+
This endpoint does not need any parameter.
|
|
568
|
+
|
|
569
|
+
### Return type
|
|
570
|
+
|
|
571
|
+
[**[KeyShareHolder]**](KeyShareHolder.md)
|
|
572
|
+
|
|
573
|
+
### Authorization
|
|
574
|
+
|
|
575
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
576
|
+
|
|
577
|
+
### HTTP request headers
|
|
578
|
+
|
|
579
|
+
- **Content-Type**: Not defined
|
|
580
|
+
- **Accept**: application/json
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
## listKeyShareHolderGroups
|
|
584
|
+
|
|
585
|
+
> ListKeyShareHolderGroups200Response listKeyShareHolderGroups(vault_id, opts)
|
|
586
|
+
|
|
587
|
+
List all key share holder groups
|
|
588
|
+
|
|
589
|
+
This operation retrieves all key share holder groups under a specified vault. You can filter the result by group type.
|
|
590
|
+
|
|
591
|
+
### Example
|
|
592
|
+
|
|
593
|
+
```javascript
|
|
594
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
595
|
+
// initial default api client
|
|
596
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
597
|
+
// for dev env
|
|
598
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
599
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
600
|
+
// call api
|
|
601
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
602
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
603
|
+
const opts = {
|
|
604
|
+
'key_share_holder_group_type': new CoboWaas2.KeyShareHolderGroupType(), // KeyShareHolderGroupType | The key share holder group type. Possible values include: - `MainGroup`: The [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#main-group). - `SigningGroup`: The [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#signing-group). - `RecoveryGroup`: The [Recovery Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#recovery-group). **Note**: If this parameter is left empty, all key share holder group types will be retrieved.
|
|
605
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
606
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", // String | An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned.
|
|
607
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" // String | An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.
|
|
608
|
+
};
|
|
609
|
+
apiInstance.listKeyShareHolderGroups(vault_id, opts).then((data) => {
|
|
610
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
611
|
+
}, (error) => {
|
|
612
|
+
console.error(error);
|
|
613
|
+
});
|
|
614
|
+
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
### Parameters
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
Name | Type | Description | Notes
|
|
621
|
+
------------- | ------------- | ------------- | -------------
|
|
622
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
623
|
+
**key_share_holder_group_type** | [**KeyShareHolderGroupType**](.md)| The key share holder group type. Possible values include: - `MainGroup`: The [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#main-group). - `SigningGroup`: The [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#signing-group). - `RecoveryGroup`: The [Recovery Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#recovery-group). **Note**: If this parameter is left empty, all key share holder group types will be retrieved. | [optional]
|
|
624
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
625
|
+
**before** | **String**| An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned. | [optional]
|
|
626
|
+
**after** | **String**| An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
627
|
+
|
|
628
|
+
### Return type
|
|
629
|
+
|
|
630
|
+
[**ListKeyShareHolderGroups200Response**](ListKeyShareHolderGroups200Response.md)
|
|
631
|
+
|
|
632
|
+
### Authorization
|
|
633
|
+
|
|
634
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
635
|
+
|
|
636
|
+
### HTTP request headers
|
|
637
|
+
|
|
638
|
+
- **Content-Type**: Not defined
|
|
639
|
+
- **Accept**: application/json
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
## listMpcProjects
|
|
643
|
+
|
|
644
|
+
> ListMpcProjects200Response listMpcProjects(opts)
|
|
645
|
+
|
|
646
|
+
List all projects
|
|
647
|
+
|
|
648
|
+
This operation retrieves a list of all projects. <Info>This operation applies to MPC Wallets (User-Controlled Wallets) only.</Info>
|
|
649
|
+
|
|
650
|
+
### Example
|
|
651
|
+
|
|
652
|
+
```javascript
|
|
653
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
654
|
+
// initial default api client
|
|
655
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
656
|
+
// for dev env
|
|
657
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
658
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
659
|
+
// call api
|
|
660
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
661
|
+
const opts = {
|
|
662
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
663
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", // String | An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned.
|
|
664
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" // String | An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.
|
|
665
|
+
};
|
|
666
|
+
apiInstance.listMpcProjects(opts).then((data) => {
|
|
667
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
668
|
+
}, (error) => {
|
|
669
|
+
console.error(error);
|
|
670
|
+
});
|
|
671
|
+
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
### Parameters
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
Name | Type | Description | Notes
|
|
678
|
+
------------- | ------------- | ------------- | -------------
|
|
679
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
680
|
+
**before** | **String**| An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned. | [optional]
|
|
681
|
+
**after** | **String**| An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
682
|
+
|
|
683
|
+
### Return type
|
|
684
|
+
|
|
685
|
+
[**ListMpcProjects200Response**](ListMpcProjects200Response.md)
|
|
686
|
+
|
|
687
|
+
### Authorization
|
|
688
|
+
|
|
689
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
690
|
+
|
|
691
|
+
### HTTP request headers
|
|
692
|
+
|
|
693
|
+
- **Content-Type**: Not defined
|
|
694
|
+
- **Accept**: application/json
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
## listMpcVaults
|
|
698
|
+
|
|
699
|
+
> ListMpcVaults200Response listMpcVaults(vault_type, opts)
|
|
700
|
+
|
|
701
|
+
List all vaults
|
|
702
|
+
|
|
703
|
+
This operation retrieves a list of all vaults. You can filter the result by project ID. **Notes for query parameters**: 1. `project_id` is required when `vault_type` is set to `User-Controlled`. 2. `project_id` must be left blank when `vault_type` is set to `Org-Controlled`.
|
|
704
|
+
|
|
705
|
+
### Example
|
|
706
|
+
|
|
707
|
+
```javascript
|
|
708
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
709
|
+
// initial default api client
|
|
710
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
711
|
+
// for dev env
|
|
712
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
713
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
714
|
+
// call api
|
|
715
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
716
|
+
const vault_type = new CoboWaas2.MPCVaultType(); // MPCVaultType | The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets).
|
|
717
|
+
const opts = {
|
|
718
|
+
'project_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479", // String | The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
719
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
720
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", // String | An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned.
|
|
721
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" // String | An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.
|
|
722
|
+
};
|
|
723
|
+
apiInstance.listMpcVaults(vault_type, opts).then((data) => {
|
|
724
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
725
|
+
}, (error) => {
|
|
726
|
+
console.error(error);
|
|
727
|
+
});
|
|
728
|
+
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
### Parameters
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
Name | Type | Description | Notes
|
|
735
|
+
------------- | ------------- | ------------- | -------------
|
|
736
|
+
**vault_type** | [**MPCVaultType**](.md)| The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets). |
|
|
737
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
738
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
739
|
+
**before** | **String**| An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned. | [optional]
|
|
740
|
+
**after** | **String**| An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
741
|
+
|
|
742
|
+
### Return type
|
|
743
|
+
|
|
744
|
+
[**ListMpcVaults200Response**](ListMpcVaults200Response.md)
|
|
745
|
+
|
|
746
|
+
### Authorization
|
|
747
|
+
|
|
748
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
749
|
+
|
|
750
|
+
### HTTP request headers
|
|
751
|
+
|
|
752
|
+
- **Content-Type**: Not defined
|
|
753
|
+
- **Accept**: application/json
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
## listTssRequests
|
|
757
|
+
|
|
758
|
+
> ListTssRequests200Response listTssRequests(vault_id, key_share_holder_group_id, opts)
|
|
759
|
+
|
|
760
|
+
List TSS requests
|
|
761
|
+
|
|
762
|
+
This operation retrieves a list of TSS requests and their details.
|
|
763
|
+
|
|
764
|
+
### Example
|
|
765
|
+
|
|
766
|
+
```javascript
|
|
767
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
768
|
+
// initial default api client
|
|
769
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
770
|
+
// for dev env
|
|
771
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
772
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
773
|
+
// call api
|
|
774
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
775
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
776
|
+
const key_share_holder_group_id = "a3a45e99-5a12-444f-867a-ffe0ebb1bb30"; // String | The key share holder group ID of the TSS request, which you can retrieve by calling [List all key share holder groups](/v2/api-references/wallets--mpc-wallets/list-all-key-share-holder-groups).
|
|
777
|
+
const opts = {
|
|
778
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
779
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", // String | An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned.
|
|
780
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" // String | An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.
|
|
781
|
+
};
|
|
782
|
+
apiInstance.listTssRequests(vault_id, key_share_holder_group_id, opts).then((data) => {
|
|
783
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
784
|
+
}, (error) => {
|
|
785
|
+
console.error(error);
|
|
786
|
+
});
|
|
787
|
+
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
### Parameters
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
Name | Type | Description | Notes
|
|
794
|
+
------------- | ------------- | ------------- | -------------
|
|
795
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
796
|
+
**key_share_holder_group_id** | **String**| The key share holder group ID of the TSS request, which you can retrieve by calling [List all key share holder groups](/v2/api-references/wallets--mpc-wallets/list-all-key-share-holder-groups). |
|
|
797
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
798
|
+
**before** | **String**| An object ID that serves as a starting point for retrieving data in reverse chronological order. For example, if you specify `before` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`, the request will retrieve a list of data objects that end before the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1`. You can set this parameter to the value of `pagination.before` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set `before` to `infinity`, the last page of data is returned. | [optional]
|
|
799
|
+
**after** | **String**| An object ID that acts as a starting point for retrieving data in chronological order. For example, if you specify `after` as `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`, the request will retrieve a list of data objects that start after the object with the object ID `RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`. You can set this parameter to the value of `pagination.after` in the response of the previous request. - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
800
|
+
|
|
801
|
+
### Return type
|
|
802
|
+
|
|
803
|
+
[**ListTssRequests200Response**](ListTssRequests200Response.md)
|
|
804
|
+
|
|
805
|
+
### Authorization
|
|
806
|
+
|
|
807
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
808
|
+
|
|
809
|
+
### HTTP request headers
|
|
810
|
+
|
|
811
|
+
- **Content-Type**: Not defined
|
|
812
|
+
- **Accept**: application/json
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
## updateKeyShareHolderGroupById
|
|
816
|
+
|
|
817
|
+
> KeyShareHolderGroup updateKeyShareHolderGroupById(vault_id, key_share_holder_group_id, opts)
|
|
818
|
+
|
|
819
|
+
Update key share holder group
|
|
820
|
+
|
|
821
|
+
This operation updates a specified active [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups). For example, you can use this operation to upgrade a Signing Group to the [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups).
|
|
822
|
+
|
|
823
|
+
### Example
|
|
824
|
+
|
|
825
|
+
```javascript
|
|
826
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
827
|
+
// initial default api client
|
|
828
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
829
|
+
// for dev env
|
|
830
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
831
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
832
|
+
// call api
|
|
833
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
834
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
835
|
+
const key_share_holder_group_id = "e8257ac8-76b8-4d1e-a1f9-eec4cb931dce"; // String | The key share holder group ID.
|
|
836
|
+
const opts = {
|
|
837
|
+
'UpdateKeyShareHolderGroupByIdRequest': new CoboWaas2.UpdateKeyShareHolderGroupByIdRequest() // UpdateKeyShareHolderGroupByIdRequest |
|
|
838
|
+
};
|
|
839
|
+
apiInstance.updateKeyShareHolderGroupById(vault_id, key_share_holder_group_id, opts).then((data) => {
|
|
840
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
841
|
+
}, (error) => {
|
|
842
|
+
console.error(error);
|
|
843
|
+
});
|
|
844
|
+
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
### Parameters
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
Name | Type | Description | Notes
|
|
851
|
+
------------- | ------------- | ------------- | -------------
|
|
852
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
853
|
+
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
854
|
+
**UpdateKeyShareHolderGroupByIdRequest** | [**UpdateKeyShareHolderGroupByIdRequest**](UpdateKeyShareHolderGroupByIdRequest.md)| | [optional]
|
|
855
|
+
|
|
856
|
+
### Return type
|
|
857
|
+
|
|
858
|
+
[**KeyShareHolderGroup**](KeyShareHolderGroup.md)
|
|
859
|
+
|
|
860
|
+
### Authorization
|
|
861
|
+
|
|
862
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
863
|
+
|
|
864
|
+
### HTTP request headers
|
|
865
|
+
|
|
866
|
+
- **Content-Type**: application/json
|
|
867
|
+
- **Accept**: application/json
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
## updateMpcProjectById
|
|
871
|
+
|
|
872
|
+
> MPCProject updateMpcProjectById(project_id, opts)
|
|
873
|
+
|
|
874
|
+
Update project name
|
|
875
|
+
|
|
876
|
+
This operation updates a project's name. <Info>This operation applies to MPC Wallets (User-Controlled Wallets) only.</Info>
|
|
877
|
+
|
|
878
|
+
### Example
|
|
879
|
+
|
|
880
|
+
```javascript
|
|
881
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
882
|
+
// initial default api client
|
|
883
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
884
|
+
// for dev env
|
|
885
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
886
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
887
|
+
// call api
|
|
888
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
889
|
+
const project_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
890
|
+
const opts = {
|
|
891
|
+
'UpdateMpcProjectByIdRequest': new CoboWaas2.UpdateMpcProjectByIdRequest() // UpdateMpcProjectByIdRequest | The request body to update a project's name.
|
|
892
|
+
};
|
|
893
|
+
apiInstance.updateMpcProjectById(project_id, opts).then((data) => {
|
|
894
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
895
|
+
}, (error) => {
|
|
896
|
+
console.error(error);
|
|
897
|
+
});
|
|
898
|
+
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
### Parameters
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
Name | Type | Description | Notes
|
|
905
|
+
------------- | ------------- | ------------- | -------------
|
|
906
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
907
|
+
**UpdateMpcProjectByIdRequest** | [**UpdateMpcProjectByIdRequest**](UpdateMpcProjectByIdRequest.md)| The request body to update a project's name. | [optional]
|
|
908
|
+
|
|
909
|
+
### Return type
|
|
910
|
+
|
|
911
|
+
[**MPCProject**](MPCProject.md)
|
|
912
|
+
|
|
913
|
+
### Authorization
|
|
914
|
+
|
|
915
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
916
|
+
|
|
917
|
+
### HTTP request headers
|
|
918
|
+
|
|
919
|
+
- **Content-Type**: application/json
|
|
920
|
+
- **Accept**: application/json
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
## updateMpcVaultById
|
|
924
|
+
|
|
925
|
+
> MPCVault updateMpcVaultById(vault_id, opts)
|
|
926
|
+
|
|
927
|
+
Update vault name
|
|
928
|
+
|
|
929
|
+
This operation updates a vault's name.
|
|
930
|
+
|
|
931
|
+
### Example
|
|
932
|
+
|
|
933
|
+
```javascript
|
|
934
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
935
|
+
// initial default api client
|
|
936
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
937
|
+
// for dev env
|
|
938
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
939
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
940
|
+
// call api
|
|
941
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
942
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults).
|
|
943
|
+
const opts = {
|
|
944
|
+
'UpdateMpcVaultByIdRequest': new CoboWaas2.UpdateMpcVaultByIdRequest() // UpdateMpcVaultByIdRequest | The request body to update a vault's name.
|
|
945
|
+
};
|
|
946
|
+
apiInstance.updateMpcVaultById(vault_id, opts).then((data) => {
|
|
947
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
948
|
+
}, (error) => {
|
|
949
|
+
console.error(error);
|
|
950
|
+
});
|
|
951
|
+
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
### Parameters
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
Name | Type | Description | Notes
|
|
958
|
+
------------- | ------------- | ------------- | -------------
|
|
959
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallet/list-all-mpc-vaults). |
|
|
960
|
+
**UpdateMpcVaultByIdRequest** | [**UpdateMpcVaultByIdRequest**](UpdateMpcVaultByIdRequest.md)| The request body to update a vault's name. | [optional]
|
|
961
|
+
|
|
962
|
+
### Return type
|
|
963
|
+
|
|
964
|
+
[**MPCVault**](MPCVault.md)
|
|
965
|
+
|
|
966
|
+
### Authorization
|
|
967
|
+
|
|
968
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
969
|
+
|
|
970
|
+
### HTTP request headers
|
|
971
|
+
|
|
972
|
+
- **Content-Type**: application/json
|
|
973
|
+
- **Accept**: application/json
|
|
974
|
+
|