Skip to content

Commit 5d45b71

Browse files
womensrightscoderabbitai[bot]crodriguezvegaDimitrisJim
authored
docs: create ics27-multiplexed-requirements.md (#6281)
* Create ics27-multiplexed-requirements.md * Update ics27-multiplexed-requirements.md * Update docs/requirements/ics27-multiplexed-requirements.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/requirements/ics27-multiplexed-requirements.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/requirements/ics27-multiplexed-requirements.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ics27-multiplexed-requirements.md * Update docs/requirements/ics27-multiplexed-requirements.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
1 parent fc63b5c commit 5d45b71

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

‎docs/requirements/ics27-multiplexed-requirements.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<!-- More detailed information about the requirements engineering process can be found at https://github.com/cosmos/ibc-go/wiki/Requirements-engineering -->
2+
3+
# Business requirements
4+
5+
The Interchain Accounts feature has enabled control of an account on a host chain remotely from a controller chain. This has opened up many possibilities for more complex cross-chain workflows beyond token transfer alone, but the current architecture is not easy to use for the case where there are on the order of 1000s of host accounts controlled by many controllers. These requirements aim to alleviate current pain points and enhance the usability of the feature.
6+
7+
## Problem
8+
9+
The current pain points for existing ICA users are listed:
10+
11+
- *Account Flexibility* - Currently host accounts can only be of type `BaseAccount`
12+
13+
- *Ordered Channels* - Timeouts and subsequent channel closures are time-consuming and difficult to manage
14+
15+
- *Scalability* - When there are many interchain accounts, and many channels (in the order of 1000s), relayers struggle with the number of queries on startup and performance is compromised. Additionally, account registration being linked to the channel means that multiple packet round trips are required before your host account can execute messages.
16+
17+
- *Workflows requiring tokens in ICA* - there are no atomic guarantees for a workflow containing multiple applications - i.e. a token transfer followed by an ICA message. The transfer could succeed and the ICA message fail, resulting in an incomplete workflow.
18+
19+
- *Lack of default callbacks* - users are still relying on custom auth modules for packet callbacks, the callbacks middleware solves this problem but is an add-on to the application rather than a default
20+
21+
*Whitelisting messages* - this devex is more complicated than having a blacklist
22+
23+
## Objectives
24+
25+
- Enable different account types, to be controlled remotely
26+
- To streamline workflows using token transfer and interchain accounts in combination
27+
- To enable scalable and efficient account creation
28+
29+
## Scope
30+
31+
| Features | Release |
32+
| --------- | ------- |
33+
| Multi-plexed Interchain Accounts | ibc-go v10.0.0 |
34+
35+
# User requirements
36+
37+
## Use cases
38+
39+
Existing use cases have been detailed in ics27 and ics27 v2 requirements, some other notable use cases used in production are cross chain liquid staking, yield through leveraged lending and cross chain NFT minting.
40+
41+
### Liquid Staking
42+
43+
Chains such as Stride, Quicksilver and pStake control Interchain Accounts on a host chain to stake tokens on behalf of their users and mint representative liquid staking tokens so that users can transact with liquid tokens, rather than a locked staked asset but still earn staking rewards through autocompounding on the Interchain Account. More information on Stride's technical architecture can be found [here](https://github.com/Stride-Labs/stride/tree/main?tab=readme-ov-file#strides-technical-architecture).
44+
45+
### Leveraged Lending
46+
47+
Nolus enables users to borrow assets and use the inflation from staking rewards to repay the interest on the principle. e.g. a user could deposit 10 OSMO as collateral for a 25 OSMO position. When a user opens a position, an Interchain Account is opened on Osmosis and the loan amount is sent to the account with management of the account through the Nolus chain.
48+
49+
### Cross-chain NFT minting
50+
51+
Nomos enable NFTs to be minted on Injective on host accounts controlled from the Xion chain, providing a single interface for users, enabling chain abstraction.
52+
53+
# Functional requirements
54+
55+
## Assumptions and dependencies
56+
57+
- Although having atomic transfer plus action workflows with Interchain Accounts is desirable, it is out of scope for these requirements, as a solution is applicable to applications beyond Interchain Accounts alone.
58+
Migration of an existing Interchain Account using a prior version of Interchain Accounts that does not satisfy these requirements is not required.
59+
- Assumes use of the `x/accounts` sdk module.
60+
61+
## Features
62+
63+
### 1 - Configuration
64+
65+
| ID | Description | Verification | Status |
66+
| -- | ----------- | ------------ | ------ |
67+
| 1.01 | The host chain should accept all message types by default and maintain a blacklist of message types it does not permit | ------------ | ------ |
68+
69+
### 2 - Registration
70+
71+
| ID | Description | Verification | Status |
72+
| -- | ----------- | ------------ | ------ |
73+
| 2.01 | The controller of the interchain account must have authority over the account on the host chain to execute messages | -- | ----------- |
74+
| 2.02 | A registered interchain account can be any account type supported by `x/accounts` | ------------ | ------ |
75+
76+
### 3 - Control
77+
78+
| ID | Description | Verification | Status |
79+
| -- | ----------- | ------------ | ------ |
80+
| 3.01 | The channel type through which a controller sends transactions to the host should be unordered | ------------ | ------ |
81+
| 3.02 | The message execution order should be determined at the packet level | ------------ | ------ |
82+
| 3.03 | Many controllers can send messages to many host accounts through the same channel | ------------ | ------ |
83+
| 3.04 | The controller of the interchain account should be able to receive information about the balance of the interchain account in the acknowledgment after a transaction was executed by the host | ------------ | ------ |
84+
| 3.05 | The user of the controller should be able to receive all the information contained in the acknowledgment without implementing additional middleware on a per-user basis | ------------ | ------ |
85+
| 3.06 | Callbacks on the packet lifecycle should be supported by default | ------------ | ------ |
86+
| 3.07 | A user can perform module safe queries through a host chain account and return the result in the acknowledgment | ------------ | ------ |
87+
88+
### 4 - Host execution
89+
90+
| ID | Description | Verification | Status |
91+
| -- | ----------- | ------------ | ------ |
92+
| 4.01 | It should be possible to ensure a packet lifecycle from a different application completes before a message from a controller is executed | ------------ | ------ |
93+
| 4.02 | It should be possible for a controller to authorise a host account to execute specific actions on a host chain without needing a packet round trip each time (e.g. auto-compounding) | ------------ | ------ |
94+
95+
# Non-functional requirements
96+
97+
## 5 - Performance
98+
99+
| ID | Description | Verification | Status |
100+
| -- | ----------- | ------------ | ------ |
101+
| 5.01 | The number of packet round trips to register an account, load the account with tokens and execute messages on the account should be minimised | ------------ | ------ |

0 commit comments

Comments
 (0)