@cobo/cobo-waas2 1.20.0 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -4
- package/dist/ApiClient.js +11 -2
- package/dist/PreRequestScript.js +2 -4
- package/dist/api/AutoSweepApi.js +289 -0
- package/dist/api/PaymentApi.js +386 -24
- package/dist/api/TokenizationApi.js +1024 -0
- package/dist/api/TransactionsApi.js +103 -2
- package/dist/api/WalletsApi.js +2 -2
- package/dist/crypto/ApiSigner.js +5 -1
- package/dist/index.js +175 -0
- package/dist/model/AddressesEventData.js +3 -3
- package/dist/model/ApprovalDetail.js +7 -7
- package/dist/model/AutoSweepTask.js +198 -0
- package/dist/model/AutoSweepTaskStatus.js +61 -0
- package/dist/model/BalanceUpdateInfoEventData.js +3 -3
- package/dist/model/ChainsEventData.js +3 -3
- package/dist/model/CreateAutoSweepTask.js +126 -0
- package/dist/model/CreateCryptoAddressRequest.js +138 -0
- package/dist/model/CreateCustodialWalletParams.js +9 -0
- package/dist/model/CreateExchangeWalletParams.js +14 -0
- package/dist/model/CreateMpcWalletParams.js +14 -0
- package/dist/model/CreatePaymentOrderRequest.js +5 -5
- package/dist/model/CreateSafeWalletParams.js +9 -0
- package/dist/model/CreateSettlement.js +27 -4
- package/dist/model/CreateSmartContractWalletParams.js +6 -0
- package/dist/model/CreateSweepToAddress.js +126 -0
- package/dist/model/CreateWalletParams.js +6 -0
- package/dist/model/CreatedWalletInfo.js +6 -0
- package/dist/model/CryptoAddress.js +12 -12
- package/dist/model/CustodialWalletInfo.js +9 -0
- package/dist/model/DeleteCryptoAddress201Response.js +110 -0
- package/dist/model/ExchangeWalletInfo.js +14 -0
- package/dist/model/ForcedSweep.js +9 -9
- package/dist/model/ForcedSweepRequest.js +8 -9
- package/dist/model/GetTokenizationAllowlistActivation200Response.js +107 -0
- package/dist/model/ListAutoSweepTask200Response.js +123 -0
- package/dist/model/ListMerchantBalances200Response.js +107 -0
- package/dist/model/ListPaymentWalletBalances200Response.js +107 -0
- package/dist/model/ListSettlementDetails200Response.js +123 -0
- package/dist/model/ListTokenizationBlocklistAddresses200Response.js +145 -0
- package/dist/model/ListWalletSweepToAddresses200Response.js +107 -0
- package/dist/model/MPCVaultEventData.js +3 -3
- package/dist/model/MPCWalletInfo.js +14 -0
- package/dist/model/MerchantBalance.js +201 -0
- package/dist/model/PaymentAddressUpdateEventData.js +13 -13
- package/dist/model/PaymentOrderEventData.js +3 -3
- package/dist/model/PaymentRefundEventData.js +3 -3
- package/dist/model/PaymentSettlementEvent.js +42 -3
- package/dist/model/PaymentTransactionEventData.js +6 -6
- package/dist/model/PaymentWalletBalance.js +177 -0
- package/dist/model/PspBalance.js +175 -0
- package/dist/model/ReceivedAmountPerAddress.js +126 -0
- package/dist/model/SafeWallet.js +9 -0
- package/dist/model/Settlement.js +27 -0
- package/dist/model/SettlementDetail.js +26 -0
- package/dist/model/SettlementInfo.js +7 -7
- package/dist/model/SmartContractWalletInfo.js +6 -0
- package/dist/model/SuspendedTokenEventData.js +3 -3
- package/dist/model/SweepToAddress.js +135 -0
- package/dist/model/SweepToAddressStatus.js +61 -0
- package/dist/model/TSSRequestWebhookEventData.js +3 -3
- package/dist/model/TokenListingEventData.js +3 -3
- package/dist/model/TokenizationActivityInfo.js +8 -4
- package/dist/model/TokenizationAllowlistActivationRequest.js +13 -0
- package/dist/model/TokenizationAllowlistAddressNote.js +4 -4
- package/dist/model/TokenizationAllowlistAddressesResponse.js +145 -0
- package/dist/model/TokenizationBlocklistAddressNote.js +4 -4
- package/dist/model/TokenizationBurnEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationBurnTokenParamsBurnsInner.js +4 -4
- package/dist/model/TokenizationBurnTokenRequest.js +13 -0
- package/dist/model/TokenizationContractCallEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationContractCallParamsData.js +43 -9
- package/dist/model/TokenizationContractCallRequest.js +13 -0
- package/dist/model/TokenizationContractCallType.js +5 -0
- package/dist/model/TokenizationERC20TokenParams.js +4 -4
- package/dist/model/TokenizationEstimateFeeRequestOperationParams.js +6 -0
- package/dist/model/TokenizationEvmContractCallParams.js +2 -2
- package/dist/model/TokenizationIssueEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationIssueTokenParamsTokenParams.js +40 -12
- package/dist/model/TokenizationIssuedTokenRequest.js +14 -1
- package/dist/model/TokenizationMintEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationMintTokenRequest.js +13 -0
- package/dist/model/TokenizationMpcOperationSource.js +2 -2
- package/dist/model/TokenizationPauseEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationPauseTokenRequest.js +13 -0
- package/dist/model/TokenizationSOLTokenParams.js +173 -0
- package/dist/model/TokenizationSolContractCallParams.js +137 -0
- package/dist/model/TokenizationSolTokenPermissionParams.js +140 -0
- package/dist/model/TokenizationToggleAllowlistEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationTokenDetailInfo.js +6 -6
- package/dist/model/TokenizationTokenInfo.js +4 -4
- package/dist/model/TokenizationTokenOperationSource.js +1 -1
- package/dist/model/TokenizationTokenPermissionParams.js +1 -1
- package/dist/model/TokenizationTokenPermissionType.js +15 -0
- package/dist/model/TokenizationTokenStandard.js +5 -0
- package/dist/model/TokenizationUnpauseEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUnpauseTokenRequest.js +13 -0
- package/dist/model/TokenizationUpdateAllowlistAddressesEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUpdateAllowlistAddressesParamsAddressesInner.js +1 -1
- package/dist/model/TokenizationUpdateAllowlistAddressesRequest.js +13 -0
- package/dist/model/TokenizationUpdateBlocklistAddressesEstimateFeeParams.js +13 -0
- package/dist/model/TokenizationUpdateBlocklistAddressesParamsAddressesInner.js +1 -1
- package/dist/model/TokenizationUpdateBlocklistAddressesRequest.js +13 -0
- package/dist/model/TokenizationWeb3OperationSource.js +2 -2
- package/dist/model/TokensEventData.js +3 -3
- package/dist/model/TopUpAddress.js +0 -1
- package/dist/model/TransactionWebhookEventData.js +3 -3
- package/dist/model/UpdateCustodialWalletParams.js +13 -6
- package/dist/model/UpdateMpcWalletParams.js +13 -6
- package/dist/model/UpdateTopUpAddress.js +3 -3
- package/dist/model/UpdateWalletParams.js +6 -0
- package/dist/model/WalletInfo.js +6 -0
- package/dist/model/WalletInfoEventData.js +3 -3
- package/dist/model/WebhookEventData.js +19 -7
- package/dist/model/WebhookEventDataType.js +2 -2
- package/docs/AddressesEventData.md +1 -1
- package/docs/ApprovalDetail.md +1 -1
- package/docs/AutoSweepApi.md +285 -0
- package/docs/AutoSweepTask.md +16 -0
- package/docs/AutoSweepTaskStatus.md +12 -0
- package/docs/BalanceUpdateInfoEventData.md +1 -1
- package/docs/ChainsEventData.md +1 -1
- package/docs/CreateAutoSweepTask.md +10 -0
- package/docs/CreateCryptoAddressRequest.md +11 -0
- package/docs/CreateCustodialWalletParams.md +1 -0
- package/docs/CreateExchangeWalletParams.md +1 -0
- package/docs/CreateMpcWalletParams.md +1 -0
- package/docs/CreatePaymentOrderRequest.md +3 -3
- package/docs/CreateSafeWalletParams.md +1 -0
- package/docs/CreateSettlement.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -0
- package/docs/CreateSweepToAddress.md +10 -0
- package/docs/CreateWalletParams.md +1 -0
- package/docs/CreatedWalletInfo.md +1 -0
- package/docs/CryptoAddress.md +1 -1
- package/docs/CustodialWalletInfo.md +1 -0
- package/docs/DeleteCryptoAddress201Response.md +9 -0
- package/docs/ExchangeWalletInfo.md +1 -0
- package/docs/ForcedSweep.md +7 -7
- package/docs/ForcedSweepRequest.md +4 -4
- package/docs/GetTokenizationAllowlistActivation200Response.md +9 -0
- package/docs/ListAutoSweepTask200Response.md +10 -0
- package/docs/ListMerchantBalances200Response.md +9 -0
- package/docs/ListPaymentWalletBalances200Response.md +9 -0
- package/docs/ListSettlementDetails200Response.md +10 -0
- package/docs/ListTokenizationBlocklistAddresses200Response.md +10 -0
- package/docs/ListWalletSweepToAddresses200Response.md +9 -0
- package/docs/MPCVaultEventData.md +1 -1
- package/docs/MPCWalletInfo.md +1 -0
- package/docs/MerchantBalance.md +16 -0
- package/docs/PaymentAddressUpdateEventData.md +6 -6
- package/docs/PaymentApi.md +403 -16
- package/docs/PaymentOrderEventData.md +1 -1
- package/docs/PaymentRefundEventData.md +1 -1
- package/docs/PaymentSettlementEvent.md +4 -1
- package/docs/PaymentTransactionEventData.md +4 -4
- package/docs/PaymentWalletBalance.md +14 -0
- package/docs/PspBalance.md +14 -0
- package/docs/ReceivedAmountPerAddress.md +10 -0
- package/docs/SafeWallet.md +1 -0
- package/docs/Settlement.md +3 -0
- package/docs/SettlementDetail.md +2 -0
- package/docs/SettlementInfo.md +6 -6
- package/docs/SmartContractWalletInfo.md +1 -0
- package/docs/SuspendedTokenEventData.md +1 -1
- package/docs/SweepToAddress.md +11 -0
- package/docs/SweepToAddressStatus.md +12 -0
- package/docs/TSSRequestWebhookEventData.md +1 -1
- package/docs/TokenListingEventData.md +1 -1
- package/docs/TokenizationActivityInfo.md +2 -2
- package/docs/TokenizationAllowlistActivationRequest.md +1 -0
- package/docs/TokenizationAllowlistAddressNote.md +3 -3
- package/docs/TokenizationAllowlistAddressesResponse.md +10 -0
- package/docs/TokenizationApi.md +1069 -0
- package/docs/TokenizationBlocklistAddressNote.md +3 -3
- package/docs/TokenizationBurnEstimateFeeParams.md +1 -0
- package/docs/TokenizationBurnTokenParamsBurnsInner.md +2 -2
- package/docs/TokenizationBurnTokenRequest.md +1 -0
- package/docs/TokenizationContractCallEstimateFeeParams.md +1 -0
- package/docs/TokenizationContractCallParamsData.md +2 -1
- package/docs/TokenizationContractCallRequest.md +1 -0
- package/docs/TokenizationContractCallType.md +2 -0
- package/docs/TokenizationERC20TokenParams.md +1 -1
- package/docs/TokenizationEstimateFeeRequestOperationParams.md +1 -0
- package/docs/TokenizationEvmContractCallParams.md +1 -1
- package/docs/TokenizationIssueEstimateFeeParams.md +1 -0
- package/docs/TokenizationIssueTokenParamsTokenParams.md +2 -2
- package/docs/TokenizationIssuedTokenRequest.md +2 -1
- package/docs/TokenizationMintEstimateFeeParams.md +1 -0
- package/docs/TokenizationMintTokenRequest.md +1 -0
- package/docs/TokenizationMpcOperationSource.md +1 -1
- package/docs/TokenizationPauseEstimateFeeParams.md +1 -0
- package/docs/TokenizationPauseTokenRequest.md +1 -0
- package/docs/TokenizationSOLTokenParams.md +14 -0
- package/docs/TokenizationSolContractCallParams.md +10 -0
- package/docs/TokenizationSolTokenPermissionParams.md +13 -0
- package/docs/TokenizationToggleAllowlistEstimateFeeParams.md +1 -0
- package/docs/TokenizationTokenDetailInfo.md +1 -1
- package/docs/TokenizationTokenInfo.md +1 -1
- package/docs/TokenizationTokenOperationSource.md +1 -1
- package/docs/TokenizationTokenPermissionType.md +6 -0
- package/docs/TokenizationTokenStandard.md +2 -0
- package/docs/TokenizationUnpauseEstimateFeeParams.md +1 -0
- package/docs/TokenizationUnpauseTokenRequest.md +1 -0
- package/docs/TokenizationUpdateAllowlistAddressesEstimateFeeParams.md +1 -0
- package/docs/TokenizationUpdateAllowlistAddressesParamsAddressesInner.md +1 -1
- package/docs/TokenizationUpdateAllowlistAddressesRequest.md +1 -0
- package/docs/TokenizationUpdateBlocklistAddressesEstimateFeeParams.md +1 -0
- package/docs/TokenizationUpdateBlocklistAddressesParamsAddressesInner.md +1 -1
- package/docs/TokenizationUpdateBlocklistAddressesRequest.md +1 -0
- package/docs/TokenizationWeb3OperationSource.md +1 -1
- package/docs/TokensEventData.md +1 -1
- package/docs/TransactionWebhookEventData.md +1 -1
- package/docs/TransactionsApi.md +113 -1
- package/docs/UpdateCustodialWalletParams.md +2 -1
- package/docs/UpdateMpcWalletParams.md +2 -1
- package/docs/UpdateTopUpAddress.md +1 -1
- package/docs/UpdateWalletParams.md +1 -0
- package/docs/WalletInfo.md +1 -0
- package/docs/WalletInfoEventData.md +1 -1
- package/docs/WalletsApi.md +1 -1
- package/docs/WebhookEventData.md +9 -7
- package/docs/WebhookEventDataType.md +1 -1
- package/package.json +1 -1
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**address** | **String** | The
|
|
8
|
-
**note** | **String** | The note for the
|
|
9
|
-
**created_timestamp** | **Number** | The time when the
|
|
7
|
+
**address** | **String** | The address on the blocklist. |
|
|
8
|
+
**note** | **String** | The note for the address on the blocklist. | [optional]
|
|
9
|
+
**created_timestamp** | **Number** | The time when the address was added to the blocklist, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**burns** | [**[TokenizationBurnTokenParamsBurnsInner]**](TokenizationBurnTokenParamsBurnsInner.md) | Details for each token burn, including amount and address to burn from. |
|
|
9
9
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
10
10
|
**token_id** | **String** | The ID of the token. |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**amount** | **String** | The amount of tokens to burn
|
|
8
|
-
**from_address** | **String** | The address to burn tokens from
|
|
7
|
+
**amount** | **String** | The amount of tokens to burn. |
|
|
8
|
+
**from_address** | **String** | The address to burn tokens from. |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**burns** | [**[TokenizationBurnTokenParamsBurnsInner]**](TokenizationBurnTokenParamsBurnsInner.md) | Details for each token burn, including amount and address to burn from. |
|
|
9
9
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
10
10
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**data** | [**TokenizationContractCallParamsData**](TokenizationContractCallParamsData.md) | | [optional]
|
|
9
9
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
10
10
|
**token_id** | **String** | The ID of the token. |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**type** | [**TokenizationContractCallType**](TokenizationContractCallType.md) | | [optional]
|
|
8
|
-
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address
|
|
8
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
9
9
|
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
|
+
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
10
11
|
|
|
11
12
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**data** | [**TokenizationContractCallParamsData**](TokenizationContractCallParamsData.md) | | [optional]
|
|
9
9
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
10
10
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | The name of the token. |
|
|
9
9
|
**symbol** | **String** | The symbol of the token. |
|
|
10
10
|
**decimals** | **Number** | The number of decimals for the token (0-18). |
|
|
11
|
-
**
|
|
11
|
+
**token_access_activated** | **Boolean** | Whether the allowlist feature is activated for the token. When activated, only addresses in the allowlist can perform token operations. | [optional] [default to false]
|
|
12
12
|
**permissions** | [**TokenizationTokenPermissionParams**](TokenizationTokenPermissionParams.md) | | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
9
9
|
**token_params** | [**TokenizationIssueTokenParamsTokenParams**](TokenizationIssueTokenParamsTokenParams.md) | |
|
|
10
10
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
**mints** | [**[TokenizationMintTokenParamsMintsInner]**](TokenizationMintTokenParamsMintsInner.md) | Details for each token mint, including amount and address to mint to. |
|
|
12
13
|
**token_id** | **String** | The ID of the token. |
|
|
13
14
|
**burns** | [**[TokenizationBurnTokenParamsBurnsInner]**](TokenizationBurnTokenParamsBurnsInner.md) | Details for each token burn, including amount and address to burn from. |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**type** | [**TokenizationContractCallType**](TokenizationContractCallType.md) | | [optional]
|
|
8
|
-
**calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address
|
|
8
|
+
**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address. |
|
|
9
9
|
**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
9
9
|
**token_params** | [**TokenizationIssueTokenParamsTokenParams**](TokenizationIssueTokenParamsTokenParams.md) | |
|
|
10
10
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | The name of the token. |
|
|
9
9
|
**symbol** | **String** | The symbol of the token. |
|
|
10
10
|
**decimals** | **Number** | The number of decimals for the token (0-18). |
|
|
11
|
-
**
|
|
12
|
-
**permissions** | [**
|
|
11
|
+
**token_access_activated** | **Boolean** | Whether the allowlist feature is activated for the token. When activated, only addresses in the allowlist can perform token operations. | [optional] [default to false]
|
|
12
|
+
**permissions** | [**TokenizationSolTokenPermissionParams**](TokenizationSolTokenPermissionParams.md) | | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**chain_id** | **String** | The chain ID where the token will be issued. |
|
|
8
8
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
9
9
|
**token_params** | [**TokenizationIssueTokenParamsTokenParams**](TokenizationIssueTokenParamsTokenParams.md) | |
|
|
10
|
-
**app_initiator** | **String** | The
|
|
10
|
+
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
11
11
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
12
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**mints** | [**[TokenizationMintTokenParamsMintsInner]**](TokenizationMintTokenParamsMintsInner.md) | Details for each token mint, including amount and address to mint to. |
|
|
9
9
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
10
10
|
**token_id** | **String** | The ID of the token. |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**mints** | [**[TokenizationMintTokenParamsMintsInner]**](TokenizationMintTokenParamsMintsInner.md) | Details for each token mint, including amount and address to mint to. |
|
|
9
9
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
10
10
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**source_type** | [**TokenizationOperationSourceType**](TokenizationOperationSourceType.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**address** | **String** | The wallet address to interact with the token contract
|
|
9
|
+
**address** | **String** | The wallet address used to interact with the token contract. |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
8
8
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
9
9
|
**token_id** | **String** | The ID of the token. |
|
|
10
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
8
8
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
9
9
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
10
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.TokenizationSOLTokenParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**standard** | [**TokenizationTokenStandard**](TokenizationTokenStandard.md) | |
|
|
8
|
+
**name** | **String** | The name of the token. |
|
|
9
|
+
**symbol** | **String** | The symbol of the token. |
|
|
10
|
+
**decimals** | **Number** | The number of decimals for the token (0-18). |
|
|
11
|
+
**token_access_activated** | **Boolean** | Whether the allowlist feature is activated for the token. When activated, only addresses in the allowlist can perform token operations. | [optional] [default to false]
|
|
12
|
+
**permissions** | [**TokenizationSolTokenPermissionParams**](TokenizationSolTokenPermissionParams.md) | | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.TokenizationSolContractCallParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | [**TokenizationContractCallType**](TokenizationContractCallType.md) | | [optional]
|
|
8
|
+
**instructions** | [**[SolContractCallInstruction]**](SolContractCallInstruction.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TokenizationSolTokenPermissionParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**permanent_delegate** | **String** | Solana wallet address assigned as the permanent delegate authority. It can perform delegated operations on behalf of token holders. | [optional]
|
|
8
|
+
**minter** | **String** | Solana wallet address assigned as the mint authority. It can mint new tokens. | [optional]
|
|
9
|
+
**freezer** | **String** | Solana wallet address assigned as the freeze authority. It can freeze token accounts. | [optional]
|
|
10
|
+
**updater** | **String** | Solana wallet address assigned as the update authority. It can update token metadata. | [optional]
|
|
11
|
+
**pauser** | **String** | Solana wallet address assigned as the pause authority. It can pause or unpause all token activities including transfers, burns, and mints. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**activation** | **Boolean** | Whether to activate the allowlist feature for the token. |
|
|
9
9
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
10
10
|
**token_id** | **String** | The ID of the token. |
|
|
11
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**token_name** | **String** | The name of the token. | [optional]
|
|
11
11
|
**token_symbol** | **String** | The unique token symbol. |
|
|
12
12
|
**decimals** | **Number** | The number of decimals of the token. |
|
|
13
|
-
**
|
|
13
|
+
**token_access_activated** | **Boolean** | Whether the allowlist feature is activated for the token. | [optional]
|
|
14
14
|
**status** | [**TokenizationStatus**](TokenizationStatus.md) | |
|
|
15
15
|
**total_supply** | **String** | The total supply of the token. | [optional]
|
|
16
16
|
**holdings** | **String** | The amount of tokens held by the organization. | [optional]
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**token_name** | **String** | The name of the token. | [optional]
|
|
11
11
|
**token_symbol** | **String** | The unique token symbol. |
|
|
12
12
|
**decimals** | **Number** | The number of decimals of the token. |
|
|
13
|
-
**
|
|
13
|
+
**token_access_activated** | **Boolean** | Whether the allowlist feature is activated for the token. | [optional]
|
|
14
14
|
**status** | [**TokenizationStatus**](TokenizationStatus.md) | |
|
|
15
15
|
**total_supply** | **String** | The total supply of the token. | [optional]
|
|
16
16
|
**holdings** | **String** | The amount of tokens held by the organization. | [optional]
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**source_type** | [**TokenizationOperationSourceType**](TokenizationOperationSourceType.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**address** | **String** | The wallet address to interact with the token contract
|
|
9
|
+
**address** | **String** | The wallet address used to interact with the token contract. |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -17,6 +17,12 @@
|
|
|
17
17
|
|
|
18
18
|
* `PauseContract` (value: `"PauseContract"`)
|
|
19
19
|
|
|
20
|
+
* `FreezeAccounts` (value: `"FreezeAccounts"`)
|
|
21
|
+
|
|
22
|
+
* `UpdateMetadata` (value: `"UpdateMetadata"`)
|
|
23
|
+
|
|
24
|
+
* `PermanentDelegate` (value: `"PermanentDelegate"`)
|
|
25
|
+
|
|
20
26
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
21
27
|
|
|
22
28
|
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
8
8
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
9
9
|
**token_id** | **String** | The ID of the token. |
|
|
10
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**source** | [**TokenizationTokenOperationSource**](TokenizationTokenOperationSource.md) | |
|
|
8
8
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
9
9
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
10
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**addresses** | [**[TokenizationUpdateAllowlistAddressesParamsAddressesInner]**](TokenizationUpdateAllowlistAddressesParamsAddressesInner.md) | A list of addresses to manage. For 'add' operations, notes can be provided. For 'remove' operations, notes are ignored. |
|
|
10
10
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
11
11
|
**token_id** | **String** | The ID of the token. |
|
|
12
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**address** | **String** | The address to add or remove. |
|
|
8
|
-
**note** | **String** | An optional note for the address, primarily used when adding. | [optional]
|
|
8
|
+
**note** | **String** | An optional note for the address, primarily used when adding addresses. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**addresses** | [**[TokenizationUpdateAllowlistAddressesParamsAddressesInner]**](TokenizationUpdateAllowlistAddressesParamsAddressesInner.md) | A list of addresses to manage. For 'add' operations, notes can be provided. For 'remove' operations, notes are ignored. |
|
|
10
10
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
11
11
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
12
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**addresses** | [**[TokenizationUpdateBlocklistAddressesParamsAddressesInner]**](TokenizationUpdateBlocklistAddressesParamsAddressesInner.md) | A list of addresses to manage. For 'add' operations, notes can be provided. For 'remove' operations, notes are ignored. |
|
|
10
10
|
**operation_type** | [**TokenizationOperationType**](TokenizationOperationType.md) | |
|
|
11
11
|
**token_id** | **String** | The ID of the token. |
|
|
12
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**address** | **String** | The address to add or remove. |
|
|
8
|
-
**note** | **String** | An optional note for the address, primarily used when adding. | [optional]
|
|
8
|
+
**note** | **String** | An optional note for the address, primarily used when adding addresses. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**addresses** | [**[TokenizationUpdateBlocklistAddressesParamsAddressesInner]**](TokenizationUpdateBlocklistAddressesParamsAddressesInner.md) | A list of addresses to manage. For 'add' operations, notes can be provided. For 'remove' operations, notes are ignored. |
|
|
10
10
|
**app_initiator** | **String** | The initiator of the tokenization activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
|
|
11
11
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
12
|
+
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**source_type** | [**TokenizationOperationSourceType**](TokenizationOperationSourceType.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**address** | **String** | The wallet address to interact with the token contract
|
|
9
|
+
**address** | **String** | The wallet address used to interact with the token contract. |
|
|
10
10
|
|
|
11
11
|
|
package/docs/TokensEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**tokens** | [**[TokenInfo]**](TokenInfo.md) | The enabled tokens. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -14,7 +14,9 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**estimateFee**](TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
|
|
15
15
|
[**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
|
|
16
16
|
[**getTransactionById**](TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
|
|
17
|
+
[**listApprovalDetails**](TransactionsApi.md#listApprovalDetails) | **GET** /transactions/approval/details | List transaction approval details
|
|
17
18
|
[**listTransactionApprovalDetails**](TransactionsApi.md#listTransactionApprovalDetails) | **GET** /transactions/approval_details | List transaction approval details
|
|
19
|
+
[**listTransactionTemplates**](TransactionsApi.md#listTransactionTemplates) | **GET** /transactions/templates | list transaction templates
|
|
18
20
|
[**listTransactions**](TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
|
|
19
21
|
[**resendTransactionById**](TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
|
|
20
22
|
[**signAndBroadcastTransactionById**](TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
|
|
@@ -540,6 +542,62 @@ Name | Type | Description | Notes
|
|
|
540
542
|
- **Accept**: application/json
|
|
541
543
|
|
|
542
544
|
|
|
545
|
+
## listApprovalDetails
|
|
546
|
+
|
|
547
|
+
> [ApprovalDetail] listApprovalDetails(opts)
|
|
548
|
+
|
|
549
|
+
List transaction approval details
|
|
550
|
+
|
|
551
|
+
This operation retrieves detailed approval information for a specified transaction.
|
|
552
|
+
|
|
553
|
+
### Example
|
|
554
|
+
|
|
555
|
+
```javascript
|
|
556
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
557
|
+
// Initialize the API client
|
|
558
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
559
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
560
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
561
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
562
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
563
|
+
// Call the API
|
|
564
|
+
const apiInstance = new CoboWaas2.TransactionsApi();
|
|
565
|
+
const opts = {
|
|
566
|
+
'transaction_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,557918d2-632a-4fe1-932f-315711f05fe3",
|
|
567
|
+
'cobo_ids': "20231213122855000000000000000000,20231213122955000000000000000000",
|
|
568
|
+
'request_ids': "web_send_by_user_327_1610444045047,web_send_by_user_327_1610444045048"
|
|
569
|
+
};
|
|
570
|
+
apiInstance.listApprovalDetails(opts).then((data) => {
|
|
571
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
572
|
+
}, (error) => {
|
|
573
|
+
console.error(error);
|
|
574
|
+
});
|
|
575
|
+
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### Parameters
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
Name | Type | Description | Notes
|
|
582
|
+
------------- | ------------- | ------------- | -------------
|
|
583
|
+
**transaction_ids** | **String**| A list of transaction IDs, separated by comma. | [optional]
|
|
584
|
+
**cobo_ids** | **String**| A list of Cobo IDs, separated by comma. A Cobo ID can be used to track a transaction. | [optional]
|
|
585
|
+
**request_ids** | **String**| A list of request IDs, separated by comma. | [optional]
|
|
586
|
+
|
|
587
|
+
### Return type
|
|
588
|
+
|
|
589
|
+
[**[ApprovalDetail]**](ApprovalDetail.md)
|
|
590
|
+
|
|
591
|
+
### Authorization
|
|
592
|
+
|
|
593
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
594
|
+
|
|
595
|
+
### HTTP request headers
|
|
596
|
+
|
|
597
|
+
- **Content-Type**: Not defined
|
|
598
|
+
- **Accept**: application/json
|
|
599
|
+
|
|
600
|
+
|
|
543
601
|
## listTransactionApprovalDetails
|
|
544
602
|
|
|
545
603
|
> ListTransactionApprovalDetails200Response listTransactionApprovalDetails(opts)
|
|
@@ -594,6 +652,60 @@ Name | Type | Description | Notes
|
|
|
594
652
|
- **Accept**: application/json
|
|
595
653
|
|
|
596
654
|
|
|
655
|
+
## listTransactionTemplates
|
|
656
|
+
|
|
657
|
+
> [ApprovalTemplate] listTransactionTemplates(template_key, opts)
|
|
658
|
+
|
|
659
|
+
list transaction templates
|
|
660
|
+
|
|
661
|
+
This operation retrieves transaction templates based on the specified transaction type and template version. The response includes a list of templates that can be used for creating transactions approval message.
|
|
662
|
+
|
|
663
|
+
### Example
|
|
664
|
+
|
|
665
|
+
```javascript
|
|
666
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
667
|
+
// Initialize the API client
|
|
668
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
669
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
670
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
671
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
672
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
673
|
+
// Call the API
|
|
674
|
+
const apiInstance = new CoboWaas2.TransactionsApi();
|
|
675
|
+
const template_key = "withdrawal";
|
|
676
|
+
const opts = {
|
|
677
|
+
'template_version': "1.0.0"
|
|
678
|
+
};
|
|
679
|
+
apiInstance.listTransactionTemplates(template_key, opts).then((data) => {
|
|
680
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
681
|
+
}, (error) => {
|
|
682
|
+
console.error(error);
|
|
683
|
+
});
|
|
684
|
+
|
|
685
|
+
```
|
|
686
|
+
|
|
687
|
+
### Parameters
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
Name | Type | Description | Notes
|
|
691
|
+
------------- | ------------- | ------------- | -------------
|
|
692
|
+
**template_key** | **String**| The key of the transaction template to be used for creating a transaction approval message. |
|
|
693
|
+
**template_version** | **String**| The version of the template used for the transaction approval. | [optional]
|
|
694
|
+
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
[**[ApprovalTemplate]**](ApprovalTemplate.md)
|
|
698
|
+
|
|
699
|
+
### Authorization
|
|
700
|
+
|
|
701
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
702
|
+
|
|
703
|
+
### HTTP request headers
|
|
704
|
+
|
|
705
|
+
- **Content-Type**: Not defined
|
|
706
|
+
- **Accept**: application/json
|
|
707
|
+
|
|
708
|
+
|
|
597
709
|
## listTransactions
|
|
598
710
|
|
|
599
711
|
> ListTransactions200Response listTransactions(opts)
|
|
@@ -690,7 +802,7 @@ Name | Type | Description | Notes
|
|
|
690
802
|
|
|
691
803
|
Resend transaction
|
|
692
804
|
|
|
693
|
-
This operation resends a specified transaction. Resending a transaction means retrying a previously failed transaction. For more details about resending a transaction, see [Resend a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#resend-a-transaction).
|
|
805
|
+
This operation resends a specified transaction. Resending a transaction means retrying a previously failed transaction. For more details about resending a transaction, see [Resend a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#resend-a-transaction). Resending a transaction is a high‑risk operation. Ensure that the original transaction has not been broadcast to the blockchain, has already expired, and will never be confirmed. Otherwise, the same transaction may be confirmed on‑chain twice. <Note>This operation only applies to transactions from MPC Wallets in the SOL token.</Note>
|
|
694
806
|
|
|
695
807
|
### Example
|
|
696
808
|
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
8
|
-
**name** | **String** | The wallet name. |
|
|
8
|
+
**name** | **String** | The wallet name. | [optional]
|
|
9
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
8
|
-
**name** | **String** | The wallet name. |
|
|
8
|
+
**name** | **String** | The wallet name. | [optional]
|
|
9
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
8
|
**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
9
|
-
**custom_payer_id** | **String** |
|
|
9
|
+
**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**wallet_type** | [**WalletType**](WalletType.md) | |
|
|
8
8
|
**name** | **String** | The wallet name. |
|
|
9
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional]
|
|
9
10
|
|
|
10
11
|
|
package/docs/WalletInfo.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
10
10
|
**name** | **String** | The wallet name. |
|
|
11
11
|
**org_id** | **String** | The ID of the owning organization. |
|
|
12
|
+
**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional]
|
|
12
13
|
**project_id** | **String** | The project ID. | [optional]
|
|
13
14
|
**project_name** | **String** | The project name. | [optional]
|
|
14
15
|
**vault_id** | **String** | The ID of the owning vault. |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
package/docs/WalletsApi.md
CHANGED
|
@@ -508,7 +508,7 @@ Name | Type | Description | Notes
|
|
|
508
508
|
|
|
509
509
|
Get maximum transferable value
|
|
510
510
|
|
|
511
|
-
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. <Note>This operation is applicable to Custodial Wallets and MPC Wallets only.</Note>
|
|
511
|
+
<Warning>This operation is planned for deprecation. We recommend using [Estimate maximum transferable value](https://www.cobo.com/developers/v2/api-references/wallets/estimate-maximum-transferable-value) instead.</Warning> 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. <Note>This operation is applicable to Custodial Wallets and MPC Wallets only.</Note>
|
|
512
512
|
|
|
513
513
|
### Example
|
|
514
514
|
|