forked from skip-mev/skip-go-cosmwasm-contracts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 🔥 Remove Skip Swap from Skip API Contracts section * 📝 Add entry point readme * 📝 add neutron astroport swap adapter read me * 📝 update main read me * 📝 Add response to queries and 4 tab json cause pretty * 📝 Add osmosis poolmanager swap adapter readme * 📝 small documentation improvements * 📝 add punctuation * 🐛 fix json examples * 📝 Add neutron ibc transfer adapter readme * 📝 Add osmosis ibc transfer adapter readme * ✨ Add example flow to main read me
- Loading branch information
1 parent
08e2ff8
commit 469a8b0
Showing
8 changed files
with
631 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| # Entry Point Contract | ||
|
|
||
| The entry point contract is responsible for providing a standardized interface (w/ safety checks) to interact with Skip Swap across all CosmWasm-enabled chains. The contract: | ||
| 1. Performs basic validation on the call data | ||
| 2. If a fee swap is provided, queries the swap adapter contract to determine how much of the coin sent with the contract call is needed to receive the required fee coin(s), and dispatches the swap. | ||
| 3. Dispatches the user swap provided in the call data to the relevant swap adapter contract. | ||
| 4. Verifies the amount out received from the swap(s) is greater than the minimum amount required by the caller after all fees have been subtracted (swap, ibc, affiliate) | ||
| 5. Dispatches one of the following post-swap actions with the received funds from the swap: | ||
| - Transfer to an address on the same chain | ||
| - IBC transfer to an address on a different chain (which allows for multi-hop IBC transfers or contract calls if the destination chains support it) | ||
| - Call a contract on the same chain | ||
|
|
||
| WARNING: Do not send funds directly to the entry point contract without calling one of its functions. Funds sent directly to the contract do not trigger any contract logic that performs validation / safety checks (as the Cosmos SDK handles direct fund transfers in the `Bank` module and not the `Wasm` module). There are no explicit recovery mechanisms for accidentally sent funds. | ||
|
|
||
| ## InstantiateMsg | ||
|
|
||
| Instantiates a new entry point contract using the adapter contracts provided in the instantiation message. | ||
|
|
||
| ``` json | ||
| { | ||
| "swap_venues": [ | ||
| { | ||
| "name": "neutron-astroport", | ||
| "adapter_contract_address": "neutron..." | ||
| } | ||
| ], | ||
| "ibc_transfer_contract_address": "neutron..." | ||
| } | ||
| ``` | ||
|
|
||
| ## ExecuteMsg | ||
|
|
||
| ### `swap_and_action` | ||
|
|
||
| Swaps the coin sent and performs a post-swap action. | ||
|
|
||
| Optional fields: | ||
| - `fee_swap` is used if a fee is required by the IBC transfer. | ||
|
|
||
| Notes: | ||
| - Only one coin can be sent to the contract when calling `swap_and_action` otherwise the transaction will fail. | ||
| - `timeout_timestamp` is Unix epoch time in nanoseconds. The transaction will fail if the `timeout_timestamp` has passed when the contract is called. | ||
| - The `coin_in` field in `user_swap` is optional. If provided, the contract will attempt to swap the provided `coin_in`. If not provided, the contract will attempt to swap the coin that was sent to the contract by the caller minus the amount of that coin used by the `fee_swap`. | ||
| - `post_swap_action` can be one of three actions: `bank_send`, `ibc_transfer`, or `contract_call`. | ||
| - `bank_send`: Sends the assets received from the `user_swap` to an address on the same chain the swap occured on. | ||
| - `ibc_transfer`: ICS-20 transfers the assets received from the swap(s) to an address on a different chain than the swap occured on. The ICS-20 transfer supports including a memo in the outgoing transfer, allowing for multi-hop transfers via Packet Forward Middleware and/or contract calls via IBC-hooks. | ||
| - `contract_call`: Calls a contract on the same chain the swap occured, using the assets received from the swap as the contract call's funds. | ||
| - `affiliates` is a list of affiliates that will take a fee (in basis points) from the coin received from the `user_swap`. If no affiliates are associated with a call then an empty list is to be provided. | ||
|
|
||
| ``` json | ||
| { | ||
| "swap_and_action": { | ||
| "fee_swap": { | ||
| "swap_venue_name": "neutron-astroport", | ||
| "coin_out": { | ||
| "denom": "untrn", | ||
| "amount": "200000" | ||
| }, | ||
| "operations": [ | ||
| { | ||
| "pool": "neutron...", | ||
| "denom_in": "uatom", | ||
| "denom_out": "untrn" | ||
| } | ||
| ] | ||
| }, | ||
| "user_swap": { | ||
| "swap_venue_name": "neutron-astroport", | ||
| "coin_in": { | ||
| "denom": "uatom", | ||
| "amount": "1000000" | ||
| }, | ||
| "operations": [ | ||
| { | ||
| "pool": "neutron...", | ||
| "denom_in": "uatom", | ||
| "denom_out": "untrn" | ||
| }, | ||
| { | ||
| "pool": "neutron...", | ||
| "denom_in": "untrn", | ||
| "denom_out": "uosmo" | ||
| } | ||
| ] | ||
| }, | ||
| "min_coin": { | ||
| "denom": "uosmo", | ||
| "amount": "1000000" | ||
| }, | ||
| "timeout_timestamp": 1000000000000, | ||
| "post_swap_action": { | ||
| "bank_send": { | ||
| "to_address": "neutron..." | ||
| } | ||
| }, | ||
| "affiliates": [ | ||
| { | ||
| "basis_points_fee": 10, | ||
| "address": "neutron..." | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### `post_swap_action` | ||
|
|
||
| Performs a post swap action. | ||
|
|
||
| Note: Can only be called by the entry point contract itself, any external calls to this function will fail. | ||
|
|
||
| ``` json | ||
| { | ||
| "post_swap_action": { | ||
| "min_coin": { | ||
| "denom": "uosmo", | ||
| "amount": "1000000" | ||
| }, | ||
| "timeout_timestamp": 1000000000000, | ||
| "post_swap_action": { | ||
| "bank_send": { | ||
| "to_address": "neutron..." | ||
| } | ||
| }, | ||
| "affiliates": [ | ||
| { | ||
| "basis_points_fee": 10, | ||
| "address": "neutron..." | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## QueryMsg | ||
|
|
||
| ### `swap_venue_adapter_contract` | ||
|
|
||
| Returns the swap adapter contract set at instantiation for the given swap venue name provided as an argument. | ||
|
|
||
| Query: | ||
| ``` json | ||
| { | ||
| "swap_venue_adapter_contract": { | ||
| "name": "neutron-astroport" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Response: | ||
| ``` json | ||
| "neutron..." | ||
| ``` | ||
|
|
||
| ### `ibc_transfer_adapter_contract` | ||
|
|
||
| Returns the IBC transfer adapter contract set at instantiation, requires no arguments. | ||
|
|
||
| Query: | ||
| ``` json | ||
| { | ||
| "ibc_transfer_adapter_contract": {} | ||
| } | ||
| ``` | ||
|
|
||
| Response: | ||
| ``` json | ||
| "neutron..." | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # Neutron IBC Transfer Adapter Contract | ||
|
|
||
| The Neutron IBC Transfer adapter contract is responsible for: | ||
| 1. Dispatching the IBC transfer with the appropriate IBC fees. | ||
| 2. Failing the entire transaction if the IBC transfer errors on the swap chain (sending the caller back their original funds). | ||
| 3. Refunding the caller on the swap chain if the IBC transfer errors or times out once it reaches the destination chain, including refunding unused IBC fees. | ||
|
|
||
| WARNING: Do not send funds directly to the contract without calling one of its functions. Funds sent directly to the contract do not trigger any contract logic that performs validation / safety checks (as the Cosmos SDK handles direct fund transfers in the `Bank` module and not the `Wasm` module). There are no explicit recovery mechanisms for accidentally sent funds. | ||
|
|
||
| ## InstantiateMsg | ||
|
|
||
| Instantiates a new Neutron IBC Transfer adapter contract. | ||
|
|
||
| ``` json | ||
| {} | ||
| ``` | ||
|
|
||
| ## ExecuteMsg | ||
|
|
||
| ### `ibc_transfer` | ||
|
|
||
| Dispatches an ICS-20 IBC Transfer given the parameters provided in the contract call. | ||
|
|
||
| ``` json | ||
| { | ||
| "ibc_transfer": { | ||
| "info": { | ||
| "source_channel": "channel-1", | ||
| "receiver": "cosmos...", | ||
| "fee": { | ||
| "recv_fee": [], | ||
| "ack_fee": [ | ||
| { | ||
| "denom": "untrn", | ||
| "amount": "100000" | ||
| } | ||
| ], | ||
| "timeout_fee": [ | ||
| { | ||
| "denom": "untrn", | ||
| "amount": "100000" | ||
| } | ||
| ] | ||
| }, | ||
| "memo": "", | ||
| "recover_address": "neutron..." | ||
| }, | ||
| "coin": { | ||
| "denom": "uatom", | ||
| "amount": "1000000" | ||
| }, | ||
| "timeout_timestamp": 1000000000000 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## QueryMsg | ||
|
|
||
| ### `in_progress_ibc_transfer` | ||
|
|
||
| Returns the in progress ibc transfer info associated with the given `channel_id` and `sequence_id` (which make up a unique identifier mapped to in progress ibc transfers in the sub msg reply handler). | ||
|
|
||
| Query: | ||
| ``` json | ||
| { | ||
| "in_progress_ibc_transfer": { | ||
| "channel_id": "channel-1", | ||
| "sequence_id": 420 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Response: | ||
| ``` json | ||
| { | ||
| "recover_address": "neutron...", | ||
| "coin": { | ||
| "denom": "uatom", | ||
| "amount": "1000000" | ||
| }, | ||
| "ack_fee": [ | ||
| { | ||
| "denom": "untrn", | ||
| "amount": "100000" | ||
| } | ||
| ], | ||
| "timeout_fee": [ | ||
| { | ||
| "denom": "untrn", | ||
| "amount": "100000" | ||
| } | ||
| ] | ||
| } | ||
| ``` |
Oops, something went wrong.