diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c54767c6..e13fb78c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Thanks for taking the time to improve stellar-cli! The following is a set of guidelines for contributions and may change over time. -Feel free to suggest improvements to this document in a pull request.We want to make it as easy as possible to contribute changes that help the Stellar network grow and +Feel free to suggest improvements to this document in a pull request. We want to make it as easy as possible to contribute changes that help the Stellar network grow and thrive. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly. @@ -20,7 +20,7 @@ There are 2 ways to begin developing stellar-cli: ### Installing all required dependencies -You may want to install all required dependencies locally. This includes installing `rustup`, `make`, `libudev`, `jq` from your package manager. After all dependencies are installed, you can start with running `make install` to build `stellar-cli` and install it! +You may want to install all required dependencies locally. This includes installing `rustup`, `make`, `libudev`, `jq` from your package manager. After all dependencies are installed, you can start by running `make install` to build `stellar-cli` and install it! ### Using `nix` @@ -36,7 +36,7 @@ You can add extra configuration in your `local.sh` file (for example, if you wan #!/usr/bin/env bash export STELLAR_NETWORK=testnet ``` -Note that all of dependencies and configurations mentioned above is available only in your local development shell, not outside of it. +Note that all of the dependencies and configurations mentioned above are available only in your local development shell, not outside of it. ### Minor Changes diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index a755ef18a..1b520b21f 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -343,7 +343,7 @@ To view the commands that will be executed, without executing them, use the --pr If provided, wasm files can be found in the cargo target directory, and the specified directory. - If ommitted, wasm files are written only to the cargo target directory. + If omitted, wasm files are written only to the cargo target directory. * `--print-commands-only` — Print commands to build without executing them * `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) @@ -559,7 +559,7 @@ Outputs no data when no data is present in the contract. Output the metadata stored in a contract. -A contract's meta is a series of key-value pairs that the contract developer can set with any values to provided metadata about the contract. The meta also contains some information like the version of Rust SDK, and Rust compiler version. +A contract's meta is a series of key-value pairs that the contract developer can set with any values to provide metadata about the contract. The meta also contains some information like the version of Rust SDK, and Rust compiler version. The data outputted by this command is a stream of `SCMetaEntry` XDR values. See the type definitions in [stellar-xdr](https://github.com/stellar/stellar-xdr). [See also XDR data format](https://developers.stellar.org/docs/learn/encyclopedia/data-format/xdr). @@ -599,7 +599,7 @@ Outputs no data when no data is present in the contract. Output the env required metadata stored in a contract. -Env-meta is information stored in all contracts, in the `contractenvmetav0` WASM custom section, about the environment that the contract was built for. Env-meta allows the Soroban Env to know whether the contract is compatibility with the network in its current configuration. +Env-meta is information stored in all contracts, in the `contractenvmetav0` WASM custom section, about the environment that the contract was built for. Env-meta allows the Soroban Env to know whether the contract is compatible with the network in its current configuration. The data outputted by this command is a stream of `SCEnvMetaEntry` XDR values. See the type definitions in [stellar-xdr](https://github.com/stellar/stellar-xdr). [See also XDR data format](https://developers.stellar.org/docs/learn/encyclopedia/data-format/xdr). @@ -940,7 +940,7 @@ Create and manage identities including keys and addresses * `ls` — List identities * `rm` — Remove an identity * `show` — Given an identity return its private key -* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it +* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting an environment variable, while reusing this value in all commands that require it @@ -1084,7 +1084,7 @@ Given an identity return its private key ## `stellar keys use` -Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it +Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting an environment variable, while reusing this value in all commands that require it **Usage:** `stellar keys use [OPTIONS] ` @@ -1112,7 +1112,7 @@ Configure connection to networks * `ls` — List networks * `start` — ⚠️ Deprecated: use `stellar container start` instead * `stop` — ⚠️ Deprecated: use `stellar container stop` instead -* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting an environment variable, while reusing this value in all commands that require it * `container` — ⚠️ Deprecated: use `stellar container` instead @@ -1224,7 +1224,7 @@ Stop a network started with `network start`. For example, if you ran `stellar ne ## `stellar network use` -Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +Set the default network that will be used on all commands. This allows you to skip `--network` or setting an environment variable, while reusing this value in all commands that require it **Usage:** `stellar network use [OPTIONS] ` diff --git a/cmd/crates/soroban-test/README.md b/cmd/crates/soroban-test/README.md index c5fdefc3c..3da4f8d2f 100644 --- a/cmd/crates/soroban-test/README.md +++ b/cmd/crates/soroban-test/README.md @@ -53,7 +53,7 @@ fn invoke() { } ``` -Itegration tests in Crate -============== +Integration tests in Crate +========================== -Currently all tests that require an RPC server are hidden behind a `it` feature, [found here](./tests/it/integration). To allow Rust-Analyzer to see the tests in vscode, `.vscode/settings.json`. Without RA, you can't follow through definitions and more importantly see errors before running tests tests. \ No newline at end of file +Currently all tests that require an RPC server are hidden behind a `it` feature, [found here](./tests/it/integration). To allow Rust-Analyzer to see the tests in vscode, `.vscode/settings.json`. Without RA, you can't follow through definitions and more importantly see errors before running tests. diff --git a/cmd/soroban-cli/src/commands/keys/mod.rs b/cmd/soroban-cli/src/commands/keys/mod.rs index 8729ee9af..2f274dd33 100644 --- a/cmd/soroban-cli/src/commands/keys/mod.rs +++ b/cmd/soroban-cli/src/commands/keys/mod.rs @@ -34,7 +34,7 @@ pub enum Cmd { Show(show::Cmd), /// Set the default identity that will be used on all commands. - /// This allows you to skip `--source-account` or setting a environment + /// This allows you to skip `--source-account` or setting an environment /// variable, while reusing this value in all commands that require it. #[command(name = "use")] Default(default::Cmd), diff --git a/cmd/soroban-cli/src/commands/network/mod.rs b/cmd/soroban-cli/src/commands/network/mod.rs index 5cc2acc43..553914c35 100644 --- a/cmd/soroban-cli/src/commands/network/mod.rs +++ b/cmd/soroban-cli/src/commands/network/mod.rs @@ -39,7 +39,7 @@ pub enum Cmd { Stop(crate::commands::container::StopCmd), /// Set the default network that will be used on all commands. - /// This allows you to skip `--network` or setting a environment variable, + /// This allows you to skip `--network` or setting an environment variable, /// while reusing this value in all commands that require it. #[command(name = "use")] Default(default::Cmd), @@ -89,8 +89,8 @@ pub enum Error { FailedToParseJSON(String, serde_json::Error), #[error("Invalid URL {0}")] InvalidUrl(String), - #[error("Inproper response {0}")] - InproperResponse(String), + #[error("Improper response {0}")] + ImproperResponse(String), } impl Cmd { diff --git a/cookbook/deploy-stellar-asset-contract.mdx b/cookbook/deploy-stellar-asset-contract.mdx index 8fca51c48..9c76fb4ed 100644 --- a/cookbook/deploy-stellar-asset-contract.mdx +++ b/cookbook/deploy-stellar-asset-contract.mdx @@ -21,7 +21,7 @@ stellar contract asset deploy \ --asset USDC:GCYEIQEWOCTTSA72VPZ6LYIZIK4W4KNGJR72UADIXUXG45VDFRVCQTYE ``` -The `asset` argument corresponds to the symbol and it's issuer address, which is how assets are identified on Stellar. +The `asset` argument corresponds to the symbol and its issuer address, which is how assets are identified on Stellar. The same can be done for the native [Lumens] asset: