USD.AI

https://docs.usd.ai
Admin
USD.AI is a decentralized lending protocol that provides AI infrastructure operators with...
Tokens:16,942
Snippets:311
Trust Score:8.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /priceOracle

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Interface for checking supported tokens and retrieving token prices in terms of USDai.

```APIDOC
## GET /supportedToken

### Description
Check if token is supported.

### Method
GET

### Query Parameters
- **token** (address) - Required - Token address

### Response
- **isSupported** (bool) - True if token is supported, false otherwise

## GET /price

### Description
Get price of token in terms of USDai.

### Method
GET

### Query Parameters
- **token** (address) - Required - Token address

### Response
- **price** (uint256) - Price of token in terms of USDai
```

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

### Price Oracle Interface

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Interfaces for checking token support and retrieving token prices in terms of USDai.

```solidity
/**
 * @notice Check if token is supported
 * @param token Token
 * @return True if token is supported, false otherwise
 */
function supportedToken(
    address token
) external view returns (bool);

/**
 * @notice Get price of token in terms of USDai
 * @param token Token
 */
function price(
    address token
) external view returns (uint256);
```

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

### POST /depositLoanRepayment

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Deposits loan repayments into the sUSDai contract.

```APIDOC
## POST /depositLoanRepayment

### Description
Deposits loan repayments into the sUSDai contract.

### Method
POST

### Request Body
- **currencyToken** (address) - Required - Currency token
- **depositAmount** (uint256) - Required - Deposit amount
- **usdaiAmountMinimum** (uint256) - Required - Minimum USDai amount
- **data** (bytes) - Required - Swap data
```

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

### USDai Burning

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Allows KYC'ed institutions to burn USDai and withdraw PYUSD.

```APIDOC
## POST /withdraw

### Description
Allows KYC'ed institutions to burn USDai and withdraw PYUSD.

### Method
POST

### Parameters
#### Request Body
- **usdaiAmount** (uint256) - Required - The amount of USDai to burn.
- **recipient** (address) - Required - The address to receive the PYUSD.

### Response
#### Success Response (200)
- **amount** (uint256) - The amount of PYUSD withdrawn.
```

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

### POST /harvestBaseYield

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Harvests base yield for the PYUSD held in the USDai contract.

```APIDOC
## POST /harvestBaseYield

### Description
Harvests base yield for the PYUSD held in the USDai contract.

### Method
POST

### Response
#### Success Response (200)
- **harvestedAmount** (uint256) - Harvested USDai amount
- **adminFee** (uint256) - Admin fee
```

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

### POST /serviceRedemptions

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Processes pending redemption requests from the FIFO queue. This function is restricted to the STRATEGY_ADMIN_ROLE.

```APIDOC
## POST /serviceRedemptions

### Description
Processes pending redemption requests in the FIFO queue. This function is called by the strategy when sufficient USDai is available.

### Method
POST

### Endpoint
/serviceRedemptions

### Parameters
#### Request Body
- **shares** (uint256) - Required - The number of shares to process.

### Response
#### Success Response (200)
- **amount** (uint256) - The amount of tokens processed.
```

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

### Deposit Loan Repayment

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Redeposits loan repayments as USDai into the sUSDai contract.

```solidity
/**
 * @notice Deposit loan repayment
 * @param currencyToken Currency token
 * @param depositAmount Deposit amount
 * @param usdaiAmountMinimum Minimum USDai amount
 * @param data Swap data
 */
function depositLoanRepayment(
    address currencyToken,
    uint256 depositAmount,
    uint256 usdaiAmountMinimum,
    bytes calldata data
) external;
```

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

### POST /depositLoanTimelock

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Deposits funds into the Deposit Timelock for specific, predetermined loan terms.

```APIDOC
## POST /depositLoanTimelock

### Description
Deposits funds into the Deposit Timelock for specific, predetermined loan terms.

### Method
POST

### Request Body
- **loanTermsHash** (bytes32) - Required - Loan terms hash
- **usdaiAmount** (uint256) - Required - USDai amount
- **expiration** (uint64) - Required - Expiration timestamp
```

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

### Request sUSDai Redemption

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Users can initiate an asynchronous redemption of sUSDai for USDai. Redemptions are processed at the end of a fixed time window.

```solidity
function requestRedeem(uint256 shares, address controller, address owner) external returns (uint256 requestId);
```

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

