Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: several typos in the docs #158

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/quick-start/standard-relayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Some implementation details should be considered during development to ensure sa

# Off Chain

If taking advantage of Automatic Relaying, no off chain logic need be implemented.
If taking advantage of Automatic Relaying, no off chain logic needs be implemented.

While no off chain programs are required, a developer may want to track the progress of messages in flight. To track the progress of messages in flight, use the worm CLI tool's `status` subcommand.

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api-docs/swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ Find VAA metadata by ID.
#### GET
##### Description

Returns all VAAs. Output is paginated and can also be be sorted.
Returns all VAAs. Output is paginated and can also be sorted.

##### Parameters

Expand Down Expand Up @@ -691,7 +691,7 @@ Returns all the VAAs generated in specific blockchain.
#### GET
##### Description

Returns all all the VAAs generated by a specific emitter address.
Returns all the VAAs generated by a specific emitter address.

##### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/components/core-contracts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Core Contract

The Core Contracts are the mechanism by which all Wormhole messages are emitted. All cross chain applications either interact directly with the Core Contract or interact with another contract that does. There is one Core Contract on each blockchain in the ecosystem, and this is the contract which the Guardians are required to observe. The Core Contract is the contract that ultimately emits the messages the [Guardians](./guardian.md) pick up as an [Observation](../glossary.md#observation).
The Core Contracts are the mechanism by which all Wormhole messages are emitted. All cross chain applications either interact directly with the Core Contract or interact with another contract that does. There is one Core Contract on each blockchain in the ecosystem, and this is the contract that the Guardians are required to observe. The Core Contract is the contract that ultimately emits the messages the [Guardians](./guardian.md) pick up as an [Observation](../glossary.md#observation).

In general, Core Contracts are simple and can be broken down to a **sending** and **receiving** side, which we'll define next.

Expand Down Expand Up @@ -98,4 +98,4 @@ While the [Core Contract](#core-contract) has no specific receiver by default, t

The NFT Bridge functions similarly to the [Token Bridge](#token-bridge) but with special rules for what may be transferred and how the wrapped version is created on the destination chain.

<!-- TODO: more -->
<!-- TODO: more -->
4 changes: 2 additions & 2 deletions docs/reference/components/gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In addition to facilitating asset transfers, _Wormhole Gateway_ (FKA `wormchain

Wormhole Gateway is implemented as a set of contracts and modules.

The contract addreses for these components are:
The contract addresses for these components are:

| Contract | Mainnet Address | Testnet Address |
| -------- | ------- |---------|
Expand All @@ -26,7 +26,7 @@ The contract addreses for these components are:

### Wormhole Core Contracts

The [core contracts](../core-contracts.md) to emit messages and verify [Guardian](../guardian.md) signatures are still required on each Cosmos chain that requires generic message passing. Notably, for Gateway token bridging, no core contracts need be deployed.
The [core contracts](../core-contracts.md) to emit messages and verify [Guardian](../guardian.md) signatures are still required on each Cosmos chain that requires generic message passing. Notably, for Gateway token bridging, no core contracts need to be deployed.

### IBC Shim Contract

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/environments/sui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The options for [consistencyLevel](../../components/core-contracts.md#consistenc
|-----|-----|
|Finalized|0|

This field is may be ignored since the chain provides instant finality.
This field may be ignored since the chain provides instant finality.


For more information see [https://docs.sui.io/learn/architecture/consensus](https://docs.sui.io/learn/architecture/consensus)
Expand Down Expand Up @@ -80,4 +80,4 @@ For more information see [https://docs.sui.io/learn/architecture/consensus](http
|NFT Bridge|**N/A**|


<!--SUI_CHAIN_DETAILS-->
<!--SUI_CHAIN_DETAILS-->
2 changes: 1 addition & 1 deletion docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The contract that calls the Wormhole Core contract. It's address is included in

## Finality

The Finality of a transaction is dependant on the blockchain properties. After a transaction is considered final, it can be assumed the state changes it caused won't be rolled back.
The Finality of a transaction is dependent on the blockchain properties. After a transaction is considered final, it can be assumed the state changes it caused won't be rolled back.

## Gateway

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/sdk-docs/connect-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Each platform can be installed separately so that dependencies can stay as minim

### Chain Context

The `Wormhole` class provides a `getChain` method that returns a `ChainContext` object for a given chain. This object provides access to the chain specific methods and utilities. Much of the functionality in the `ChainContext` is provided by the `Platform` methods but the specific chain may have overriden methods.
The `Wormhole` class provides a `getChain` method that returns a `ChainContext` object for a given chain. This object provides access to the chain specific methods and utilities. Much of the functionality in the `ChainContext` is provided by the `Platform` methods but the specific chain may have overridden methods.

The ChainContext object is also responsible for holding a cached rpc client and protocol clients.

Expand Down Expand Up @@ -236,7 +236,7 @@ Supported protocols are defined in the [definitions module](https://github.com/w

### Signers

In order to sign transactions, an object that fulfils the `Signer` interface is required. This is a simple interface that can be implemented by wrapping a web wallet or other signing mechanism.
In order to sign transactions, an object that fulfills the `Signer` interface is required. This is a simple interface that can be implemented by wrapping a web wallet or other signing mechanism.

```ts
// A Signer is an interface that must be provided to certain methods
Expand Down Expand Up @@ -289,7 +289,7 @@ const receiver: Signer = // ...

Within the Wormhole context, addresses are [normalized](https://docs.wormhole.com/wormhole/blockchain-environments/evm#addresses) to 32 bytes and referred to in this SDK as a `UniversalAddresses`.

Each platform comes with an address type that understands the native address formats, unsuprisingly referred to a NativeAddress. This abstraction allows the SDK to work with addresses in a consistent way regardless of the underlying chain.
Each platform comes with an address type that understands the native address formats, unsurprisingly referred to a NativeAddress. This abstraction allows the SDK to work with addresses in a consistent way regardless of the underlying chain.

```ts
// Convert a string address to its Native address
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/quick-start/hello-wormhole/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The Wormhole Relayer contract lets us do exactly this! Let’s take a look at th
* @param payload arbitrary bytes to pass in as parameter in call to `targetAddress`
* @param receiverValue msg.value that delivery provider should pass in for call to `targetAddress` (in targetChain currency units)
* @param gasLimit gas limit with which to call `targetAddress`.
* @return sequence sequence number of published VAA containing delivery instructions
* @return sequence number of published VAA containing delivery instructions
*/
function sendPayloadToEvm(
uint16 targetChain,
Expand Down