Update Orch/Unbond Walkthrough #1221
Merged
Conversation
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
amessbee
force-pushed
the
ms/update-unbond-walkthrough
branch
from
71fdec0 to
aebbc20
Compare
Deploying documentation with
|
| Latest commit: |
1a2fc75
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://85705e74.documentation-7tp.pages.dev |
| Branch Preview URL: | https://ms-update-unbond-walkthrough.documentation-7tp.pages.dev |
amessbee
changed the title
mujahidkay
reviewed
Oct 1, 2024
|
|
||
| - `M`: Imported from @endo/patterns, provides pattern-matching utilities. | ||
| - `withOrchestration`: Imported from a utility module, used to set up and provide access to orchestration tools. | ||
| The Unbond Contract leverages the Agoric orchestration to interact with external chains, like Osmosis and Stride, to facilitate unbonding and transferring assets from one chain to another. |
There was a problem hiding this comment.
Suggested change
| The Unbond Contract leverages the Agoric orchestration to interact with external chains, like Osmosis and Stride, to facilitate unbonding and transferring assets from one chain to another. | |
| The Unbond Contract leverages the Agoric orchestration API to interact with external chains, like Osmosis and Stride, to facilitate unbonding and transferring assets from one chain to another. |
There was a problem hiding this comment.
nit: orchestration -> Orchestration
|
|
||
| Creates an account on the omniflixhub chain. | ||
| The `contract` function when wrapped inside `withOrchestration` defines the [`start` function](#start-function) which is the entry point of the contract. The contract exports a `start` function [below](#start-function). It is merely a convention/convenience that we define a more abstract `contract` function here and pass it to `withOrchestration`. The `contract` function parameters include: |
There was a problem hiding this comment.
There needs to be a separate h3 for the start function below for the link to work. It doesn't, right now.
There was a problem hiding this comment.
Good catch. Will add back.
Comment on lines
+62
to
+64
| harden({ | ||
| give: {}, | ||
| want: {}, | ||
| exit: M.any() | ||
| }) |
There was a problem hiding this comment.
Can we add a line or two about why this contract doesn't have or expect any give/want terms?
There was a problem hiding this comment.
I don't feel the need for it - this would raise more questions that rather not be answer here.
| ``` | ||
|
|
||
| ### `contract` Function Parameters: | ||
| --- |
There was a problem hiding this comment.
Are the double section separators intentional? They look weird.
There was a problem hiding this comment.
No - let me fix that.
|
@mujahidkay please re-review! |
amessbee
force-pushed
the
ms/update-unbond-walkthrough
branch
from
e83589c to
1a2fc75
Compare
mujahidkay
approved these changes
Oct 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
unbondexample contract inorchestrationhas changed since we lasted documented it here. This is an update based on the new changes.Refs: