search

icon-project / xcall.dev

https://www.xcall.dev/
MIT License
8 stars 3 forks source link

Update the "Sending a message" tutorial to reference xcall-scaffolding repo #16

Closed han-so1omon closed 1 year ago

han-so1omon commented 1 year ago

As xcall-scaffolding is the canonical sample repo for xcall, the "Sending a message" tutorial must reference this repository. Currently, the tutorial references the xcall-sample-dapp repo, which has been recently modified and now serves a different purpose

In order to send a message with the canonical sample dApp, the sections for "Sending a message" and "Sending a message with rollback" should be updated to reference the public functions that perform cross-chain messages (e.g. voteYes)

Alternatively, a new docs page may be put in to detail working with the canonical app, in which case the existing page should be edited to more clearly use the updated DAppProxySampleUtilityFunctions repository in conjunction with the e2edemo dapp sample

Also, the prerequisite link on this page does not work

han-so1omon commented 1 year ago

"Sending a message" guide should probably be updated too, as well as the quickstart

CyrusVorwald commented 1 year ago

The purpose of https://github.com/icon-community/DAppProxySampleUtilityFunctions and related guides is to demonstrate how to programmatically interact with DAppProxySample.sol and its Java equivalent.

The purpose of xcall-scaffolding is to provide a template repository to be forked from.

So your alternative suggestion to create a separate page is the best path forward for now.

Later on, these may be consolidated. For example, the programmatic interactions could also be in xcall-scaffolding. This was only published yesterday so it will take a bit of time.

CyrusVorwald commented 1 year ago

Closing this as resolved by https://github.com/icon-project/xcall.dev/pull/6