Skip to content

Commit

Permalink
Fix typos (#243)
Browse files Browse the repository at this point in the history
* fix typo

* fix typos

* fix typos

* fix typo

* fix typo

* fix typo

* fix typo
  • Loading branch information
omahs authored Mar 18, 2024
1 parent c8ac20b commit 6c2131c
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<h2 align="center">Osmosis Docs</h3>

<p align="center">
Osmosis' documentation portal, built with Docusaurus and inspired bye <a href="https://github.com/dyte-in/docs">Dyte's </a> configuration and template.
Osmosis' documentation portal, built with Docusaurus and inspired by <a href="https://github.com/dyte-in/docs">Dyte's </a> configuration and template.
<br />
<a href="https://docs.osmosis.zone"><strong>Explore the docs »</strong></a>
<br />
Expand Down
24 changes: 12 additions & 12 deletions docs/beaker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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<Response> {
// perform state update or anything neccessary for the migration
// perform state update or anything necessary for the migration
Ok(Response::default())
}
```
Expand Down Expand Up @@ -266,15 +266,15 @@ 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
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
Expand Down Expand Up @@ -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.

Expand All @@ -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 `<project-name>-sdk` which can be used by any node / js / ts project.
With this a package is available in `ts/sdk` with name `<project-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.

Expand Down Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/osmosis-outpost/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
[here](../../contact).
4 changes: 2 additions & 2 deletions docs/osmosis-outpost/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
> `blockchain` automatically.
4 changes: 2 additions & 2 deletions docs/osmosis-outpost/user-guide/how-to-do-a-swap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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")
![Swap the tokens image](/img/user-guide/how-to-do-a-swap/swap-tokens.jpg "swap the tokens")
4 changes: 2 additions & 2 deletions docs/osmosis-outpost/user-guide/recover-funds.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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")
![Recover the tokens image](/img/user-guide/recover-funds/recover.jpg "recover the funds")
6 changes: 3 additions & 3 deletions docs/telescope/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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`:

Expand Down

0 comments on commit 6c2131c

Please sign in to comment.