diff --git a/README.md b/README.md index ed40c375d..db4244bab 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

Osmosis Docs

- Osmosis' documentation portal, built with Docusaurus and inspired bye Dyte's configuration and template. + Osmosis' documentation portal, built with Docusaurus and inspired by Dyte's configuration and template.
Explore the docs »
diff --git a/docs/beaker/README.md b/docs/beaker/README.md index 7ff0c869d..0d15ab771 100644 --- a/docs/beaker/README.md +++ b/docs/beaker/README.md @@ -120,14 +120,14 @@ This is our configuration file, you can find more information about it [here](co #### `.beaker` -Last but not least, `.beaker` which is the most unusal part. It contains 2 files: +Last but not least, `.beaker` which is the most unusual part. It contains 2 files: ``` ├── state.json └── state.local.json ``` -These 2 files has similar functionality, which are containing beaker related state such as `address`, `code-id`, `label` for each contract on each network for later use. +These 2 files have similar functionality, which are containing beaker related state such as `address`, `code-id`, `label` for each contract on each network for later use. While `state.json` is there for mainnet and testnet state. `state.local.json` is intended to use locally and _being gitignored_ since its state will not make any sense on other's machine. @@ -144,7 +144,7 @@ cd counter-dapp beaker wasm new counter ``` -Now your new contract will be avaiable on `contracts/counter`. +Now your new contract will be available on `contracts/counter`. If you want to use other contract template, you can change the configuration, for example: @@ -157,7 +157,7 @@ template_repo = "https://github.com/osmosis-labs/cw-tpl-osmosis.git" ### Deploy contract on LocalOsmosis -LocalOsmosis, as it's name suggest, is Osmosis for local development. In the upcoming release, Beaker will have more complete integration with LocalOsmosis, it has to be installed and run separately. +LocalOsmosis, as its name suggest, is Osmosis for local development. In the upcoming release, Beaker will have more complete integration with LocalOsmosis, it has to be installed and run separately. You can install from source by following the instruction at [osmosis-labs/LocalOsmosis](https://github.com/osmosis-labs/LocalOsmosis), or use the official installer and select option 3: @@ -171,7 +171,7 @@ After that, `counter` contract can be deployed (build + store-code + instantiate beaker wasm deploy counter --signer-account test1 --no-wasm-opt --raw '{ "count": 0 }' ``` -What's happending here equivalent to the following command sequence: +What's happening here equivalent to the following command sequence: ```sh # build .wasm file @@ -187,7 +187,7 @@ beaker wasm store-code counter --signer-account test1 --no-wasm-opt # instantiate counter contract # with instantiate msg: '{ "count": 0 }' -beaker wasm instanitate counter --signer-account test1 --raw '{ "count": 0 }' +beaker wasm instantiate counter --signer-account test1 --raw '{ "count": 0 }' ``` The flag `--no-wasm-opt` is skipping [rust-optimizer](https://github.com/CosmWasm/rust-optimizer) for faster development iteration. @@ -234,7 +234,7 @@ use crate::msg::{CountResponse, ExecuteMsg, InstantiateMsg, QueryMsg, MigrateMsg ```rust #[cfg_attr(not(feature = "library"), entry_point)] pub fn migrate(_deps: DepsMut, _env: Env, _msg: MigrateMsg) -> StdResult { - // perform state update or anything neccessary for the migration + // perform state update or anything necessary for the migration Ok(Response::default()) } ``` @@ -266,7 +266,7 @@ With admin as `test1`, only `test1` can upgrade the contract beaker wasm upgrade counter --signer-account test1 --raw '{}' --no-wasm-opt ``` -Similar to `deploy`, `upgrade` is basiaclly running sequences of commands behind the scene: +Similar to `deploy`, `upgrade` is basically running sequences of commands behind the scene: ```sh beaker wasm build --no-wasm-opt @@ -274,7 +274,7 @@ beaker wasm store-code counter --signer-account test1 --no-wasm-opt beaker wasm migrate counter --signer-account test1 --raw '{}' ``` -And, like before, `--no-wasm-opt` only means for developement. For mainnet, use: +And, like before, `--no-wasm-opt` only means for development. For mainnet, use: ```sh beaker wasm upgrade counter --signer-account test1 --raw '{}' --network mainnet @@ -383,7 +383,7 @@ Beaker console is also allowed to deploy contract, so that you don't another ter `.build`, `.storeCode`, `.instantiate` commands are also available and has the same options as Beaker cli command, except that `--no-wasm-opt` are in by default since it is being intended to use in the development phase. -`.help` to see all avaiable commands. +`.help` to see all available commands. Apart from that, in the console, you can access Beaker's state, configuration and sdk from `state`, `conf` and `sdk` variables accordingly. @@ -399,7 +399,7 @@ To generate sdk for contract, run beaker wasm ts-gen counter # replace `counter` with any of contract name ``` -With this a package is avaiable in `ts/sdk` with name `-sdk` which can be used by any node / js / ts project. +With this a package is available in `ts/sdk` with name `-sdk` which can be used by any node / js / ts project. Let's try adding `multiply` method to our contract and see how this works. @@ -483,7 +483,7 @@ await sc.getCount() ### Frontend -Beaker project template also come with frontend template. But in order to interact with it you need: +Beaker project template also comes with frontend template. But in order to interact with it you need: - [Keplr installed](https://www.keplr.app/) - [Keplr chain setup for LocalOsmosis](https://github.com/osmosis-labs/LocalOsmosis/tree/main/localKeplr) diff --git a/docs/osmosis-outpost/README.md b/docs/osmosis-outpost/README.md index 3dae9e2ec..6ba0e5573 100644 --- a/docs/osmosis-outpost/README.md +++ b/docs/osmosis-outpost/README.md @@ -36,6 +36,6 @@ Once you have integrated the widget, or created your new platform application, we recommend you create a support channel in your own community for users to troubleshoot issues that users may encounter while using the widget or the app. -If you, our your users, discover any **issues or errors** while using the +If you, or your users, discover any **issues or errors** while using the platform, please *reach us* through the channels available -[here](../../contact). \ No newline at end of file +[here](../../contact). diff --git a/docs/osmosis-outpost/faq.md b/docs/osmosis-outpost/faq.md index 98fb379f2..febc88501 100644 --- a/docs/osmosis-outpost/faq.md +++ b/docs/osmosis-outpost/faq.md @@ -49,10 +49,10 @@ The data provided through the assetlist are realized to be consumed by an For this reason, according to how an outpost is designed, you need to ensure that all the tokens you are listing, are able to be swapped on Osmosis and -recevied from and sent to the `outpost chain`. +received from and sent to the `outpost chain`. To do this, you need to list only the tokens who can reach your blockchain. > E.g., if you are constructing the `Juno outpost` and `Stride blockchain` does > not have configured the Packet Forward Middleware (PFM), you cannot list stride > on your outpost, since you cannot receive your stride tokens back to the `Juno` -> `blockchain` automatically. \ No newline at end of file +> `blockchain` automatically. diff --git a/docs/osmosis-outpost/user-guide/how-to-do-a-swap.md b/docs/osmosis-outpost/user-guide/how-to-do-a-swap.md index 6536b3a61..b21b11c05 100644 --- a/docs/osmosis-outpost/user-guide/how-to-do-a-swap.md +++ b/docs/osmosis-outpost/user-guide/how-to-do-a-swap.md @@ -8,7 +8,7 @@ description: How to perform a swap. ### 1. Connect a wallet -To **swap tokens**, the fist step is to connect the wallet containing such +To **swap tokens**, the first step is to connect the wallet containing such tokens to the dApp. To do this, you can *click* on one of the two "connect wallet" buttons available on the page (one on the bottom right, the other on the bottom center). Once the wallet is connected to the dApp, you can see the @@ -55,4 +55,4 @@ you need to wait for the whole process to be completed (*transactions* *broadcasted* to the networks and *smart contract executed*) and... then you're done! -![Swap the tokens image](/img/user-guide/how-to-do-a-swap/swap-tokens.jpg "swap the tokens") \ No newline at end of file +![Swap the tokens image](/img/user-guide/how-to-do-a-swap/swap-tokens.jpg "swap the tokens") diff --git a/docs/osmosis-outpost/user-guide/recover-funds.md b/docs/osmosis-outpost/user-guide/recover-funds.md index f58d9a8ee..b78c9ba4d 100644 --- a/docs/osmosis-outpost/user-guide/recover-funds.md +++ b/docs/osmosis-outpost/user-guide/recover-funds.md @@ -6,7 +6,7 @@ description: How to recover funds if the swap fails. # How to recover funds -Even if the user interface allow to swap tokens with a very low effort, the +Even if the user interface allows to swap tokens with a very low effort, the swap process involves *several steps and actors*, like **IBC transactions**, **smart contract executions**. In such a context, it is reasonable that some steps could fail. Obviously, even if any of the steps fail, the funds are not @@ -32,4 +32,4 @@ From this page, you can complete the recovery request by clicking on the need to wait for the whole process to be completed (*transactions broadcasted* to the networks and *smart contract executed*) and... then you're done! -![Recover the tokens image](/img/user-guide/recover-funds/recover.jpg "recover the funds") \ No newline at end of file +![Recover the tokens image](/img/user-guide/recover-funds/recover.jpg "recover the funds") diff --git a/docs/telescope/README.md b/docs/telescope/README.md index 0f2834f85..8440d6307 100644 --- a/docs/telescope/README.md +++ b/docs/telescope/README.md @@ -128,7 +128,7 @@ To create the Typescript files, run the `transpile` command. telescope transpile ``` -You should now seem some `.ts` files generated in `./src`. These are the real source files used in your application. +You should now see some `.ts` files generated in `./src`. These are the real source files used in your application. ### Build @@ -139,10 +139,10 @@ yarn install yarn buidl ``` -Now you should have code inside of your `./src` folder, ready for publshing via `npm publish`. Or, if you used the defaults, you can start developing and your code can be imported from `./src/codegen`; +Now you should have code inside of your `./src` folder, ready for publishing via `npm publish`. Or, if you used the defaults, you can start developing and your code can be imported from `./src/codegen`; # Usage -## Programatic Usage +## Programmatic Usage First add telescope to your `devDependencies`: