Skip to content

Commit

Permalink
Merge pull request #618 from nnsW3/docs-fix-spelling-issues
Browse files Browse the repository at this point in the history
Docs fix spelling issues
  • Loading branch information
chipshort authored Jan 23, 2025
2 parents 48c8c17 + 5c9a38c commit 5145e17
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ library that can be used via FFI. It is compiled like this:
# Run unit tests
(cd libwasmvm && cargo test)

# Create release build for your current system. Uses whatever default Rust
# Create a release build for your current system. Uses whatever default Rust
# version you have installed.
make build-libwasmvm

Expand Down Expand Up @@ -107,11 +107,11 @@ go build -tags "nolink_libwasmvm"
See [COMPILER_VERSIONS.md](docs/COMPILER_VERSIONS.md) for information on Go and
Rust compiler support.

The Rust implementation of the VM is compiled to a library called libwasmvm.
The Rust implementation of the VM is compiled into a library called libwasmvm.
This is then linked to the Go code when the final binary is built. For that
reason not all systems supported by Go are supported by this project.

Linux (tested on Ubuntu, Debian, Alpine) and macOS is supported. We are working
Linux (tested on Ubuntu, Debian, Alpine) and macOS are supported. We are working
on Windows support with very low priority (#288).

[#288]: https://github.com/CosmWasm/wasmvm/pull/288
Expand Down
6 changes: 3 additions & 3 deletions docs/COMPILER_VERSIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Go version here has the following goals:
versions reasonably wide to avoid unnecessary friction for users. I.e. just
because Cosmos SDK now uses Go 1.19 does not mean we make 1.19 the minimal
supported version here. However, the project should work with the latest
stable Go version. When the majority of our users is between 1.18 and 1.19, we
stable Go version. When the majority of our users are between 1.18 and 1.19, we
can slowly remove 1.17 support by bumping the min version to 1.18.
- Be stable enough to test Go code. We always pin the patch version to ensure CI
runs are reproducible. Those versions will contain security issues from time
Expand All @@ -31,10 +31,10 @@ Go version locations:
## Rust

In contrast to Go, the Rust compiler used here produces actual artifacts used
directly by consumer projects. This are the shared .dylib, .so, .dll libraries
directly by consumer projects. These are the shared .dylib, .so, .dll libraries
as well as the static .a libraries. Those libwasmvm builds contain all the Rust
code executing contracts, especially cosmwasm-vm. New Rust versions usually add
features which are not necessarily used or needed. But we should move with the
features that are not necessarily used or needed. But we should move with the
ecosystem to keep the dependency tree compiling. Also new Rust versions tend to
increase runtime speed through optimizer improvements, which never hurts.

Expand Down
2 changes: 1 addition & 1 deletion docs/MIGRATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- `QueryRequest.Grpc` was added. It is similar to `QueryRequest.Stargate` but
unlike that, it should always return protobuf encoded responses on all chains.
- `VM.StoreCode` now returns a `uint64` containing the gas cost in CosmWasm gas
and takes a gas limit as argument. This was previously calculated in wasmd.
and takes a gas limit as an argument. This was previously calculated in wasmd.
The change brings consistency with the other functions that cause gas usage.
- `GoAPI` now requires an additional `ValidateAddress` function that validates
whether the given string is a valid address. This was previously done
Expand Down

0 comments on commit 5145e17

Please sign in to comment.