mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-09 16:28:06 +00:00
112 lines
4.3 KiB
Markdown
112 lines
4.3 KiB
Markdown
# Mint NLP
|
|
|
|
## Rate limits
|
|
|
|
* Wallet weight = <mark style="color:red;">`10`</mark> - allows 60 mints/min or 10 mints every 10 seconds per wallet.
|
|
|
|
{% hint style="info" %}
|
|
See more details in [API Rate limits](https://docs.nado.xyz/developer-resources/api/rate-limits).
|
|
{% endhint %}
|
|
|
|
## Request
|
|
|
|
{% tabs %}
|
|
{% tab title="Websocket" %}
|
|
**Connect**
|
|
|
|
<mark style="color:orange;">`WEBSOCKET [GATEWAY_WEBSOCKET_ENDPOINT]`</mark>
|
|
|
|
**Message**
|
|
|
|
```json
|
|
{
|
|
"mint_nlp": {
|
|
"tx": {
|
|
"sender": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c43746573743000000000000000",
|
|
"quoteAmount": "1000000000000000000",
|
|
"nonce": "1"
|
|
},
|
|
"signature": "0x"
|
|
}
|
|
}
|
|
```
|
|
|
|
{% endtab %}
|
|
|
|
{% tab title="REST" %} <mark style="color:orange;">`POST [GATEWAY_REST_ENDPOINT]/execute`</mark>
|
|
|
|
**Body**
|
|
|
|
```json
|
|
{
|
|
"mint_lp": {
|
|
"tx": {
|
|
"sender": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c43746573743000000000000000",
|
|
"productId": 1,
|
|
"amountBase": "1000000000000000000",
|
|
"quoteAmountLow": "10000000000000000000000",
|
|
"quoteAmountHigh": "20000000000000000000000",
|
|
"nonce": "1"
|
|
},
|
|
"signature": "0x"
|
|
}
|
|
}
|
|
```
|
|
|
|
{% endtab %}
|
|
{% endtabs %}
|
|
|
|
## Request Parameters
|
|
|
|
<table><thead><tr><th width="205" align="center">Parameter</th><th width="94" align="center">Type</th><th width="112" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td align="center">tx</td><td align="center">object</td><td align="center">Yes</td><td>Mint NLP transaction object. See <a href="#signing">Signing</a> section for details on the transaction fields.</td></tr><tr><td align="center">tx.sender</td><td align="center">string</td><td align="center">Yes</td><td>Hex string representing the subaccount's 32 bytes (address + subaccount name) of the tx sender.</td></tr><tr><td align="center">tx.quoteAmount</td><td align="center">string</td><td align="center">Yes</td><td>This amount of quote to be consumed by minting NLPs multiplied by 1e18, sent as a string.</td></tr><tr><td align="center">tx.nonce</td><td align="center">string</td><td align="center">Yes</td><td>This is an incrementing nonce, can be obtained using the <a href="../queries/nonces">Nonces</a> query.</td></tr><tr><td align="center">signature</td><td align="center">string</td><td align="center">Yes</td><td>Hex string representing hash of the <strong>signed</strong> transaction. See <a href="#signing">Signing</a> section for more details.</td></tr><tr><td align="center">spot_leverage</td><td align="center">boolean</td><td align="center">No</td><td>Indicates whether leverage should be used; when set to <mark style="color:red;"><code>false</code></mark> , the mint fails if the transaction causes a borrow on the subaccount. Defaults to <mark style="color:red;"><code>true</code></mark>.</td></tr></tbody></table>
|
|
|
|
## Signing
|
|
|
|
{% hint style="info" %}
|
|
See more details and examples in our [signing](https://docs.nado.xyz/developer-resources/api/gateway/signing) page.
|
|
{% endhint %}
|
|
|
|
The solidity typed data struct that needs to be signed is:
|
|
|
|
```solidity
|
|
struct MintNlp {
|
|
bytes32 sender;
|
|
uint128 quoteAmount;
|
|
uint64 nonce;
|
|
}
|
|
```
|
|
|
|
<mark style="color:red;">`sender`</mark>: a <mark style="color:red;">`bytes32`</mark> sent as a hex string; includes the address and the subaccount identifier.
|
|
|
|
<mark style="color:red;">`quoteAmount`</mark>: this is the amount of quote to be consumed by minting NLPs, sent as a string. This must be positive and must be specified with 18 decimals.
|
|
|
|
<mark style="color:red;">`nonce`</mark>: the <mark style="color:red;">`tx_nonce`</mark>. This is an incrementing nonce, can be obtained using the [Nonces](https://docs.nado.xyz/developer-resources/api/gateway/queries/nonces) query.
|
|
|
|
{% hint style="warning" %}
|
|
**Note**: for signing you should always use the data type specified in the solidity struct which might be different from the type sent in the request e.g: <mark style="color:red;">`nonce`</mark> should be an <mark style="color:red;">`uint64`</mark> for **Signing** but should be sent as a <mark style="color:red;">`string`</mark> in the final payload.
|
|
{% endhint %}
|
|
|
|
## Response
|
|
|
|
#### Success
|
|
|
|
```json
|
|
{
|
|
"status": "success",
|
|
"signature": {signature},
|
|
"request_type": "execute_mint_nlp"
|
|
}
|
|
```
|
|
|
|
#### Failure
|
|
|
|
```json
|
|
{
|
|
"status": "failure",
|
|
"signature": {signature},
|
|
"error": "{error_msg}",
|
|
"error_code": {error_code},
|
|
"request_type": "execute_min_nlp"
|
|
}
|
|
```
|