Jaco GreeffandThibaut Sardan
55fb391465
* Make a start * Intro * Installation * Flatten * Move METHODS_*.md to substrate/*.md * Basics * Apply suggestions from code review Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com> * Substrate links * Create * api.consts * Typo * Typo, ms -> md * types.basics (SIP) * Type basics * api.consts jumps to api.query * Start to api.query * Basic queries * Point starting to actual overview * api.rpc * Derive detour * Query subs & query multi * Apply suggestions from code review Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com> * typo * Query extras * Basic transactions * Misplaced , * keyring WIP * Keyring wrap-up * Subs SIP * tx subs more WIP * tx subs * Small types cleanups * Apply suggested changes from @JoshOrndorff * Clarify naked await * tx wrapping WIP * Wrap api.wrap * TS placeholder * [WIP] markers for not-started * Clarifying comments * Additional clarifications * types.extend... well, extended... * Remove *nix * Warp up TypeScript... it is it (for now) * Some small text clarifications * Some cleanups * Cleanups, typos * keyring cleanups * Cleanups * Wrap * api.wrap wrapped... hopefully * typos * Registration typos * typescript typos, hope I caught most...
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
## Getting started
|
|
|
|
- [Introduction](start/README.md)
|
|
- [Installation](start/install.md)
|
|
- [Basics](start/basics.md)
|
|
- [Creating](start/create.md)
|
|
- [Constant queries](start/api.consts.md)
|
|
- [State queries](start/api.query.md)
|
|
- [RPC queries](start/api.rpc.md)
|
|
- [State subscriptions](start/api.query.subs.md)
|
|
- [Multi state retrieval](start/api.query.multi.md)
|
|
- [State query utilities](start/api.query.other.md)
|
|
- [Transactions](start/api.tx.md)
|
|
- [Keyring](start/keyring.md)
|
|
- [Transaction subscriptions](start/api.tx.subs.md)
|
|
- [Complex transactions](start/api.tx.wrap.md)
|
|
- [Type basics](start/types.basics.md)
|
|
- [Type extension](start/types.extend.md)
|
|
- [TypeScript interfaces](start/typescript.md)
|
|
|
|
## Packages
|
|
|
|
- [api](api/README.md)
|
|
- [ApiPromise](api/classes/_promise_index_.apipromise.md)
|
|
- [ApiRx](api/classes/_rx_index_.apirx.md)
|
|
- [rpc-provider](rpc-provider/README.md)
|
|
- [HttpProvider](rpc-provider/classes/_http_index_.httpprovider.md)
|
|
- [WsProvider](rpc-provider/classes/_ws_index_.wsprovider.md)
|
|
- [types (codec implementation)](types/README.md)
|
|
|
|
## Interfaces
|
|
|
|
- [Substrate](substrate/README.md)
|
|
- [RPC](substrate/rpc.md)
|
|
- [Constants (runtime)](substrate/constants.md)
|
|
- [Chain state (runtime)](substrate/storage.md)
|
|
- [Extrinsics (runtime)](substrate/extrinsics.md)
|
|
- [Events (runtime)](substrate/events.md)
|
|
|
|
## Examples
|
|
|
|
- [ApiPromise](examples/promise/README.md)
|
|
- [Simple connect](examples/promise/01_simple_connect/README.md)
|
|
- [Listen to blocks](examples/promise/02_listen_to_blocks/README.md)
|
|
- [Listen to balance change](examples/promise/03_listen_to_balance_change/README.md)
|
|
- [Unsubscribe from listening](examples/promise/04_unsubscribe/README.md)
|
|
- [Read chain state](examples/promise/05_read_storage/README.md)
|
|
- [Make a transfer](examples/promise/06_make_transfer/README.md)
|
|
- [Display system events](examples/promise/08_system_events/README.md)(
|
|
- [Transaction with events](examples/promise/09_transfer_events/README.md)
|
|
- [Upgrade via sudo](examples/promise/10_upgrade_chain/README.md)
|
|
- [ApiRx](examples/rx/README.md)
|
|
- [Simple connect](examples/rx/01_simple_connect/README.md)
|
|
- [Listen to blocks](examples/rx/02_listen_to_blocks/README.md)
|
|
- [Listen to balance change](examples/rx/03_listen_to_balance_change/README.md)
|
|
- [Unsubscribe from listening](examples/rx/04_unsubscribe/README.md)
|
|
- [Read chain state](examples/rx/05_read_storage/README.md)
|
|
- [Make a transfer](examples/rx/06_make_transfer/README.md)
|
|
- [Display system events](examples/rx/08_system_events/README.md)(
|
|
- [Transaction with events](examples/rx/09_transfer_events/README.md)
|
|
- [Upgrade via sudo](examples/rx/10_upgrade_chain/README.md)
|