Resolv

https://docs.resolv.xyz
Admin
Resolv is a decentralized protocol that maintains USR, a stablecoin natively backed by Ether (ETH)...
Tokens:13,008
Snippets:113
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Minting USR Tokens

Source: https://docs.resolv.xyz/litepaper/for-developers/token-supply-operations/usr

Initiate the process of minting USR tokens by providing the deposit token address, amount, and minimum desired USR amount. The process involves backend processing and emits a completion event.

```APIDOC
## POST /usr/mint/request

### Description
Requests the minting of USR tokens by exchanging supported deposit tokens (USDC, USDT).

### Method
POST

### Endpoint
/usr/mint/request

### Parameters
#### Query Parameters
- **_depositTokenAddress** (address) - Required - The address of the token you want to exchange for USR.
- **_amount** (uint256) - Required - The amount of the depositing token.
- **_minMintAmount** (uint256) - Required - The minimum amount of USR tokens you want to receive.

### Request Example
```json
{
  "_depositTokenAddress": "0x USDC Address",
  "_amount": "1000000",
  "_minMintAmount": "990000"
}
```

### Response
#### Success Response (200)
- **id** (uint256) - The ID of the mint request.

#### Response Example
```json
{
  "id": "123"
}
```
```

```APIDOC
## POST /usr/mint/cancel

### Description
Cancels a pending USR token mint request.

### Method
POST

### Endpoint
/usr/mint/cancel

### Parameters
#### Query Parameters
- **id** (uint256) - Required - The ID of the mint request to cancel.

### Request Example
```json
{
  "id": "123"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of cancellation.

#### Response Example
```json
{
  "message": "Mint request 123 cancelled successfully."
}
```
```

--------------------------------

### Burning USR Tokens

Source: https://docs.resolv.xyz/litepaper/for-developers/token-supply-operations/usr

Initiate the process of burning USR tokens to receive supported withdrawal tokens (USDC, USDT). This process can take up to 24 hours and involves backend processing.

```APIDOC
## POST /usr/burn/request

### Description
Requests the burning of USR tokens to receive supported withdrawal tokens (USDC, USDT).

### Method
POST

### Endpoint
/usr/burn/request

### Parameters
#### Query Parameters
- **_issueTokenAmount** (uint256) - Required - The amount of USR tokens to burn.
- **_withdrawalTokenAddress** (address) - Required - The address of the token you want to receive after burning.
- **_minWithdrawalAmount** (uint256) - Required - The minimum amount of tokens you want to receive.

### Request Example
```json
{
  "_issueTokenAmount": "1000000",
  "_withdrawalTokenAddress": "0x USDC Address",
  "_minWithdrawalAmount": "990000"
}
```

### Response
#### Success Response (200)
- **id** (uint256) - The ID of the burn request.

#### Response Example
```json
{
  "id": "456"
}
```
```

```APIDOC
## POST /usr/burn/cancel

### Description
Cancels a pending USR token burn request.

### Method
POST

### Endpoint
/usr/burn/cancel

### Parameters
#### Query Parameters
- **id** (uint256) - Required - The ID of the burn request to cancel.

### Request Example
```json
{
  "id": "456"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of cancellation.

#### Response Example
```json
{
  "message": "Burn request 456 cancelled successfully."
}
```
```

--------------------------------

### RLP Token Minting API

Source: https://docs.resolv.xyz/litepaper/for-developers/token-supply-operations/rlp

Handles the process of minting RLP tokens by exchanging specified deposit tokens. It includes requesting mint, backend completion, and the ability to cancel pending requests.

```APIDOC
## POST /websites/resolv_xyz/mint

### Description
Initiates the process of minting RLP tokens by exchanging a specified amount of a supported deposit token (USDC or USDT). The request includes the minimum amount of RLP tokens the user is willing to receive. The minting process, handled by the backend, takes approximately 1 minute.

### Method
POST

### Endpoint
/websites/resolv_xyz/mint

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **_depositTokenAddress** (address) - Required - The address of the token you want to exchange for RLP (USDC or USDT).
- **_amount** (uint256) - Required - The amount of the depositing token.
- **_minMintAmount** (uint256) - Required - The minimum amount of RLP tokens you want to receive. If this amount is higher than the executable amount, the request will not be handled and will remain in the CREATED status.

### Request Example
```json
{
  "_depositTokenAddress": "0x...",
  "_amount": "1000000",
  "_minMintAmount": "950000"
}
```

### Response
#### Success Response (200)
- **id** (uint256) - The unique identifier for the mint request.
- **status** (string) - The current status of the mint request (e.g., CREATED, PROCESSING, COMPLETED).

#### Response Example
```json
{
  "id": "12345",
  "status": "CREATED"
}
```

## POST /websites/resolv_xyz/mint/cancel

### Description
Cancels a previously submitted RLP token mint request. This operation is only possible if the request has not yet reached the COMPLETED state.

### Method
POST

### Endpoint
/websites/resolv_xyz/mint/cancel

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (uint256) - Required - The unique identifier of the mint request to be canceled.

### Request Example
```json
{
  "id": "12345"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the cancellation request has been processed.

#### Response Example
```json
{
  "message": "Mint request 12345 canceled successfully."
}
```
```

--------------------------------

### RLP Token Burning API

Source: https://docs.resolv.xyz/litepaper/for-developers/token-supply-operations/rlp

Handles the process of burning RLP tokens to receive specified withdrawal tokens. It includes requesting the burn, backend completion which may take up to 24 hours, and the ability to cancel pending requests.

```APIDOC
## POST /websites/resolv_xyz/burn

### Description
Initiates the process of burning RLP tokens to receive a specified amount of a supported withdrawal token (USDC or USDT). The request includes the minimum amount of withdrawal tokens the user is willing to receive. The burning process, handled by the backend, can take up to 24 hours.

### Method
POST

### Endpoint
/websites/resolv_xyz/burn

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **_issueTokenAmount** (uint256) - Required - The amount of RLP tokens to burn.
- **_withdrawalTokenAddress** (address) - Required - The address of the token you want to receive after burning (USDC or USDT).
- **_minWithdrawalAmount** (uint256) - Required - The minimum amount of tokens you want to receive. If this amount is higher than the executable amount, the request will not be handled and will remain in the CREATED status.

### Request Example
```json
{
  "_issueTokenAmount": "1000000",
  "_withdrawalTokenAddress": "0x...",
  "_minWithdrawalAmount": "950000"
}
```

### Response
#### Success Response (200)
- **id** (uint256) - The unique identifier for the burn request.
- **status** (string) - The current status of the burn request (e.g., CREATED, PROCESSING, COMPLETED).

#### Response Example
```json
{
  "id": "67890",
  "status": "CREATED"
}
```

## POST /websites/resolv_xyz/burn/cancel

### Description
Cancels a previously submitted RLP token burn request. This operation is only possible if the request has not yet reached the COMPLETED state.

### Method
POST

### Endpoint
/websites/resolv_xyz/burn/cancel

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (uint256) - Required - The unique identifier of the burn request to be canceled.

### Request Example
```json
{
  "id": "67890"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the cancellation request has been processed.

#### Response Example
```json
{
  "message": "Burn request 67890 canceled successfully."
}
```
```
Tokens:
Raw