Skip to content

Commit

Permalink
Update path-unwinding-forwarding -requirements.md
Browse files Browse the repository at this point in the history
  • Loading branch information
womensrights committed Mar 20, 2024
1 parent 1484c6e commit f7fd161
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/requirements/path-unwinding-forwarding -requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,16 @@ A user on one chain, for example the Cosmos Hub holds an asset, e.g. ATOM and wa

| ID | Description | Verification | Status |
| -- | ------ | ------------ | ------ |
| -- | When a user initiates a transfer to a destination chain with an IBC denom with > 1 hop, the token shall be sent back to its originating chain before being sent onto the destination as a default | ------------ | draft |
| -- | If a user does not want to unwind the tokens, then they can override the default unwinding | ------------ | draft |
| -- | The unwinding shall completely succeed or the tokens are recoverable on the chain they were sent from by the user | ------------ | draft |
| -- | When unwinding is used in combination with forwarding, both the unwind and forwarding should succeed or the tokens should be recoverable on the sending chain | ------------ | draft |
| -- | The forwarding mechanism shall allow a user to transfer tokens beyond the first destination for those tokens | ------------ | draft |
| -- | The forwarding mechanism shall allow tokens to have some action performed on them before being sent onto a new destination | ------------ | draft |
| -- | The routing information for forwarding or to go from unwound token to destination must be input with the initial transfer | ------------ | draft |
| -- | If an intermediate chain does not have the unwinding or forwarding functionality, the tokens must be recoverable on the sending chain | ------------ | draft |
-- | If unwinding or forwarding fails, then the reason for the failure should be returned in an error | ------------ | draft |
| -- | When unwinding, it should be possible for the unwind route to the tokens origin to be introspected from the denomination trace | ------------ | draft |
| 1.01 | When a user initiates a transfer to a destination chain with an IBC denom with > 1 hop, the token shall be sent back to its originating chain before being sent onto the destination as a default | ------------ | draft |
| 1.02 | If a user does not want to unwind the tokens, then they can override the default unwinding | ------------ | draft |
| 1.03 | The unwinding shall completely succeed or the tokens are recoverable on the chain they were sent from by the user | ------------ | draft |
| 1.04 | When unwinding is used in combination with forwarding, both the unwind and forwarding should succeed or the tokens should be recoverable on the sending chain | ------------ | draft |
| 1.05 | The forwarding mechanism shall allow a user to transfer tokens beyond the first destination for those tokens | ------------ | draft |
| 1.06 | The forwarding mechanism shall allow tokens to have some action performed on them before being sent onto a new destination | ------------ | draft |
| 1.07 | The routing information for forwarding or to go from unwound token to destination must be input with the initial transfer | ------------ | draft |
| 1.08 | If an intermediate chain does not have the unwinding or forwarding functionality, the tokens must be recoverable on the sending chain | ------------ | draft |
1.09 | If unwinding or forwarding fails, then the reason for the failure should be returned in an error | ------------ | draft |

Check failure on line 98 in docs/requirements/path-unwinding-forwarding -requirements.md

View workflow job for this annotation

GitHub Actions / lint

Table pipe style

docs/requirements/path-unwinding-forwarding -requirements.md:98:2 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md055.md
| 1.10| When unwinding, it should be possible for the unwind route to the tokens origin to be introspected from the denomination trace | ------------ | draft |


Check failure on line 101 in docs/requirements/path-unwinding-forwarding -requirements.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines

docs/requirements/path-unwinding-forwarding -requirements.md:101 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md
# External interface requirements
Expand All @@ -105,17 +105,17 @@ A user on one chain, for example the Cosmos Hub holds an asset, e.g. ATOM and wa

| ID | Description | Verification | Status |
| -- | ----------- | ------------ | ------ |
| -- | There must be a CLI interface to initiate a transfer using path unwinding | ------------ | draft |
| -- | There must be a CLI interface to initiate a transfer using forwarding | ------------ | draft |
| -- | There must be a CLI interface to initiate a transfer using unwinding and forwarding in combination | ------------ | draft |
| 2.01 | There must be a CLI interface to initiate a transfer using path unwinding | ------------ | draft |
| 2.02 | There must be a CLI interface to initiate a transfer using forwarding | ------------ | draft |
| 2.03 | There must be a CLI interface to initiate a transfer using unwinding and forwarding in combination | ------------ | draft |

# Non-functional requirements

### Security

Check failure on line 114 in docs/requirements/path-unwinding-forwarding -requirements.md

View workflow job for this annotation

GitHub Actions / lint

Heading levels should only increment by one level at a time

docs/requirements/path-unwinding-forwarding -requirements.md:114 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md

| ID | Description | Verification | Status |
| -- | ----------- | ------------ | ------ |
| -- | It must not be possible for a users tokens to be intercepted by another actor during path-unwinding or token forwarding | ------------ | draft |
| 3.01 | It must not be possible for a users tokens to be intercepted by another actor during path-unwinding or token forwarding | ------------ | draft |


Check failure on line 120 in docs/requirements/path-unwinding-forwarding -requirements.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines

docs/requirements/path-unwinding-forwarding -requirements.md:120 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md
<!-- Other-than-functional requirements that do not specify what the system does, but rather how well it does those things. For example: quality requirements: performance, security, portability, etc. -->

0 comments on commit f7fd161

Please sign in to comment.