mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-11 09:18:08 +00:00
更新文档,添加和修改多个API接口的描述,确保文档内容的准确性和完整性,提升开发者使用体验。
This commit is contained in:
@@ -0,0 +1,18 @@
|
||||
!!! info "[ApiVaultBurnTokensRequest](/../../schemas/api_vault_burn_tokens_request)"
|
||||
Request payload for burning tokens in a vault.<br><br>This API allows a client to burn a specified amount of tokens in a particular vault.<br>
|
||||
|
||||
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|
||||
|-|-|-|-|
|
||||
|vault_id<br>`vi` |string|True|The unique identifier of the vault to burn tokens from.|
|
||||
|currency<br>`c` |string|True|The currency used for the burn. This should be the vault's quote currency.|
|
||||
|num_tokens<br>`nt` |string|True|The number of tokens to burn.|
|
||||
|signature<br>`s` |Signature|True|The digital signature from the investing account.<br>This signature must be generated by the main account ID and is used to verify the authenticity of the request.<br>The signature must comply with AccountPermExternalTransfer permission.|
|
||||
??? info "[Signature](/../../schemas/signature)"
|
||||
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|
||||
|-|-|-|-|
|
||||
|signer<br>`s` |string|True|The address (public key) of the wallet signing the payload|
|
||||
|r<br>`r` |string|True|Signature R|
|
||||
|s<br>`s1` |string|True|Signature S|
|
||||
|v<br>`v` |integer|True|Signature V|
|
||||
|expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
|
||||
|nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|
|
||||
Reference in New Issue
Block a user