-
Notifications
You must be signed in to change notification settings - Fork 39
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
Update Orchestration Walkthrough #1151
Conversation
Deploying documentation with Cloudflare Pages
|
Cloudflare deployment logs are available here |
## Start Function | ||
Now we define the main entrypoint of the contract, the `start` function, with the usual arguments, `zcf`, `privateAge`, and `baggage`: |
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.
I think we should keep explaining that the module exports a start
function.
It's merely a convention/convenience that we define a more abstract contract
and pass it to withOrchestration
.
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.
I have added/updated the description to fix this. I am just documenting the code here. Not explaining contract
function (or just explaining start
function) may confuse the reader IMO.
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.
@turadg Will wait for your comments before merge.
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.
i see. lgtm
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.
I left a few comments. Please fix them before merging. Looks good to me.
## Start Function | ||
Now we define the main entrypoint of the contract, the `start` function, with the usual arguments, `zcf`, `privateAge`, and `baggage`: | ||
## `contract` Function | ||
The `contract` function when wrapped inside `withOrchestration` defines the entry point of the contract., with the arguments, `zcf`, `privateAge`, `zone`, and `tools` for orchestration: |
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.
The `contract` function when wrapped inside `withOrchestration` defines the entry point of the contract., with the arguments, `zcf`, `privateAge`, `zone`, and `tools` for orchestration: | |
The `contract` function when wrapped inside `withOrchestration` defines the entry point of the contract, with the arguments, `zcf`, `privateAge`, `zone`, and `tools` for orchestration: |
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.
Fixed.
@@ -63,7 +63,6 @@ Retrieves the omniflixhub chain object using the orchestrator. | |||
Creates an account on the omniflixhub chain. | |||
|
|||
## Placeholder for Delegation and Undelegation | |||
TODO |
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.
I think we should delete these headings completely that are not explained yet, and add them when we know what to add for them.
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.
Done.
``` | ||
|
||
Defines the `start` function of the contract as a wrapped veriosn of [`contract` function above](#contract-function) with `withOrchestration`. |
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.
Can we rewrite this sentence, because it seems weird for some reason with as a wrapped...
.
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.
Done.
There are similar changes for two of the walkthroughs in orchestration section: Cross Chain Swap and Cross Chain Unbond. The major change is use of the new
withOrchestration
API.Refs: