Skip to content

Commit

Permalink
Merge branch 'main' into CedarMist/712-auth
Browse files Browse the repository at this point in the history
  • Loading branch information
CedarMist authored Oct 10, 2023
2 parents 9158558 + 65402bc commit e9a8410
Show file tree
Hide file tree
Showing 102 changed files with 2,203 additions and 2,801 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@
[submodule "external/adrs"]
path = external/adrs
url = https://github.com/oasisprotocol/adrs
[submodule "external/cli"]
path = external/cli
url = https://github.com/oasisprotocol/cli
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,20 +86,22 @@ link checker in `package.json`._
### Documentation structure

`docs` folder contains markdown files of the documentation. Each subfolder
represents one of the top-level chapter (general, node, dApp, paratime, core
etc.).
represents a documentation **part** (general, node, dApp, paratime, core etc.).
Each markdown file inside a part corresponds to a **chapter** (subchapter for a
markdown file inside a subfolder) and each subtitle of a chapter is called a
**section** (subsection etc.).

Some top-level chapter may contain markdown files or folders hosted and
maintained in other Oasis repositories (e.g. oasis-sdk, oasis-core). In this
case, a complete git submodule for the repository is cloned inside `external`
folder. Then, symbolic links to specific markdown files or folders are added
inside `docs` accordingly.
Some parts may contain markdown files or folders hosted and maintained in other
Oasis repositories (e.g. oasis-sdk, oasis-core). In this case, a complete git
submodule for the repository is cloned inside `external` folder. Then, symbolic
links to specific markdown files or folders are added inside `docs`
accordingly.

While all markdown files inside `docs` are compiled, not all files may be
reachable via sidebars directly. Each top-level chapter defines own
sidebar structure inside their `sidebarChapterName.js` file.

Nouns, adjectives and verbs in section titles should be capitalized.
Nouns, adjectives and verbs in the titles should be capitalized.

### index.md, README.md, overview.md

Expand All @@ -117,7 +119,7 @@ Markdown files hosted by this repository should:
`../howto-use-wallet.md`.
`../../../operators/set-up-your-node.md`

Markdown files hosted by other Oasis repositories should:
Symlinked Markdown files hosted by other Oasis repositories should:

- reference markdown files in the same repository by a relative path e.g.
`../howto-write-contract.md`.
Expand Down
24 changes: 13 additions & 11 deletions docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ import {findSidebarItem} from '@site/src/sidebarUtils';

## Use Oasis

The introductory section contains general overview of the Oasis Network such as
This introductory part contains general overview of the Oasis Network such as
the distinction between the consensus layer and different ParaTimes. It
also covers wallets and other tools for managing your assets across the Oasis
chains and how to use unique Oasis features.

<DocCardList items={[
findSidebarItem('/general/oasis-network/'),
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/general/manage-tokens/cli/'),
]} />

## Create dApp
Expand All @@ -25,7 +26,7 @@ encryption**. The Oasis team also prepared a set of libraries called the
[Oasis Privacy Layer] to **bridge existing dApps running on other chains** to
use the unique Sapphire's confidentiality.

The section also covers other ParaTimes such as the non-confidential
The part also covers other ParaTimes such as the non-confidential
[Oasis Emerald] and Wasm-compatible, confidential [Oasis Cipher].

