Adding send-anywhere Orchestration Contract Walkthrough
#1217
Conversation
Deploying documentation with
|
| Latest commit: |
146b47b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://107e535c.documentation-7tp.pages.dev |
| Branch Preview URL: | https://ms-walkthrough-sendanywhere.documentation-7tp.pages.dev |
amessbee
force-pushed
the
ms/walkthrough-sendAnywhere
branch
from
be6d357 to
76aaa08
Compare
amessbee
force-pushed
the
ms/walkthrough-sendAnywhere
branch
from
76aaa08 to
a4f6c0f
Compare
main/.vitepress/config.mjs
Outdated
| @@ -437,6 +437,10 @@ export default defineConfig({ | |||
| text: 'Contract Walkthroughs', | |||
| link: '/guides/orchestration/getting-started/contract-walkthroughs', | |||
| items: [ | |||
| { | |||
There was a problem hiding this comment.
After updating branch and resolving conflicts, you will also have to add his to navbar
|
|
||
| This validation ensures that the proposal shape submitted by users contains exactly one asset and no other extraneous properties. | ||
|
|
||
| ### Contract State Setup (in `contract` Function) |
There was a problem hiding this comment.
Instead of re-iterating in contract Function multiple times, can we just have a prefaced one-liner that sets up for these h3s?
There was a problem hiding this comment.
I am removing it all together for now. We may get back to it in a new PR.
| expose `publicFacet` and `creatorFacet`. | ||
| 2. `send-anywhere.flows.js` implements the `sendIt` function which performs the actual transfer of assets when a user makes an offer. | ||
|
|
||
| Let us walkthrough these files one by one. |
There was a problem hiding this comment.
| Let us walkthrough these files one by one. | |
| Let us walk through these files one by one. |
:)
| ### Logging setup (in `contract` Function) | ||
|
|
||
| The contract initializes a logging mechanism (`logNode`) to capture the contract's internal actions and state changes. Logs are written | ||
| to a newly created `log` child in vStorage, making debugging and auditing easier. |
There was a problem hiding this comment.
| to a newly created `log` child in vStorage, making debugging and auditing easier. | |
| to a newly created `log` child in VStorage, making debugging and auditing easier. |
I think that's how we refer to it
amessbee
force-pushed
the
ms/walkthrough-sendAnywhere
branch
from
a4f6c0f to
281713b
Compare
|
@mujahidkay please revisit - also confirm that links in navbar and sidebar. |
| @@ -0,0 +1,207 @@ | |||
| # SendAnywhere Contract Walkthrough | |||
There was a problem hiding this comment.
| # SendAnywhere Contract Walkthrough | |
| # Send Anywhere Contract Walkthrough |
or maybe send-anywhere if we want to adopt the filename
| The contract is implemented in two separate files: | ||
|
|
||
| 1. `send-anywhere.contract.js` implements the `start` function of the contract to initialize the contract and | ||
| expose `publicFacet` and `creatorFacet`. |
There was a problem hiding this comment.
There's only this mention about this contract's creatorFacet and nothing else on the page. We should add a line or two about it.
There was a problem hiding this comment.
Removing mention of creatorFacet altogether for now.
| 1. `Assets Transfer Contract`: A guide to `send-anywhere` contract that demonstrates a simple yet robust and secure way for cross-chain assets transfer. | ||
| 2. `Swap Contract`: A comprehensive guide to the process of swapping assets between different chains using the Agoric orchestration library. | ||
| 3. `Unbond Contract`: A detailed walkthrough of the unbonding and liquid staking process, highlighting the steps involved in managing cross-chain operations. | ||
| 4. `Orchestration Basics Contract`: A dApp template serving as an introduction to the foundational concepts and implementation details of orchestration basics within an Agoric dApp. |
There was a problem hiding this comment.
These were filenames before so code-blocking them made sense. We can probably just bolden the names now.
|
|
||
| The Agoric Dapp Orchestration Basics walkthrough (currently under development) will provide an introduction to the core concepts and basic implementation of orchestrtion within an Agoric dApp. This guide aims to: | ||
| DApp Orchestration Basics walkthrough will provide an introduction to the implementation level details of orchestration within an Agoric dApp. This guide aims to: |
There was a problem hiding this comment.
I don't think it currently shows what we say here that it shows. But that's a discussion/modification for a different PR.
There was a problem hiding this comment.
Removing it from here (and from nav/config) since we are moving it from example contracts to UP a level anyway in another PR after we have something to say about it.
amessbee
force-pushed
the
ms/walkthrough-sendAnywhere
branch
from
f093f9d to
146b47b
Compare
send-anywhereOrchestration Contract Walkthrough docs are added.Refs: