Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add initial deposit logic #4

Merged
merged 1 commit into from
Apr 27, 2023
Merged

add initial deposit logic #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions spec/app/ics-101-interchain-swap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,15 @@ $$Amount_{fee} = Amount_{inputToken} * swapFee$$

As the pool collects fees, liquidity providers automatically collect fees through their proportional ownership of the pool balance.

### Pool Initialization

In InterchainSwap, the liquidity pool has two possible states:

- `INITIAL`: The pool is newly created and not yet ready for swaps. This means that all pool parameters have been registered in the state machine, but it doesn't possess the necessary assets for the swap pair.

- `READY`: The pool has acquired all required assets to facilitate swaps.
The pool's status can be updated through an initial deposit. If a user provides the full amount of assets that match the pool's initial parameters using either a `single deposit` or double deposit, the pool's status will automatically change to `READY`. With the initial deposit, the user receives sufficient pool tokens to withdraw their assets at any time.

### Data Structures

#### Pool Structure
Expand Down Expand Up @@ -534,6 +543,11 @@ function singleDeposit(msg MsgSingleDepositRequest) {
// should have enough balance
abortTransactionUnless(balance.amount >= token.amount)

if(pool.status == POOL_STATUS_INITIAL) {
const asset = pool.findAssetByDenom(msg.token.denom)
abortTransactionUnless(balance.amount !== asset.amount)
}

// deposit assets to the escrowed account
const escrowAddr = escrowAddress(pool.encounterPartyPort, pool.encounterPartyChannel)
bank.sendCoins(msg.sender, escrowAddr, msg.tokens)
Expand Down Expand Up @@ -716,10 +730,10 @@ function onSingleDepositReceived(msg: MsgSingleDepositRequest, state: StateChang
const pool = store.findPoolById(msg.poolId)
abortTransactionUnless(pool != null)

// add deposit asset
const assetIn = pool.findAssetByDenom(state.in.denom)
assetIn.balance.amount += state.in.amount

if (pool.Status == PoolStatus_POOL_STATUS_INIT) {
// switch pool status to 'READY'
pool.Status = PoolStatus_POOL_STATUS_READY
}
// add pool token to keep consistency, no need to mint pool token since the deposit is executed on the source chain.
pool.supply.amount += state.poolToken.amount
store.savePool(pool)
Expand Down Expand Up @@ -759,6 +773,11 @@ function onDoubleDepositReceived(msg: MsgSingleDepositRequest, state: StateChang
const isValid = pubKey.VerifySignature(rawRemoteDepositTx, msg.remoteDeposit.signature)
abortTransactionUnless(isValid != false)

if (pool.Status == PoolStatus_POOL_STATUS_INIT) {
// switch pool status to 'READY'
pool.Status = PoolStatus_POOL_STATUS_READY
}

// deposit remote token
const poolTokens = amm.doubleSingleAsset([msg.localDeposit.token, msg.remoteDeposit.token])

Expand Down