Skip to content

Commit

Permalink
docs: fix typos (#476)
Browse files Browse the repository at this point in the history
* Update env-variable.md

* Update cw-multi-test.md

* fix osmosis-test-tube.md

* Update daemon.md
  • Loading branch information
cratiu222 authored Aug 21, 2024
1 parent d84ddc8 commit 4f5ac21
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/src/contracts/env-variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Maximum block time. This is used internally by `cw-orch` when broadcasting trans
Optional, accepted values: `true`, `false`
Defaults to `true`

By default, `cw-orch` verifies that the account has sufficient balance to pay for gas fees. If it detects that the balance is too low, it propmts the user to fill up their wallet with gas tokens and allows for retrying at the press of a button.
By default, `cw-orch` verifies that the account has sufficient balance to pay for gas fees. If it detects that the balance is too low, it prompts the user to fill up their wallet with gas tokens and allows for retrying at the press of a button.

If set to `false`, it won't check the user has enough balance before broadcasting transactions.

Expand Down Expand Up @@ -126,4 +126,4 @@ Optional, accepted values: `false`, `true`

Defaults to `true`

By default if the logs are not enabled, `cw-orch` wil print a warning message to invite users to activate the logging capabilities of cw-orch. if equals to `false`, the warning message is disabled.
By default if the logs are not enabled, `cw-orch` will print a warning message to invite users to activate the logging capabilities of cw-orch. if equals to `false`, the warning message is disabled.
2 changes: 1 addition & 1 deletion docs/src/integrations/cw-multi-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The underlying `cw_multi_test::App` object is however not clonable.

## Bech32

When testing your smart contracts, you may need to use valid bech32 addresses instead of arbitrary strings. Notably Bech32 addresses are a requirment whenever `instantiate2` is used in your codebase. Therefore `cw-orch` allows this behavior using the `MockBech32` struct. This structure has the same features as the above described `Mock` with the following differences:
When testing your smart contracts, you may need to use valid bech32 addresses instead of arbitrary strings. Notably Bech32 addresses are a requirement whenever `instantiate2` is used in your codebase. Therefore `cw-orch` allows this behavior using the `MockBech32` struct. This structure has the same features as the above described `Mock` with the following differences:

- The constructor now takes the bech32 prefix instead of the sender. Under the hood, the environment creates an address that will be used as the default sender for actions executed on that environment:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/integrations/osmosis-test-tube.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can then use the resulting `OsmosisTestTube` variable to interact with your

When executing contracts in an `osmosis_test_tube` environment, the messages and sub-messages sent along the Response of an endpoint, will be executed as well. This environment mimics the actual on-chain execution by dispatching the messages inside the actual chain binaries.

> This environment uses wasm files compiled from the project. Therefore, you need to compile the WASM artifacts from the project for your osmosis-test-tube integration tests. You will need to have the `wasm` function fom the `Uploadable`trait implemented . [See the dedicated page for more details](../contracts/interfaces.md#creating-an-interface).
> This environment uses wasm files compiled from the project. Therefore, you need to compile the WASM artifacts from the project for your osmosis-test-tube integration tests. You will need to have the `wasm` function from the `Uploadable`trait implemented . [See the dedicated page for more details](../contracts/interfaces.md#creating-an-interface).
## Cloning

Expand Down
2 changes: 1 addition & 1 deletion docs/src/interchain/integrations/daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Starship will most likely crash after at most 1 day of usage. Don't forget to `m
All interchain environments are centered around the `await_single_packet` function. In the Daemon case (be it for testing or for scripting), this function is responsible for tracking the relayer interactions associated with the packet lifetime. The lifetime steps of this function are:
1. <span style="color:purple">⬤</span> On the `source chain`, identify the packet and the destination chain. If the destination chain id is not registered in the `interchain` environment, it will error. Please make sure all the chains your are trying to inspect are included in the environment.
1. <span style="color:purple">⬤</span> On the `source chain`, identify the packet and the destination chain. If the destination chain id is not registered in the `interchain` environment, it will error. Please make sure all the chains you are trying to inspect are included in the environment.
2. Then, it follows the timeline of a packet. A packet can either timeout or be transmitted successfully. The function concurrently does the following steps. If one step returns successfully, the other step will be aborted (as a packet can only have one outcome).
a. Successful cycle:
1. <span style="color:red">⬤</span> On the `destination chain`, it looks for the receive transaction of that packet. The function logs the transaction hash as well as the acknowledgement when the receive transaction is found.
Expand Down

0 comments on commit 4f5ac21

Please sign in to comment.