Alice submits a withdrawal request for 75 USDC after both Bob and Charlie submitted requests
Greg deposits 125 USDC, which fills Bob’s request and partially fills Charlie’s request
Bob claims his 100 USDC and is removed from the withdrawal list
/\*\*
\* @dev Get the withdraw request detail in queue by node index
\*
\* @return RedeemRequest{ address redeemer; uint256 amount; }
\*/
function queueDetail(uint nodeIndex) external view returns(RedeemRequest);
| | QUEUE PROCESS LIMIT | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Batch size of queue list being process at each transaction
\*
\* @return batch size
\*/
function queueProcessLimit() external view returns(uint256);
| | CLAIMABLE WITHDRAW AMOUNT | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev The amount of processed withdraw an user can claim
\*
\* @return amount to claim
\*/
function claimableAssets(address owner) external view returns(uint256);
| | TOTAL UNCLAIMED WITHDRAW AMOUNT | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev The total amount of processed withdraw users can claim
\*
\* @return total amount can claim
\*/
function totalClaimableAssets() external view returns(uint256);
| | TOTAL PENDING WITHDRAW AMOUNT | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev The total withdraw request amount in queue
\*
\*/
function pendingWithdrawAssets() external view returns(uint256);
| | CANCEL WITHDRAW REQUEST | | ---------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Cancel withdraw request of sender
\*
\*/
function cancelWithdraw(uint nodeIndex) external;
| | CANCEL WITHDRAW REQUESTS | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Cancel multi withdraw requests of sender
\*
\*/
function cancelWithdraws(uint256\[] memory nodes) external;
| | GET WITHDRAW QUEUE SIZE | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Get the current size of queue list (total number of withdraw requests)
\*
\* @return the current size of queue list
\*/
function getWithdrawQueueSize() external view returns(uint256);
| | GET WITHDRAW QUEUE DETAIL LIST | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Get the detail of a withdraw queue batch
\*
\* @param offset\_ the index of the previous node, put 0 to start from first node
\* @param size\_ the size of the queue batch to return
*
* @returns (array of node index, array of corresponding withdraw request detail)
\*/
function getWithdrawQueueDetailList(uint256 offset\_, uint256 size\_) external view returns(uint256\[] memory, WithdrawRequest\[] memory);
| | SET QUEUE PROCESS LIMIT | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @notice Sets a new queue process limit
\* @dev Admin function to set a new queue process limit
\*/
function setQueueProcessLimit(uint256 limit\_) virtual external;
| | PROCESS THE FIRST BATCH OF QUEUE | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @notice process the withdrawal queue when there is available underlying token.
\* Should be run by contract itself, anyone trigger this function.
\*/
function queueProcess() virtual public;
| | BORROW FUND | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Method to let borrower borrow token from the pool
*
* @param receiver\_ Address to receive token
\* @param amount\_ Amount to transfer from the pool. Token in base decimal (1e18).
\*/
function borrowFund(address receiver\_, uint256 amount\_) external;
| | REPAY DEBT | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |/\*\*
\* @dev Borrower execute this function to repay token back to the pool
*
* @param amount\_ Amount of token to repay. Token in token decimal.
\*/
function repayDebt(uint256 amount\_) external;
| | SET NEW INTEREST RATE | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |/\*\*
\* @dev Set new rate
*
* @param newRate\_ New rate value. Rate value in range (0 - 100000)
\*/
function setRate(uint256 newRate\_) external;
| | EVENTS | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
event Withdraw(
address indexed sender,
address indexed receiver,
address indexed owner,
uint256 assets,
uint256 shares
);
event BorrowFund(address, uint256);
event Repay(address, uint256);
event MaxPoolValue(uint256, uint256);
event SetQueueProcessLimit(uint256);
event AddQueue(address, uint256);
event ClaimWithdraw(address, uint256);
event CancelQueue(address, uint256);
event ProcessedQueue(uint256 indexed node, address indexed receiver, uint256 assets);
| ## Stellar Soroban Interfaces **Build contracts:** ``` soroban contract build ``` **Test contracts:** ``` cargo test --package credit-vault ``` #### Contract Interface The contract implemented [ERC4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) and follows Stellar contract convention, `example` totalAssets changed to total\_assets, and with additional interfaces: **ERC4626 interface** ``` fn deposit(e: Env, from: Address, assets: i128, receiver: Address) -> i128 fn mint(e: Env, from: Address, shares: i128, receiver: Address) -> i128 fn max_withdraw(e: Env, owner: Address) -> i128 fn withdraw(e: Env, from: Address, assets: i128, receiver: Address, owner: Address) -> i128 fn redeem(e: Env, from: Address, shares: i128, receiver: Address, owner: Address) -> i128 fn max_redeem(e: Env, owner: Address) -> i128 fn available_assets(e: Env) -> i128 fn convert_to_shares(e: Env, assets: i128) -> i128 fn convert_to_assets(e: Env, shares: i128) -> i128 fn asset(e: Env) -> Address fn total_assets(e: Env) -> i128 fn convert_to_shares(e: Env, assets: i128) -> i128 fn convert_to_assets(e: Env, shares: i128) -> i128 fn preview_deposit(e: &Env, assets: i128) -> i128 fn preview_mint(e: &Env, shares: i128) -> i128 fn preview_withdraw(e: &Env, assets: i128) -> i128 fn preview_redeem(e: &Env, shares: i128) -> i128 ``` **total\_claimable\_assets** ``` fn total_claimable_assets(e: Env) -> i128 ``` The total amount of processed withdraw users can claim **queue\_process** ``` fn queue_process(e: Env) ``` Process the withdrawal queue when there is available underlying token **get\_withdraw\_queue\_detail\_list** ``` fn get_withdraw_queue_detail_list(e: Env, offset: u128, size: u128) -> (Vec