-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
docs: Adding README #12
Open
spoo-bar
wants to merge
4
commits into
main
Choose a base branch
from
spoorthi/eng-203-update-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
name: "Ensure changelog updates" | ||
on: | ||
pull_request: | ||
branches: [main] | ||
|
||
jobs: | ||
changelog: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: dangoslen/changelog-enforcer@v3 | ||
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,36 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
<!-- | ||
### Added | ||
|
||
Contains the new features. | ||
|
||
### Changed | ||
|
||
Contains API breaking changes to existing functionality. | ||
|
||
### Deprecated | ||
|
||
Contains the candidates for removal in a future release. | ||
|
||
### Removed | ||
|
||
Contains API breaking changes of removed APIs. | ||
|
||
### Fixed | ||
|
||
Contains bug fixes. | ||
|
||
### Improvements | ||
|
||
Contains all the PRs that improved the code without changing the behaviors. | ||
--> | ||
|
||
## Unreleased | ||
|
||
### Added | ||
|
||
- Initial implementation of AutoCCTP middleware | ||
- [#5](https://github.com/noble-assets/autocctp/pull/5) - Bumping to latest ibc-go v8 |
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,83 @@ | ||
# AutoCCTP | ||
|
||
AutoCCTP is an IBC Middleware which allows a user to send funds from an IBC connected chain using the ICS20 protocol, to a non-Cosmos CCTP domain, via the Noble chain. | ||
|
||
The middleware has a strong dependency on CCTP module and expects a specific format of the ICS20 memo field populated with CCTP Deposit parameters to be filled. | ||
|
||
## How to use? | ||
|
||
ICS20 transfer destination address needs to be the module address of the `autocctp` module. For any other address, autocctp is not possible. This value can be obtained by running | ||
|
||
```sh | ||
nobled q auth module-account autocctp | ||
# or | ||
curl {rest-api-url}/cosmos/auth/v1beta1/module_accounts/autocctp | ||
``` | ||
|
||
The current module addresses are: | ||
| Network | Chain ID | Address | | ||
| ------- | -------- | ------- | | ||
| Mainnet | noble-1 | //todo | | ||
| Testnet | grand-1 | //todo | | ||
|
||
ICS20 transfer incoming from counterparty chain needs to populate the ICS20 memo field with following information: | ||
|
||
1. **Destination Domain** - Circle issued identifier for different blockchains. Values for this field can be found [here](https://developers.circle.com/stablecoins/supported-domains). | ||
2. **Mint Recipient** - Address of the recipient on the Destination Domain | ||
3. **Fee Recipient** (optional) - A bech32 encoded address on Noble which will receive the transfer fees. If this value is specified, Amount also needs to be specified. | ||
4. **Amount** (optional) - Number denoting the amount which should be forwarded to the Destination Domain. Should be less than ICS20 transfer amount. The difference will be sent to Fee Recipient. | ||
5. **Destination Caller** (optional) - Caller on destination domain | ||
|
||
The response acknowledgement includes the Deposit Nonce in case of success, and error message in case of failure. If the autocctp forwarding fails, the entire ICS20 transfer fails and the funds are avaliable back on the counterparty chain. | ||
|
||
### Examples | ||
|
||
1. Forward entire ICS20 transfer amount to the destination domain | ||
|
||
```jsonc | ||
{ | ||
"deposit_for_burn": { | ||
"destination_domain": 5, | ||
"mint_recipient": "MLqOfAGMXKGrGr0LNjV8xjpJALM3zZB/GDVgGqlEjcU=" | ||
} | ||
} | ||
``` | ||
|
||
2. Forward only the specified amount to the destination domain | ||
|
||
```jsonc | ||
{ | ||
"deposit_for_burn": { | ||
"destination_domain": 5, | ||
"mint_recipient": "MLqOfAGMXKGrGr0LNjV8xjpJALM3zZB/GDVgGqlEjcU=", | ||
"amount": "99", | ||
"fee_recipient": "noble1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33qz" | ||
} | ||
} | ||
``` | ||
|
||
3. Forward entire ICS20 transfer amount to the destination domain with destination caller | ||
|
||
```jsonc | ||
{ | ||
"deposit_for_burn_with_caller": { | ||
"destination_domain": 5, | ||
"mint_recipient": "MLqOfAGMXKGrGr0LNjV8xjpJALM3zZB/GDVgGqlEjcU=", | ||
"destination_caller": "T6iiTX0dDAj20/FvjjtLKCjtLcy5XQ4dTO6NFHPaG1U=" | ||
} | ||
} | ||
``` | ||
|
||
4. Forward only the specified amount to the destination domain with destination caller | ||
|
||
```jsonc | ||
{ | ||
"deposit_for_burn_with_caller": { | ||
"destination_domain": 5, | ||
"mint_recipient": "MLqOfAGMXKGrGr0LNjV8xjpJALM3zZB/GDVgGqlEjcU=", | ||
"amount": "100", | ||
"fee_recipient": "noble1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33qz", | ||
"destination_caller": "T6iiTX0dDAj20/FvjjtLKCjtLcy5XQ4dTO6NFHPaG1U=" | ||
} | ||
} | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add newline at end of file.
Add a newline character at the end of the file to comply with POSIX standards.
- uses: dangoslen/changelog-enforcer@v3 +
📝 Committable suggestion
🧰 Tools
🪛 yamllint
[error] 10-10: no new line character at the end of file
(new-line-at-end-of-file)