<DocCardList items={[
Expand Down Expand Up @@ -54,7 +55,7 @@ developers and how to contribute to the network.

## Run Node

If you want to run your own Oasis node, the following section will provide you
If you want to run your own Oasis node, this part will provide you
with guides on the current Mainnet and Testnet network parameters and how to
set up your node, let it be a validator node, perhaps running a ParaTime or
just a simple client node for your server to submit transactions and perform
Expand All @@ -69,22 +70,23 @@ queries on the network.

## Build ParaTimes

Apart from Emerald, Cipher, Sapphire and the Key manager ParaTimes, developers
can learn how to write, compile, sign and deploy their own ParaTimes on the
Oasis Network.
Apart from the Sapphire, Emerald, Cipher and the Key manager ParaTimes,
you can also write, compile, sign and deploy your own ParaTime on the Oasis
Network. This part describes the knobs you need to use to do so.

<DocCard item={findSidebarItem('/paratime/')} />

## Develop Core

Whether you want to contribute your code to the core components of the Oasis
Network or just learn more about the Oasis core, this is the place for you.
Network or just learn more about the Oasis consensus layer and other core
components, this is the part for you.

<DocCard item={ findSidebarItem('/core/') } />

Development of interoperable Oasis network components are made by consensus.
Similar to the Ethereum's ERC/EIP mechanism, Oasis follows Architectural
Decision Records (ADRs) which are first proposed, voted on and can then be
implemented, if accepted.
Additions or changes to the interoperable Oasis network components are always
made with consensus. Similar to the Ethereum's ERC/EIP mechanism Oasis follows
formal Architectural Decision Records (ADRs) which are first proposed, voted on
and finally implemented, if accepted.

<DocCard item={ findSidebarItem('/adrs') } />
5 changes: 5 additions & 0 deletions docs/dapp/diagrams/opl-contract-flow.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
sequenceDiagram
User ->> Home Contract: Transaction
Home Contract -->> SGN: SGN Watches Events
SGN -->> Executor: Waits for SGN Approval
Executor ->> Sapphire Contract: Submit Proof Tx
1 change: 1 addition & 0 deletions docs/dapp/diagrams/opl-contract-flow.mmd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ You can view the available reference data on the [Band Standard Dataset site her

### Bandchain.js {#bandchain}

Band also has a javascript library that makes it easy to interact with BandChain directly from Javascript or Typescript applications. The library provides classes and methods for convenient to send transactions, query data, OBI encoding, and wallet management. You can read more about it [here](https://docs.bandchain.org/client-library/bandchain.js/getting-started.html).
Band also has a JavaScript library that makes it easy to interact with BandChain directly from JavaScript or TypeScript applications. The library provides classes and methods for convenient to send transactions, query data, OBI encoding, and wallet management. You can read more about it [here](https://docs.bandchain.org/develop/developer-tools/bandchain.js/getting-started).

[demooracle-remix]: https://remix.ethereum.org/?#code=cHJhZ21hIHNvbGlkaXR5IDAuNi4xMTsKcHJhZ21hIGV4cGVyaW1lbnRhbCBBQklFbmNvZGVyVjI7CgppbnRlcmZhY2UgSVN0ZFJlZmVyZW5jZSB7CiAgICAvLy8gQSBzdHJ1Y3R1cmUgcmV0dXJuZWQgd2hlbmV2ZXIgc29tZW9uZSByZXF1ZXN0cyBmb3Igc3RhbmRhcmQgcmVmZXJlbmNlIGRhdGEuCiAgICBzdHJ1Y3QgUmVmZXJlbmNlRGF0YSB7CiAgICAgICAgdWludDI1NiByYXRlOyAvLyBiYXNlL3F1b3RlIGV4Y2hhbmdlIHJhdGUsIG11bHRpcGxpZWQgYnkgMWUxOC4KICAgICAgICB1aW50MjU2IGxhc3RVcGRhdGVkQmFzZTsgLy8gVU5JWCBlcG9jaCBvZiB0aGUgbGFzdCB0aW1lIHdoZW4gYmFzZSBwcmljZSBnZXRzIHVwZGF0ZWQuCiAgICAgICAgdWludDI1NiBsYXN0VXBkYXRlZFF1b3RlOyAvLyBVTklYIGVwb2NoIG9mIHRoZSBsYXN0IHRpbWUgd2hlbiBxdW90ZSBwcmljZSBnZXRzIHVwZGF0ZWQuCiAgICB9CgogICAgLy8vIFJldHVybnMgdGhlIHByaWNlIGRhdGEgZm9yIHRoZSBnaXZlbiBiYXNlL3F1b3RlIHBhaXIuIFJldmVydCBpZiBub3QgYXZhaWxhYmxlLgogICAgZnVuY3Rpb24gZ2V0UmVmZXJlbmNlRGF0YShzdHJpbmcgbWVtb3J5IF9iYXNlLCBzdHJpbmcgbWVtb3J5IF9xdW90ZSkKICAgICAgICBleHRlcm5hbAogICAgICAgIHZpZXcKICAgICAgICByZXR1cm5zIChSZWZlcmVuY2VEYXRhIG1lbW9yeSk7CgogICAgLy8vIFNpbWlsYXIgdG8gZ2V0UmVmZXJlbmNlRGF0YSwgYnV0IHdpdGggbXVsdGlwbGUgYmFzZS9xdW90ZSBwYWlycyBhdCBvbmNlLgogICAgZnVuY3Rpb24gZ2V0UmVmZXJlbmNlRGF0YUJ1bGsoc3RyaW5nW10gbWVtb3J5IF9iYXNlcywgc3RyaW5nW10gbWVtb3J5IF9xdW90ZXMpCiAgICAgICAgZXh0ZXJuYWwKICAgICAgICB2aWV3CiAgICAgICAgcmV0dXJucyAoUmVmZXJlbmNlRGF0YVtdIG1lbW9yeSk7Cn0KCmNvbnRyYWN0IERlbW9PcmFjbGUgewogICAgSVN0ZFJlZmVyZW5jZSByZWY7CgogICAgdWludDI1NiBwdWJsaWMgcHJpY2U7CgogICAgY29uc3RydWN0b3IoSVN0ZFJlZmVyZW5jZSBfcmVmKSBwdWJsaWMgewogICAgICAgIHJlZiA9IF9yZWY7CiAgICB9CgogICAgZnVuY3Rpb24gZ2V0UHJpY2UoKSBleHRlcm5hbCB2aWV3IHJldHVybnMgKHVpbnQyNTYpewogICAgICAgIElTdGRSZWZlcmVuY2UuUmVmZXJlbmNlRGF0YSBtZW1vcnkgZGF0YSA9IHJlZi5nZXRSZWZlcmVuY2VEYXRhKCJXQlRDIiwiVVNEIik7CiAgICAgICAgcmV0dXJuIGRhdGEucmF0ZTsKICAgIH0KCiAgICBmdW5jdGlvbiBnZXRNdWx0aVByaWNlcygpIGV4dGVybmFsIHZpZXcgcmV0dXJucyAodWludDI1NltdIG1lbW9yeSl7CiAgICAgICAgc3RyaW5nW10gbWVtb3J5IGJhc2VTeW1ib2xzID0gbmV3IHN0cmluZ1tdKDIpOwogICAgICAgIGJhc2VTeW1ib2xzWzBdID0gIldCVEMiOwogICAgICAgIGJhc2VTeW1ib2xzWzFdID0gIkVUSCI7CgogICAgICAgIHN0cmluZ1tdIG1lbW9yeSBxdW90ZVN5bWJvbHMgPSBuZXcgc3RyaW5nW10oMik7CiAgICAgICAgcXVvdGVTeW1ib2xzWzBdID0gIlVTRCI7CiAgICAgICAgcXVvdGVTeW1ib2xzWzFdID0gIlVTRCI7CiAgICAgICAgSVN0ZFJlZmVyZW5jZS5SZWZlcmVuY2VEYXRhW10gbWVtb3J5IGRhdGEgPSByZWYuZ2V0UmVmZXJlbmNlRGF0YUJ1bGsoYmFzZVN5bWJvbHMscXVvdGVTeW1ib2xzKTsKCiAgICAgICAgdWludDI1NltdIG1lbW9yeSBwcmljZXMgPSBuZXcgdWludDI1NltdKDIpOwogICAgICAgIHByaWNlc1swXSA9IGRhdGFbMF0ucmF0ZTsKICAgICAgICBwcmljZXNbMV0gPSBkYXRhWzFdLnJhdGU7CgogICAgICAgIHJldHVybiBwcmljZXM7CiAgICB9CgogICAgZnVuY3Rpb24gc2F2ZVByaWNlKHN0cmluZyBtZW1vcnkgYmFzZSwgc3RyaW5nIG1lbW9yeSBxdW90ZSkgZXh0ZXJuYWwgewogICAgICAgIElTdGRSZWZlcmVuY2UuUmVmZXJlbmNlRGF0YSBtZW1vcnkgZGF0YSA9IHJlZi5nZXRSZWZlcmVuY2VEYXRhKGJhc2UscXVvdGUpOwogICAgICAgIHByaWNlID0gZGF0YS5yYXRlOwogICAgfQp9Cg==
Loading

0 comments on commit e9a8410

Please sign in to comment.