### POST /cancelLoanTimelock

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Cancels a loan timelock and withdraws funds from the Deposit Timelock.

```APIDOC
## POST /cancelLoanTimelock

### Description
Cancels a loan timelock and withdraws funds from the Deposit Timelock.

### Method
POST

### Request Body
- **loanTermsHash** (bytes32) - Required - Loan terms hash
```

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

### Omnichain Token Interface

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Interface for burn/mint-style omnichain token transfers, requiring the BRIDGE_ADMIN_ROLE.

```APIDOC
## Omnichain Token Interface

### Description
Supports burn/mint-style omnichain token transfers. This interface is restricted to the BRIDGE_ADMIN_ROLE, typically granted to the token messaging contract.

### Implementation Details
- **LayerZero Support**: Provided via OAdapter (messaging endpoint) and OToken (bridged ERC20 representation).
```

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

### Deposit Loan Timelock

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Deposits funds into the Deposit Timelock for specific loan terms.

```solidity
/**
 * @notice Deposit loan timelock
 * @param loanTermsHash Loan terms hash
 * @param usdaiAmount USDai amount
 * @param expiration Expiration timestamp
 */
function depositLoanTimelock(bytes32 loanTermsHash, uint256 usdaiAmount, uint64 expiration) external;
```

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

### USDai Minting

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Allows KYC'ed institutions to mint USDai by depositing PYUSD.

```APIDOC
## POST /deposit

### Description
Allows KYC'ed institutions to deposit PYUSD to mint USDai.

### Method
POST

### Parameters
#### Request Body
- **depositAmount** (uint256) - Required - The amount of PYUSD to deposit.
- **usdaiAmountMinimum** (uint256) - Required - The minimum amount of USDai to receive.

### Response
#### Success Response (200)
- **amount** (uint256) - The amount of USDai minted.
```

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

### Service USDai Redemptions

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Call this function to process pending redemption requests when sufficient USDai is available. It takes the amount of shares to process and returns the amount processed.

```Solidity
/**
 * @notice Service pending redemption requests
 * @param shares Shares to process
 * @return Amount processed
 */
function serviceRedemptions(
    uint256 shares
) external returns (uint256);
```

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

### Harvest Base Yield

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Harvests base yield for PYUSD held in the USDai contract. Requires the STRATEGY_ADMIN_ROLE.

```solidity
/**
 * @notice Harvest base yield
 * @return Harvested USDai amount
 * @return Admin fee
 */
function harvestBaseYield() external returns (uint256, uint256);
```

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

### sUSDai Staking

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Synchronous ERC4626 deposit operations to stake USDai for sUSDai.

```APIDOC
## POST /deposit

### Description
Stake USDai to receive sUSDai shares.

### Method
POST

### Parameters
#### Request Body
- **assets** (uint256) - Required - Amount of USDai to stake.
- **receiver** (address) - Required - Address to receive sUSDai.

### Response
#### Success Response (200)
- **shares** (uint256) - Amount of sUSDai shares minted.
```

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

### Mint USDai

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Institutions can mint USDai by depositing PYUSD. This function requires KYC'd institutions.

```solidity
/**
 * @notice Deposit
 * @param depositAmount Deposit amount
 * @param recipient Recipient
 * @return USDai amount
 */
function deposit(
    uint256 depositAmount,
    uint256 usdaiAmountMinimum
) external returns (uint256);
```

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

### Redeem sUSDai

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Users can redeem sUSDai for USDai at the current redemption share price. This is an asynchronous ERC7540 redeem operation.

```solidity
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
```

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

### Burn USDai

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

KYC'ed institutions can burn USDai to withdraw PYUSD. This function facilitates the reverse of the minting process.

```solidity
/**
 * @notice Withdraw
 * @param usdaiAmount USD amount
 * @param recipient Recipient
 * @return Withdraw amount
 */
function withdraw(
    uint256 usdaiAmount,
    address recipient
) external returns (uint256);
```

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

### Stake USDai for sUSDai

Source: https://docs.usd.ai/technical-overview/technical-protocol-overview

Users can stake USDai to receive sUSDai. This is a synchronous ERC4626 deposit operation. Overloads with slippage protection are available for EOAs.

```solidity
function deposit(uint256 assets, address receiver) external returns (uint256 shares);
function mint(uint256 shares, address receiver) external returns (uint256 assets);
```
Tokens:
Raw