Update getting started guide #202
Conversation
cam-schultz
requested review from
michaelkaplan13,
minghinmatthewlam,
gwen917,
geoff-vball and
bernard-avalabs
as code owners
Co-authored-by: Michael Kaplan <[email protected]> Signed-off-by: cam-schultz <[email protected]>
cam-schultz
requested review from
bernard-avalabs,
geoff-vball and
michaelkaplan13
|
|
||
| To start, replace the import for `ITeleporterReceiver` with `TeleporterOwnerUpgradeable`: | ||
|
|
||
| ```diff |
There was a problem hiding this comment.
Didn't know you could put diffs in READMEs like this. Very nice!
| {} | ||
| ``` | ||
|
|
||
| Finally, add the following struct and event declarations to the contract, which will be integrated in later: |
There was a problem hiding this comment.
| Finally, add the following struct and event declarations to the contract, which will be integrated in later: | |
| Add the following struct and event declarations to the contract, which will be integrated in later: |
There was a problem hiding this comment.
Gonna keep this as is to match the flow of the rest of this step.
| @@ -4,31 +4,70 @@ This section walks through how to build an example cross-chain application on to | |||
|
|
|||
| ## Step 1: Create Initial Contract | |||
|
|
|||
| Create a new file called `MyExampleCrossChainMessenger.sol` in the directory that will hold the application. | |||
| Create a new file called `MyExampleCrossChainMessenger.sol` in a `teleporter/contracts/src/CrossChainApplications/MyExampleCrossChainMessenger/` directory. | |||
There was a problem hiding this comment.
Are you clarifying the exact path because of the imports with "../../"?
There was a problem hiding this comment.
Can you separate and add a line to create a new directory MyExampleCrossChainMessenger at the path, then create file under that directory
There was a problem hiding this comment.
Not sure what you mean by exact path. The remappings don't apply to bash commands. We should circle back and add those remappings to these contracts, but I'm not going to do that in this PR.
Added exact commands as requested.
…er into update-getting-started
cam-schultz
dismissed stale reviews from michaelkaplan13 and geoff-vball
via
dcde08c
cam-schultz
requested review from
michaelkaplan13,
geoff-vball and
minghinmatthewlam
Why this should be merged
Updates the Getting Started Guide to reflect the latest version of
ExampleCrossChainMessenger, which usesTeleporterOwnerUpgradeable, as well as a handful of other changes that fell through the cracks. Also adds a standalone Upgrades section, demonstrating how to modify the contract from directly interacting withTeleporterMessengerto doing so indirectly throughTeleporterRegistry.How this works
N/A
How this was tested
N/A
How is this documented
Self explanatory