@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,1198 @@
|
|
|
1
|
+
# CoboWaas2.WalletsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**checkAddressValidity**](WalletsApi.md#checkAddressValidity) | **GET** /wallets/check_address_validity | Check address validity
|
|
8
|
+
[**createAddress**](WalletsApi.md#createAddress) | **POST** /wallets/{wallet_id}/addresses | Create addresses in wallet
|
|
9
|
+
[**createWallet**](WalletsApi.md#createWallet) | **POST** /wallets | Create wallet
|
|
10
|
+
[**deleteWalletById**](WalletsApi.md#deleteWalletById) | **POST** /wallets/{wallet_id}/delete | Delete wallet
|
|
11
|
+
[**getAddress**](WalletsApi.md#getAddress) | **GET** /wallets/{wallet_id}/addresses/{address} | Get address information
|
|
12
|
+
[**getChainById**](WalletsApi.md#getChainById) | **GET** /wallets/chains/{chain_id} | Get chain information
|
|
13
|
+
[**getMaxTransferableValue**](WalletsApi.md#getMaxTransferableValue) | **GET** /wallets/{wallet_id}/max_transferable_value | Get maximum transferable value
|
|
14
|
+
[**getTokenById**](WalletsApi.md#getTokenById) | **GET** /wallets/tokens/{token_id} | Get token information
|
|
15
|
+
[**getWalletById**](WalletsApi.md#getWalletById) | **GET** /wallets/{wallet_id} | Get wallet information
|
|
16
|
+
[**listAddresses**](WalletsApi.md#listAddresses) | **GET** /wallets/{wallet_id}/addresses | List wallet addresses
|
|
17
|
+
[**listEnabledChains**](WalletsApi.md#listEnabledChains) | **GET** /wallets/enabled_chains | List enabled chains
|
|
18
|
+
[**listEnabledTokens**](WalletsApi.md#listEnabledTokens) | **GET** /wallets/enabled_tokens | List enabled tokens
|
|
19
|
+
[**listSupportedChains**](WalletsApi.md#listSupportedChains) | **GET** /wallets/chains | List supported chains
|
|
20
|
+
[**listSupportedTokens**](WalletsApi.md#listSupportedTokens) | **GET** /wallets/tokens | List supported tokens
|
|
21
|
+
[**listTokenBalancesForAddress**](WalletsApi.md#listTokenBalancesForAddress) | **GET** /wallets/{wallet_id}/addresses/{address}/tokens | List token balances by address
|
|
22
|
+
[**listTokenBalancesForWallet**](WalletsApi.md#listTokenBalancesForWallet) | **GET** /wallets/{wallet_id}/tokens | List token balances by wallet
|
|
23
|
+
[**listUtxos**](WalletsApi.md#listUtxos) | **GET** /wallets/{wallet_id}/utxos | List UTXOs
|
|
24
|
+
[**listWallets**](WalletsApi.md#listWallets) | **GET** /wallets | List all wallets
|
|
25
|
+
[**lockUtxos**](WalletsApi.md#lockUtxos) | **POST** /wallets/{wallet_id}/utxos/lock | Lock UTXOs
|
|
26
|
+
[**unlockUtxos**](WalletsApi.md#unlockUtxos) | **POST** /wallets/{wallet_id}/utxos/unlock | Unlock UTXOs
|
|
27
|
+
[**updateWalletById**](WalletsApi.md#updateWalletById) | **PUT** /wallets/{wallet_id} | Update wallet
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## checkAddressValidity
|
|
32
|
+
|
|
33
|
+
> CheckAddressValidity200Response checkAddressValidity(chain_id, address)
|
|
34
|
+
|
|
35
|
+
Check address validity
|
|
36
|
+
|
|
37
|
+
This operation verifies if a given address is valid for a specific chain.
|
|
38
|
+
|
|
39
|
+
### Example
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
43
|
+
// initial default api client
|
|
44
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
45
|
+
// for dev env
|
|
46
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
47
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
48
|
+
// call api
|
|
49
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
50
|
+
const chain_id = "ETH"; // String | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
51
|
+
const address = "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"; // String | The wallet address.
|
|
52
|
+
apiInstance.checkAddressValidity(chain_id, address).then((data) => {
|
|
53
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
54
|
+
}, (error) => {
|
|
55
|
+
console.error(error);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
Name | Type | Description | Notes
|
|
64
|
+
------------- | ------------- | ------------- | -------------
|
|
65
|
+
**chain_id** | **String**| The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
|
|
66
|
+
**address** | **String**| The wallet address. |
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**CheckAddressValidity200Response**](CheckAddressValidity200Response.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: Not defined
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## createAddress
|
|
83
|
+
|
|
84
|
+
> [AddressInfo] createAddress(wallet_id, opts)
|
|
85
|
+
|
|
86
|
+
Create addresses in wallet
|
|
87
|
+
|
|
88
|
+
This operation generates one or more addresses within a specified wallet. <Note>This operation is applicable to Custodial Wallets and MPC Wallets only.</Note>
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
|
|
92
|
+
```javascript
|
|
93
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
94
|
+
// initial default api client
|
|
95
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
96
|
+
// for dev env
|
|
97
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
98
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
99
|
+
// call api
|
|
100
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
101
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
102
|
+
const opts = {
|
|
103
|
+
'CreateAddressRequest': new CoboWaas2.CreateAddressRequest() // CreateAddressRequest | The request body to generates addresses within a specified wallet.
|
|
104
|
+
};
|
|
105
|
+
apiInstance.createAddress(wallet_id, opts).then((data) => {
|
|
106
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
107
|
+
}, (error) => {
|
|
108
|
+
console.error(error);
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Parameters
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
Name | Type | Description | Notes
|
|
117
|
+
------------- | ------------- | ------------- | -------------
|
|
118
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
119
|
+
**CreateAddressRequest** | [**CreateAddressRequest**](CreateAddressRequest.md)| The request body to generates addresses within a specified wallet. | [optional]
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
[**[AddressInfo]**](AddressInfo.md)
|
|
124
|
+
|
|
125
|
+
### Authorization
|
|
126
|
+
|
|
127
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
128
|
+
|
|
129
|
+
### HTTP request headers
|
|
130
|
+
|
|
131
|
+
- **Content-Type**: application/json
|
|
132
|
+
- **Accept**: application/json
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
## createWallet
|
|
136
|
+
|
|
137
|
+
> CreatedWalletInfo createWallet(opts)
|
|
138
|
+
|
|
139
|
+
Create wallet
|
|
140
|
+
|
|
141
|
+
This operation creates a wallet with the provided information.
|
|
142
|
+
|
|
143
|
+
### Example
|
|
144
|
+
|
|
145
|
+
```javascript
|
|
146
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
147
|
+
// initial default api client
|
|
148
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
149
|
+
// for dev env
|
|
150
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
151
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
152
|
+
// call api
|
|
153
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
154
|
+
const opts = {
|
|
155
|
+
'CreateWalletParams': new CoboWaas2.CreateWalletParams() // CreateWalletParams | The request body to create a wallet
|
|
156
|
+
};
|
|
157
|
+
apiInstance.createWallet(opts).then((data) => {
|
|
158
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
159
|
+
}, (error) => {
|
|
160
|
+
console.error(error);
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Parameters
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
Name | Type | Description | Notes
|
|
169
|
+
------------- | ------------- | ------------- | -------------
|
|
170
|
+
**CreateWalletParams** | [**CreateWalletParams**](CreateWalletParams.md)| The request body to create a wallet | [optional]
|
|
171
|
+
|
|
172
|
+
### Return type
|
|
173
|
+
|
|
174
|
+
[**CreatedWalletInfo**](CreatedWalletInfo.md)
|
|
175
|
+
|
|
176
|
+
### Authorization
|
|
177
|
+
|
|
178
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
179
|
+
|
|
180
|
+
### HTTP request headers
|
|
181
|
+
|
|
182
|
+
- **Content-Type**: application/json
|
|
183
|
+
- **Accept**: application/json
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
## deleteWalletById
|
|
187
|
+
|
|
188
|
+
> DeleteWalletById201Response deleteWalletById(wallet_id)
|
|
189
|
+
|
|
190
|
+
Delete wallet
|
|
191
|
+
|
|
192
|
+
This operation deletes a specified wallet. <Note>This operation is applicable to Exchange Wallets only.</Note>
|
|
193
|
+
|
|
194
|
+
### Example
|
|
195
|
+
|
|
196
|
+
```javascript
|
|
197
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
198
|
+
// initial default api client
|
|
199
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
200
|
+
// for dev env
|
|
201
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
202
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
203
|
+
// call api
|
|
204
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
205
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
206
|
+
apiInstance.deleteWalletById(wallet_id).then((data) => {
|
|
207
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
208
|
+
}, (error) => {
|
|
209
|
+
console.error(error);
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Parameters
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
Name | Type | Description | Notes
|
|
218
|
+
------------- | ------------- | ------------- | -------------
|
|
219
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**DeleteWalletById201Response**](DeleteWalletById201Response.md)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
## getAddress
|
|
236
|
+
|
|
237
|
+
> [AddressInfo] getAddress(wallet_id, address)
|
|
238
|
+
|
|
239
|
+
Get address information
|
|
240
|
+
|
|
241
|
+
This operation retrieves the detailed information about a specified address within a wallet.
|
|
242
|
+
|
|
243
|
+
### Example
|
|
244
|
+
|
|
245
|
+
```javascript
|
|
246
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
247
|
+
// initial default api client
|
|
248
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
249
|
+
// for dev env
|
|
250
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
251
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
252
|
+
// call api
|
|
253
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
254
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
255
|
+
const address = "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"; // String | The wallet address.
|
|
256
|
+
apiInstance.getAddress(wallet_id, address).then((data) => {
|
|
257
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
258
|
+
}, (error) => {
|
|
259
|
+
console.error(error);
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
Name | Type | Description | Notes
|
|
268
|
+
------------- | ------------- | ------------- | -------------
|
|
269
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
270
|
+
**address** | **String**| The wallet address. |
|
|
271
|
+
|
|
272
|
+
### Return type
|
|
273
|
+
|
|
274
|
+
[**[AddressInfo]**](AddressInfo.md)
|
|
275
|
+
|
|
276
|
+
### Authorization
|
|
277
|
+
|
|
278
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: Not defined
|
|
283
|
+
- **Accept**: application/json
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
## getChainById
|
|
287
|
+
|
|
288
|
+
> ChainInfo getChainById(chain_id)
|
|
289
|
+
|
|
290
|
+
Get chain information
|
|
291
|
+
|
|
292
|
+
This operation retrieves the detailed information about a specified chain.
|
|
293
|
+
|
|
294
|
+
### Example
|
|
295
|
+
|
|
296
|
+
```javascript
|
|
297
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
298
|
+
// initial default api client
|
|
299
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
300
|
+
// for dev env
|
|
301
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
302
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
303
|
+
// call api
|
|
304
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
305
|
+
const chain_id = "ETH"; // String | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
306
|
+
apiInstance.getChainById(chain_id).then((data) => {
|
|
307
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
308
|
+
}, (error) => {
|
|
309
|
+
console.error(error);
|
|
310
|
+
});
|
|
311
|
+
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Parameters
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
Name | Type | Description | Notes
|
|
318
|
+
------------- | ------------- | ------------- | -------------
|
|
319
|
+
**chain_id** | **String**| The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
|
|
320
|
+
|
|
321
|
+
### Return type
|
|
322
|
+
|
|
323
|
+
[**ChainInfo**](ChainInfo.md)
|
|
324
|
+
|
|
325
|
+
### Authorization
|
|
326
|
+
|
|
327
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
328
|
+
|
|
329
|
+
### HTTP request headers
|
|
330
|
+
|
|
331
|
+
- **Content-Type**: Not defined
|
|
332
|
+
- **Accept**: application/json
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
## getMaxTransferableValue
|
|
336
|
+
|
|
337
|
+
> MaxTransferableValue getMaxTransferableValue(wallet_id, token_id, fee_rate, to_address, opts)
|
|
338
|
+
|
|
339
|
+
Get maximum transferable value
|
|
340
|
+
|
|
341
|
+
This operation retrieves the maximum amount that you can transfer from a wallet or a specified wallet address, along with the corresponding transaction fee. You must specify `to_address` in your query because it affects the transaction fee.
|
|
342
|
+
|
|
343
|
+
### Example
|
|
344
|
+
|
|
345
|
+
```javascript
|
|
346
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
347
|
+
// initial default api client
|
|
348
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
349
|
+
// for dev env
|
|
350
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
351
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
352
|
+
// call api
|
|
353
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
354
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
355
|
+
const token_id = "ETH_USDT"; // String | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
356
|
+
const fee_rate = "10"; // String | The fee rate in sats/vByte or gas price in wei.
|
|
357
|
+
const to_address = "2N2xFZtbCFB6Nb3Pj9Sxsx5mX2fxX3yEgkE"; // String | The recipient's address.
|
|
358
|
+
const opts = {
|
|
359
|
+
'from_address': "2N2xFZtbCFB6Nb3Pj9Sxsx5mX2fxX3yEgkE" // String | The sender's address. For EVM addresses in MPC Wallets, this parameter is required.
|
|
360
|
+
};
|
|
361
|
+
apiInstance.getMaxTransferableValue(wallet_id, token_id, fee_rate, to_address, opts).then((data) => {
|
|
362
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
363
|
+
}, (error) => {
|
|
364
|
+
console.error(error);
|
|
365
|
+
});
|
|
366
|
+
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
Name | Type | Description | Notes
|
|
373
|
+
------------- | ------------- | ------------- | -------------
|
|
374
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
375
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
|
|
376
|
+
**fee_rate** | **String**| The fee rate in sats/vByte or gas price in wei. |
|
|
377
|
+
**to_address** | **String**| The recipient's address. |
|
|
378
|
+
**from_address** | **String**| The sender's address. For EVM addresses in MPC Wallets, this parameter is required. | [optional]
|
|
379
|
+
|
|
380
|
+
### Return type
|
|
381
|
+
|
|
382
|
+
[**MaxTransferableValue**](MaxTransferableValue.md)
|
|
383
|
+
|
|
384
|
+
### Authorization
|
|
385
|
+
|
|
386
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
387
|
+
|
|
388
|
+
### HTTP request headers
|
|
389
|
+
|
|
390
|
+
- **Content-Type**: Not defined
|
|
391
|
+
- **Accept**: application/json
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
## getTokenById
|
|
395
|
+
|
|
396
|
+
> ExtendedTokenInfo getTokenById(token_id)
|
|
397
|
+
|
|
398
|
+
Get token information
|
|
399
|
+
|
|
400
|
+
This operation retrieves the detailed information about a specified token.
|
|
401
|
+
|
|
402
|
+
### Example
|
|
403
|
+
|
|
404
|
+
```javascript
|
|
405
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
406
|
+
// initial default api client
|
|
407
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
408
|
+
// for dev env
|
|
409
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
410
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
411
|
+
// call api
|
|
412
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
413
|
+
const token_id = "ETH_USDT"; // String | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
414
|
+
apiInstance.getTokenById(token_id).then((data) => {
|
|
415
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
416
|
+
}, (error) => {
|
|
417
|
+
console.error(error);
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
### Parameters
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
Name | Type | Description | Notes
|
|
426
|
+
------------- | ------------- | ------------- | -------------
|
|
427
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
|
|
428
|
+
|
|
429
|
+
### Return type
|
|
430
|
+
|
|
431
|
+
[**ExtendedTokenInfo**](ExtendedTokenInfo.md)
|
|
432
|
+
|
|
433
|
+
### Authorization
|
|
434
|
+
|
|
435
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
436
|
+
|
|
437
|
+
### HTTP request headers
|
|
438
|
+
|
|
439
|
+
- **Content-Type**: Not defined
|
|
440
|
+
- **Accept**: application/json
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
## getWalletById
|
|
444
|
+
|
|
445
|
+
> WalletInfo getWalletById(wallet_id)
|
|
446
|
+
|
|
447
|
+
Get wallet information
|
|
448
|
+
|
|
449
|
+
This operation retrieves the detailed information about a specified wallet.
|
|
450
|
+
|
|
451
|
+
### Example
|
|
452
|
+
|
|
453
|
+
```javascript
|
|
454
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
455
|
+
// initial default api client
|
|
456
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
457
|
+
// for dev env
|
|
458
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
459
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
460
|
+
// call api
|
|
461
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
462
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
463
|
+
apiInstance.getWalletById(wallet_id).then((data) => {
|
|
464
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
465
|
+
}, (error) => {
|
|
466
|
+
console.error(error);
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
Name | Type | Description | Notes
|
|
475
|
+
------------- | ------------- | ------------- | -------------
|
|
476
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
[**WalletInfo**](WalletInfo.md)
|
|
481
|
+
|
|
482
|
+
### Authorization
|
|
483
|
+
|
|
484
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
485
|
+
|
|
486
|
+
### HTTP request headers
|
|
487
|
+
|
|
488
|
+
- **Content-Type**: Not defined
|
|
489
|
+
- **Accept**: application/json
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
## listAddresses
|
|
493
|
+
|
|
494
|
+
> ListAddresses200Response listAddresses(wallet_id, opts)
|
|
495
|
+
|
|
496
|
+
List wallet addresses
|
|
497
|
+
|
|
498
|
+
This operation retrieves a list of addresses within a specified wallet.
|
|
499
|
+
|
|
500
|
+
### Example
|
|
501
|
+
|
|
502
|
+
```javascript
|
|
503
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
504
|
+
// initial default api client
|
|
505
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
506
|
+
// for dev env
|
|
507
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
508
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
509
|
+
// call api
|
|
510
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
511
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
512
|
+
const opts = {
|
|
513
|
+
'chain_ids': "BTC,ETH", // String | A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
514
|
+
'addresses': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045,0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97", // String | A list of wallet addresses, separated by comma.
|
|
515
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
516
|
+
'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.
|
|
517
|
+
'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.
|
|
518
|
+
};
|
|
519
|
+
apiInstance.listAddresses(wallet_id, opts).then((data) => {
|
|
520
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
521
|
+
}, (error) => {
|
|
522
|
+
console.error(error);
|
|
523
|
+
});
|
|
524
|
+
|
|
525
|
+
```
|
|
526
|
+
|
|
527
|
+
### Parameters
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
Name | Type | Description | Notes
|
|
531
|
+
------------- | ------------- | ------------- | -------------
|
|
532
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
533
|
+
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
534
|
+
**addresses** | **String**| A list of wallet addresses, separated by comma. | [optional]
|
|
535
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
536
|
+
**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]
|
|
537
|
+
**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]
|
|
538
|
+
|
|
539
|
+
### Return type
|
|
540
|
+
|
|
541
|
+
[**ListAddresses200Response**](ListAddresses200Response.md)
|
|
542
|
+
|
|
543
|
+
### Authorization
|
|
544
|
+
|
|
545
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: Not defined
|
|
550
|
+
- **Accept**: application/json
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
## listEnabledChains
|
|
554
|
+
|
|
555
|
+
> ListSupportedChains200Response listEnabledChains(opts)
|
|
556
|
+
|
|
557
|
+
List enabled chains
|
|
558
|
+
|
|
559
|
+
This operation retrieves all the chains that can be used by your organization. You can filter the result by wallet type or subtype. If you do not specify a wallet type, this operation returns a combination of chains that can be used by your organization for each wallet type.
|
|
560
|
+
|
|
561
|
+
### Example
|
|
562
|
+
|
|
563
|
+
```javascript
|
|
564
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
565
|
+
// initial default api client
|
|
566
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
567
|
+
// for dev env
|
|
568
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
569
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
570
|
+
// call api
|
|
571
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
572
|
+
const opts = {
|
|
573
|
+
'wallet_type': new CoboWaas2.WalletType(), // WalletType | The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
574
|
+
'wallet_subtype': new CoboWaas2.WalletSubtype(), // WalletSubtype | The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
575
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
576
|
+
'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.
|
|
577
|
+
'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.
|
|
578
|
+
};
|
|
579
|
+
apiInstance.listEnabledChains(opts).then((data) => {
|
|
580
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
581
|
+
}, (error) => {
|
|
582
|
+
console.error(error);
|
|
583
|
+
});
|
|
584
|
+
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
### Parameters
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
Name | Type | Description | Notes
|
|
591
|
+
------------- | ------------- | ------------- | -------------
|
|
592
|
+
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
593
|
+
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
594
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
595
|
+
**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]
|
|
596
|
+
**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]
|
|
597
|
+
|
|
598
|
+
### Return type
|
|
599
|
+
|
|
600
|
+
[**ListSupportedChains200Response**](ListSupportedChains200Response.md)
|
|
601
|
+
|
|
602
|
+
### Authorization
|
|
603
|
+
|
|
604
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
605
|
+
|
|
606
|
+
### HTTP request headers
|
|
607
|
+
|
|
608
|
+
- **Content-Type**: Not defined
|
|
609
|
+
- **Accept**: application/json
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
## listEnabledTokens
|
|
613
|
+
|
|
614
|
+
> ListSupportedTokens200Response listEnabledTokens(opts)
|
|
615
|
+
|
|
616
|
+
List enabled tokens
|
|
617
|
+
|
|
618
|
+
This operation retrieves all the tokens that can be used by your organization. You can filter the result by wallet type, subtype, and chain IDs. If you do not specify a wallet type, this operation returns a combination of tokens that can be used by your organization for each wallet type.
|
|
619
|
+
|
|
620
|
+
### Example
|
|
621
|
+
|
|
622
|
+
```javascript
|
|
623
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
624
|
+
// initial default api client
|
|
625
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
626
|
+
// for dev env
|
|
627
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
628
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
629
|
+
// call api
|
|
630
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
631
|
+
const opts = {
|
|
632
|
+
'wallet_type': new CoboWaas2.WalletType(), // WalletType | The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
633
|
+
'wallet_subtype': new CoboWaas2.WalletSubtype(), // WalletSubtype | The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
634
|
+
'chain_ids': "BTC,ETH", // String | A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
635
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
636
|
+
'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.
|
|
637
|
+
'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.
|
|
638
|
+
};
|
|
639
|
+
apiInstance.listEnabledTokens(opts).then((data) => {
|
|
640
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
641
|
+
}, (error) => {
|
|
642
|
+
console.error(error);
|
|
643
|
+
});
|
|
644
|
+
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
### Parameters
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
Name | Type | Description | Notes
|
|
651
|
+
------------- | ------------- | ------------- | -------------
|
|
652
|
+
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
653
|
+
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
654
|
+
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
655
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
656
|
+
**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]
|
|
657
|
+
**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]
|
|
658
|
+
|
|
659
|
+
### Return type
|
|
660
|
+
|
|
661
|
+
[**ListSupportedTokens200Response**](ListSupportedTokens200Response.md)
|
|
662
|
+
|
|
663
|
+
### Authorization
|
|
664
|
+
|
|
665
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
666
|
+
|
|
667
|
+
### HTTP request headers
|
|
668
|
+
|
|
669
|
+
- **Content-Type**: Not defined
|
|
670
|
+
- **Accept**: application/json
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
## listSupportedChains
|
|
674
|
+
|
|
675
|
+
> ListSupportedChains200Response listSupportedChains(opts)
|
|
676
|
+
|
|
677
|
+
List supported chains
|
|
678
|
+
|
|
679
|
+
This operation retrieves all chains supported by a specific wallet type or subtype. It provides details such as the chain ID, chain symbol, and other relevant information. If you do not specify a wallet type, this operation returns a combination of chains supported by each wallet type. You can filter the result by chain IDs. The chain metadata is publicly available without any permission restrictions.
|
|
680
|
+
|
|
681
|
+
### Example
|
|
682
|
+
|
|
683
|
+
```javascript
|
|
684
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
685
|
+
// initial default api client
|
|
686
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
687
|
+
// for dev env
|
|
688
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
689
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
690
|
+
// call api
|
|
691
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
692
|
+
const opts = {
|
|
693
|
+
'wallet_type': new CoboWaas2.WalletType(), // WalletType | The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
694
|
+
'wallet_subtype': new CoboWaas2.WalletSubtype(), // WalletSubtype | The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
695
|
+
'chain_ids': "BTC,ETH", // String | A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
696
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
697
|
+
'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.
|
|
698
|
+
'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.
|
|
699
|
+
};
|
|
700
|
+
apiInstance.listSupportedChains(opts).then((data) => {
|
|
701
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
702
|
+
}, (error) => {
|
|
703
|
+
console.error(error);
|
|
704
|
+
});
|
|
705
|
+
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
### Parameters
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
Name | Type | Description | Notes
|
|
712
|
+
------------- | ------------- | ------------- | -------------
|
|
713
|
+
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
714
|
+
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
715
|
+
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
716
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
717
|
+
**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]
|
|
718
|
+
**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]
|
|
719
|
+
|
|
720
|
+
### Return type
|
|
721
|
+
|
|
722
|
+
[**ListSupportedChains200Response**](ListSupportedChains200Response.md)
|
|
723
|
+
|
|
724
|
+
### Authorization
|
|
725
|
+
|
|
726
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
727
|
+
|
|
728
|
+
### HTTP request headers
|
|
729
|
+
|
|
730
|
+
- **Content-Type**: Not defined
|
|
731
|
+
- **Accept**: application/json
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
## listSupportedTokens
|
|
735
|
+
|
|
736
|
+
> ListSupportedTokens200Response listSupportedTokens(opts)
|
|
737
|
+
|
|
738
|
+
List supported tokens
|
|
739
|
+
|
|
740
|
+
This operation retrieves all tokens supported by a specific wallet type or subtype. It provides details such as token ID, token symbol, and other relevant information. If you do not specify a wallet type, this operation returns a combination of tokens supported by each wallet type. You can filter the result by token IDs or chain IDs. The token metadata is publicly available without any permission restrictions.
|
|
741
|
+
|
|
742
|
+
### Example
|
|
743
|
+
|
|
744
|
+
```javascript
|
|
745
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
746
|
+
// initial default api client
|
|
747
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
748
|
+
// for dev env
|
|
749
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
750
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
751
|
+
// call api
|
|
752
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
753
|
+
const opts = {
|
|
754
|
+
'wallet_type': new CoboWaas2.WalletType(), // WalletType | The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
755
|
+
'wallet_subtype': new CoboWaas2.WalletSubtype(), // WalletSubtype | The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
756
|
+
'chain_ids': "BTC,ETH", // String | A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains).
|
|
757
|
+
'token_ids': "ETH_USDT,ETH_USDC", // String | A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
758
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
759
|
+
'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.
|
|
760
|
+
'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.
|
|
761
|
+
};
|
|
762
|
+
apiInstance.listSupportedTokens(opts).then((data) => {
|
|
763
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
764
|
+
}, (error) => {
|
|
765
|
+
console.error(error);
|
|
766
|
+
});
|
|
767
|
+
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
### Parameters
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
Name | Type | Description | Notes
|
|
774
|
+
------------- | ------------- | ------------- | -------------
|
|
775
|
+
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
776
|
+
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
777
|
+
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
778
|
+
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
779
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
780
|
+
**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]
|
|
781
|
+
**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]
|
|
782
|
+
|
|
783
|
+
### Return type
|
|
784
|
+
|
|
785
|
+
[**ListSupportedTokens200Response**](ListSupportedTokens200Response.md)
|
|
786
|
+
|
|
787
|
+
### Authorization
|
|
788
|
+
|
|
789
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
790
|
+
|
|
791
|
+
### HTTP request headers
|
|
792
|
+
|
|
793
|
+
- **Content-Type**: Not defined
|
|
794
|
+
- **Accept**: application/json
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
## listTokenBalancesForAddress
|
|
798
|
+
|
|
799
|
+
> ListTokenBalancesForAddress200Response listTokenBalancesForAddress(wallet_id, address, opts)
|
|
800
|
+
|
|
801
|
+
List token balances by address
|
|
802
|
+
|
|
803
|
+
The operation retrieves a list of token balances for a specified address within an MPC Wallet. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
804
|
+
|
|
805
|
+
### Example
|
|
806
|
+
|
|
807
|
+
```javascript
|
|
808
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
809
|
+
// initial default api client
|
|
810
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
811
|
+
// for dev env
|
|
812
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
813
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
814
|
+
// call api
|
|
815
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
816
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
817
|
+
const address = "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"; // String | The wallet address.
|
|
818
|
+
const opts = {
|
|
819
|
+
'token_ids': "ETH_USDT,ETH_USDC", // String | A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
820
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
821
|
+
'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.
|
|
822
|
+
'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.
|
|
823
|
+
};
|
|
824
|
+
apiInstance.listTokenBalancesForAddress(wallet_id, address, opts).then((data) => {
|
|
825
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
826
|
+
}, (error) => {
|
|
827
|
+
console.error(error);
|
|
828
|
+
});
|
|
829
|
+
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
### Parameters
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
Name | Type | Description | Notes
|
|
836
|
+
------------- | ------------- | ------------- | -------------
|
|
837
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
838
|
+
**address** | **String**| The wallet address. |
|
|
839
|
+
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
840
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
841
|
+
**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]
|
|
842
|
+
**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]
|
|
843
|
+
|
|
844
|
+
### Return type
|
|
845
|
+
|
|
846
|
+
[**ListTokenBalancesForAddress200Response**](ListTokenBalancesForAddress200Response.md)
|
|
847
|
+
|
|
848
|
+
### Authorization
|
|
849
|
+
|
|
850
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
851
|
+
|
|
852
|
+
### HTTP request headers
|
|
853
|
+
|
|
854
|
+
- **Content-Type**: Not defined
|
|
855
|
+
- **Accept**: application/json
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
## listTokenBalancesForWallet
|
|
859
|
+
|
|
860
|
+
> ListTokenBalancesForAddress200Response listTokenBalancesForWallet(wallet_id, opts)
|
|
861
|
+
|
|
862
|
+
List token balances by wallet
|
|
863
|
+
|
|
864
|
+
The operation retrieves a list of token balances within a specified wallet. <Note>This operation is applicable to Custodial Wallets and MPC Wallets only.</Note>
|
|
865
|
+
|
|
866
|
+
### Example
|
|
867
|
+
|
|
868
|
+
```javascript
|
|
869
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
870
|
+
// initial default api client
|
|
871
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
872
|
+
// for dev env
|
|
873
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
874
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
875
|
+
// call api
|
|
876
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
877
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
878
|
+
const opts = {
|
|
879
|
+
'token_ids': "ETH_USDT,ETH_USDC", // String | A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
880
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
881
|
+
'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.
|
|
882
|
+
'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.
|
|
883
|
+
};
|
|
884
|
+
apiInstance.listTokenBalancesForWallet(wallet_id, opts).then((data) => {
|
|
885
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
886
|
+
}, (error) => {
|
|
887
|
+
console.error(error);
|
|
888
|
+
});
|
|
889
|
+
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
### Parameters
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
Name | Type | Description | Notes
|
|
896
|
+
------------- | ------------- | ------------- | -------------
|
|
897
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
898
|
+
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
899
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
900
|
+
**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]
|
|
901
|
+
**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]
|
|
902
|
+
|
|
903
|
+
### Return type
|
|
904
|
+
|
|
905
|
+
[**ListTokenBalancesForAddress200Response**](ListTokenBalancesForAddress200Response.md)
|
|
906
|
+
|
|
907
|
+
### Authorization
|
|
908
|
+
|
|
909
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
910
|
+
|
|
911
|
+
### HTTP request headers
|
|
912
|
+
|
|
913
|
+
- **Content-Type**: Not defined
|
|
914
|
+
- **Accept**: application/json
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
## listUtxos
|
|
918
|
+
|
|
919
|
+
> ListUtxos200Response listUtxos(wallet_id, token_id, opts)
|
|
920
|
+
|
|
921
|
+
List UTXOs
|
|
922
|
+
|
|
923
|
+
The operation retrieves a list of unspent transaction outputs (UTXOs) for a specified wallet and token. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
924
|
+
|
|
925
|
+
### Example
|
|
926
|
+
|
|
927
|
+
```javascript
|
|
928
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
929
|
+
// initial default api client
|
|
930
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
931
|
+
// for dev env
|
|
932
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
933
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
934
|
+
// call api
|
|
935
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
936
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
937
|
+
const token_id = "ETH_USDT"; // String | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens).
|
|
938
|
+
const opts = {
|
|
939
|
+
'address': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", // String | The wallet address.
|
|
940
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
941
|
+
'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.
|
|
942
|
+
'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.
|
|
943
|
+
};
|
|
944
|
+
apiInstance.listUtxos(wallet_id, token_id, opts).then((data) => {
|
|
945
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
946
|
+
}, (error) => {
|
|
947
|
+
console.error(error);
|
|
948
|
+
});
|
|
949
|
+
|
|
950
|
+
```
|
|
951
|
+
|
|
952
|
+
### Parameters
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
Name | Type | Description | Notes
|
|
956
|
+
------------- | ------------- | ------------- | -------------
|
|
957
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
958
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
|
|
959
|
+
**address** | **String**| The wallet address. | [optional]
|
|
960
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
961
|
+
**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]
|
|
962
|
+
**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]
|
|
963
|
+
|
|
964
|
+
### Return type
|
|
965
|
+
|
|
966
|
+
[**ListUtxos200Response**](ListUtxos200Response.md)
|
|
967
|
+
|
|
968
|
+
### Authorization
|
|
969
|
+
|
|
970
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
971
|
+
|
|
972
|
+
### HTTP request headers
|
|
973
|
+
|
|
974
|
+
- **Content-Type**: Not defined
|
|
975
|
+
- **Accept**: application/json
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
## listWallets
|
|
979
|
+
|
|
980
|
+
> ListWallets200Response listWallets(opts)
|
|
981
|
+
|
|
982
|
+
List all wallets
|
|
983
|
+
|
|
984
|
+
This operation retrieves the information of all wallets under your organization. You can filter the result by wallet type and subtype. For MPC Wallets, you can also filter by project ID and vault ID. <Note>You must specify either the wallet type or subtype, or both.</Note>
|
|
985
|
+
|
|
986
|
+
### Example
|
|
987
|
+
|
|
988
|
+
```javascript
|
|
989
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
990
|
+
// initial default api client
|
|
991
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
992
|
+
// for dev env
|
|
993
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
994
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
995
|
+
// call api
|
|
996
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
997
|
+
const opts = {
|
|
998
|
+
'wallet_type': new CoboWaas2.WalletType(), // WalletType | The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
999
|
+
'wallet_subtype': new CoboWaas2.WalletSubtype(), // WalletSubtype | The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
1000
|
+
'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).
|
|
1001
|
+
'vault_id': "f47ac10b-58cc-4372-a567-0e02b2c3d479", // String | (This parameter is applicable to MPC Wallets only) The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
1002
|
+
'limit': 10, // Number | The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
1003
|
+
'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.
|
|
1004
|
+
'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.
|
|
1005
|
+
};
|
|
1006
|
+
apiInstance.listWallets(opts).then((data) => {
|
|
1007
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1008
|
+
}, (error) => {
|
|
1009
|
+
console.error(error);
|
|
1010
|
+
});
|
|
1011
|
+
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
### Parameters
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
Name | Type | Description | Notes
|
|
1018
|
+
------------- | ------------- | ------------- | -------------
|
|
1019
|
+
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
1020
|
+
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
1021
|
+
**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]
|
|
1022
|
+
**vault_id** | **String**| (This parameter is applicable to MPC Wallets only) The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallets/list-all-vaults). | [optional]
|
|
1023
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1024
|
+
**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]
|
|
1025
|
+
**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]
|
|
1026
|
+
|
|
1027
|
+
### Return type
|
|
1028
|
+
|
|
1029
|
+
[**ListWallets200Response**](ListWallets200Response.md)
|
|
1030
|
+
|
|
1031
|
+
### Authorization
|
|
1032
|
+
|
|
1033
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
1034
|
+
|
|
1035
|
+
### HTTP request headers
|
|
1036
|
+
|
|
1037
|
+
- **Content-Type**: Not defined
|
|
1038
|
+
- **Accept**: application/json
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
## lockUtxos
|
|
1042
|
+
|
|
1043
|
+
> LockUtxos201Response lockUtxos(wallet_id, opts)
|
|
1044
|
+
|
|
1045
|
+
Lock UTXOs
|
|
1046
|
+
|
|
1047
|
+
This operation locks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
1048
|
+
|
|
1049
|
+
### Example
|
|
1050
|
+
|
|
1051
|
+
```javascript
|
|
1052
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1053
|
+
// initial default api client
|
|
1054
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1055
|
+
// for dev env
|
|
1056
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1057
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
1058
|
+
// call api
|
|
1059
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
1060
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
1061
|
+
const opts = {
|
|
1062
|
+
'LockUtxosRequest': new CoboWaas2.LockUtxosRequest() // LockUtxosRequest | The request body of the Lock/Unlock UTXOs operation.
|
|
1063
|
+
};
|
|
1064
|
+
apiInstance.lockUtxos(wallet_id, opts).then((data) => {
|
|
1065
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1066
|
+
}, (error) => {
|
|
1067
|
+
console.error(error);
|
|
1068
|
+
});
|
|
1069
|
+
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
### Parameters
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
Name | Type | Description | Notes
|
|
1076
|
+
------------- | ------------- | ------------- | -------------
|
|
1077
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
1078
|
+
**LockUtxosRequest** | [**LockUtxosRequest**](LockUtxosRequest.md)| The request body of the Lock/Unlock UTXOs operation. | [optional]
|
|
1079
|
+
|
|
1080
|
+
### Return type
|
|
1081
|
+
|
|
1082
|
+
[**LockUtxos201Response**](LockUtxos201Response.md)
|
|
1083
|
+
|
|
1084
|
+
### Authorization
|
|
1085
|
+
|
|
1086
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1087
|
+
|
|
1088
|
+
### HTTP request headers
|
|
1089
|
+
|
|
1090
|
+
- **Content-Type**: application/json
|
|
1091
|
+
- **Accept**: application/json
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
## unlockUtxos
|
|
1095
|
+
|
|
1096
|
+
> LockUtxos201Response unlockUtxos(wallet_id, opts)
|
|
1097
|
+
|
|
1098
|
+
Unlock UTXOs
|
|
1099
|
+
|
|
1100
|
+
This operation unlocks the UTXOs with specified transaction hashes. Locked UTXOs cannot be transferred until unlocked. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
1101
|
+
|
|
1102
|
+
### Example
|
|
1103
|
+
|
|
1104
|
+
```javascript
|
|
1105
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1106
|
+
// initial default api client
|
|
1107
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1108
|
+
// for dev env
|
|
1109
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1110
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
1111
|
+
// call api
|
|
1112
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
1113
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
1114
|
+
const opts = {
|
|
1115
|
+
'LockUtxosRequest': new CoboWaas2.LockUtxosRequest() // LockUtxosRequest | The request body of the Lock/Unlock UTXOs operation.
|
|
1116
|
+
};
|
|
1117
|
+
apiInstance.unlockUtxos(wallet_id, opts).then((data) => {
|
|
1118
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1119
|
+
}, (error) => {
|
|
1120
|
+
console.error(error);
|
|
1121
|
+
});
|
|
1122
|
+
|
|
1123
|
+
```
|
|
1124
|
+
|
|
1125
|
+
### Parameters
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
Name | Type | Description | Notes
|
|
1129
|
+
------------- | ------------- | ------------- | -------------
|
|
1130
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
1131
|
+
**LockUtxosRequest** | [**LockUtxosRequest**](LockUtxosRequest.md)| The request body of the Lock/Unlock UTXOs operation. | [optional]
|
|
1132
|
+
|
|
1133
|
+
### Return type
|
|
1134
|
+
|
|
1135
|
+
[**LockUtxos201Response**](LockUtxos201Response.md)
|
|
1136
|
+
|
|
1137
|
+
### Authorization
|
|
1138
|
+
|
|
1139
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1140
|
+
|
|
1141
|
+
### HTTP request headers
|
|
1142
|
+
|
|
1143
|
+
- **Content-Type**: application/json
|
|
1144
|
+
- **Accept**: application/json
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
## updateWalletById
|
|
1148
|
+
|
|
1149
|
+
> WalletInfo updateWalletById(wallet_id, opts)
|
|
1150
|
+
|
|
1151
|
+
Update wallet
|
|
1152
|
+
|
|
1153
|
+
This operation updates the information of a specified wallet. For Exchange Wallets, you can update the API key, API secret, and other information about your exchange accounts with this operation. For other wallet types, you can only update the wallet name.
|
|
1154
|
+
|
|
1155
|
+
### Example
|
|
1156
|
+
|
|
1157
|
+
```javascript
|
|
1158
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
1159
|
+
// initial default api client
|
|
1160
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
1161
|
+
// for dev env
|
|
1162
|
+
// apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
1163
|
+
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
|
|
1164
|
+
// call api
|
|
1165
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
1166
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; // String | The wallet ID.
|
|
1167
|
+
const opts = {
|
|
1168
|
+
'UpdateWalletParams': new CoboWaas2.UpdateWalletParams() // UpdateWalletParams | The request body.
|
|
1169
|
+
};
|
|
1170
|
+
apiInstance.updateWalletById(wallet_id, opts).then((data) => {
|
|
1171
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1172
|
+
}, (error) => {
|
|
1173
|
+
console.error(error);
|
|
1174
|
+
});
|
|
1175
|
+
|
|
1176
|
+
```
|
|
1177
|
+
|
|
1178
|
+
### Parameters
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
Name | Type | Description | Notes
|
|
1182
|
+
------------- | ------------- | ------------- | -------------
|
|
1183
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
1184
|
+
**UpdateWalletParams** | [**UpdateWalletParams**](UpdateWalletParams.md)| The request body. | [optional]
|
|
1185
|
+
|
|
1186
|
+
### Return type
|
|
1187
|
+
|
|
1188
|
+
[**WalletInfo**](WalletInfo.md)
|
|
1189
|
+
|
|
1190
|
+
### Authorization
|
|
1191
|
+
|
|
1192
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
1193
|
+
|
|
1194
|
+
### HTTP request headers
|
|
1195
|
+
|
|
1196
|
+
- **Content-Type**: application/json
|
|
1197
|
+
- **Accept**: application/json
|
|
1198
|
+
|