Skip to content

Commit

Permalink
docs: add README to orchestration/src/examples (#9960)
Browse files Browse the repository at this point in the history
closes: #9962
refs: #XXXX

## Description

Adds a readme with concise description of each example contract under `packages/orchestration/src/examples`

### Security Considerations


### Scaling Considerations


### Documentation Considerations


### Testing Considerations


### Upgrade Considerations
  • Loading branch information
mergify[bot] authored Aug 30, 2024
2 parents 3386e64 + 04eba20 commit c56c51e
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions packages/orchestration/src/examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Examples

This directory contains sample contracts showcasing the Orchestration API. Each example demonstrates specific functionalities:

- **basic-flows.contract.js**: Account creation and query sending
- **sendAnywhere.contract.js**: Token sending across supported blockchains
- **auto-stake-it.contract.js**: Automatic remote staking of received tokens

## In Progress

The following contracts are a work in progress as they contain bindings that need to be promptly updated.

- **stakeIca.contract.js**: Interchain account creation for remote staking
- **unbondExample.contract.js**: Cross-chain unbonding and liquid staking
- **swapExample.contract.js**: Token swapping and remote staking
- **stakeBld.contract.js**: BLD token staking on Agoric

0 comments on commit c56c51e

Please sign in to comment.