Teleporter devnet guide #1624
Teleporter devnet guide #1624
Conversation
cam-schultz
requested review from
laviniat1996,
dubrado,
meaghanfitzgerald,
martineckardt,
Andyvargtz,
ashucoder9 and
usmaneth
as code owners
|
|
||
| <!-- vale off --> | ||
|
|
||
| [Teleporter](https://github.com/ava-labs/teleporter) is a cross-chain messaging protocol built on top of Warp. Teleporter provides a user-friendly interface to Warp that provides additional features such as replay protection, message delivery incentives, and message execution, to name a few. |
There was a problem hiding this comment.
add a link to something explaining what is warp
There was a problem hiding this comment.
probably a first paragraph is needed as introduction of what is comming next in the tutorial, adding a basic explanation of the why of wapr/teleporter
There was a problem hiding this comment.
I added a link to the Warp documentation in the "Create a Devnet with Warp-Enabled Subnets" section.
As for the changes here, can you suggest specific changes? I believe the link to the Teleporter repo, a brief explanation of what Teleporter is, and how we are using it to extend the devnet example already covers what you asked for.
|
|
||
| [Teleporter](https://github.com/ava-labs/teleporter) is a cross-chain messaging protocol built on top of Warp. Teleporter provides a user-friendly interface to Warp that provides additional features such as replay protection, message delivery incentives, and message execution, to name a few. | ||
|
|
||
| Now that the Warp-enabled devnet is up and running, Teleporter can be deployed to the C-Chain and subnet-evm subnets. Teleporter is deployed using [Nick's method](https://yamenmerhi.medium.com/nicks-method-ethereum-keyless-execution-168a6659479c) to ensure that the Teleporter contract is deployed to the same address on all chains. For instructions on how to deploy Teleporter, please see the guide [here.](https://github.com/ava-labs/teleporter/blob/main/utils/contract-deployment/README.md) Follow those instructions to deploy Teleporter to Subnet A, Subnet B, and the C-Chain. |
There was a problem hiding this comment.
I believe we need to list here the commands, to deploy the contract(s) and to fund the needed addresses, with a brief explanation of those.
There was a problem hiding this comment.
I'd prefer to not repeat documentation in multiple places - the requested steps are already included in the linked documentation.
|
|
||
| #### Interact with Teleporter | ||
|
|
||
| With the Warp-enabled devnet deployed, Teleporter deployed on each of the chains, and an AWM Relayer instance running, the Teleporter development environment is ready to go! A good place to start are the [example applications](https://github.com/ava-labs/teleporter/blob/main/contracts/src/CrossChainApplications/README.md) included in the Teleporter repository. These dApps are built on top of Teleporter and demonstrate various cross-chain messaging use cases. |
There was a problem hiding this comment.
could you add a simplest example, maybe using curl, outside of any other ref, and then link to other docs
There was a problem hiding this comment.
I think any example included inline here would make this doc unnecessarily messy. Instead, I've linked to the various Teleporter getting started guides and example scripts to serve as a starting point. Specifically, https://github.com/ava-labs/teleporter/blob/main/scripts/local/examples/basic_send_receive.sh includes all the commands for interacting with Teleporter, and serves as documentation in and of itself.
|
@felipemadero Could you please check the comments and see if those conversations can be solved? |
Signed-off-by: Meaghan FitzGerald <[email protected]>
Signed-off-by: Meaghan FitzGerald <[email protected]>
|
@cam-schultz Just a friendly reminder to check on this when you have time |
I don't think there are any comments that I haven't responded to yet in this PR. @felipemadero , are you planning on taking another pass at this? Otherwise we should decide whether to merge or close this PR. |
|
@cam-schultz the conflicting files are the issue now, and I cannot fix it myself because it's your fork branch :( |
…docs into teleporter-devnet
Ahh, my bad. Synced my fork and merged in master here. All conflicts should be resolved now 👍 |
|
Closing this as the upcoming Teleporter integration into avalanche-cli will largely invalidate these steps. This closed PR can be used as a reference when putting together documentation for that integration. |
Docs PR Template
Why this should be merged
Adds instructions for deploying Teleporter and running a relayer on a devnet set up through avalanche-cli
How this works
See above
How these changes were tested
N/A
To prevent any errors while building
vale /docs/file/pathon all changed.mdfiles to ensure all grammar rules passmarkdownlint /docs/file/pathon all changed.mdfiles to ensure all linting rules passstyle-checker-notes.mdtoensure all checks pass
If a document was removed/deleted
_redirectsfile_redirectswere manually verified with the cloudflare preview linksidebars.jsonreflects all changes made to file pathIf a document was moved
redirected via the
_redirectsfile_redirectswere manually verified with the cloudflare preview linksidebars.jsonreflects all changes made to file path