Skip to content

Commit

Permalink
fix: handle multiple instances of typo (17 files) (#1054)
Browse files Browse the repository at this point in the history
  • Loading branch information
maancham authored Jul 19, 2024
1 parent 58a70a2 commit 2a94006
Show file tree
Hide file tree
Showing 17 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Install the `v0.35.5 axelard` binary. You can either download the pre-built vers

Once you are running `ampd` and `tofnd`, you can onboard a chain to the Amplifier by instantiating the `gateway`, `voting verifier`, and `multisig prover` contracts.

You can either use the existing deployed contracts and on the devnet via their `code_id`s, or build and store these contracts from the `axelar-examples` repo. A `code_id` is a CosmWasm identifier of a stored contract that can be instantiated. **You will need to insantinate the contracts no matter which option you choose.**
You can either use the existing deployed contracts and on the devnet via their `code_id`s, or build and store these contracts from the `axelar-examples` repo. A `code_id` is a CosmWasm identifier of a stored contract that can be instantiated. **You will need to instantiate the contracts no matter which option you choose.**

### Option 1: Use existing deployed contracts

Expand Down
2 changes: 1 addition & 1 deletion src/pages/dev/amplifier/chain-integration/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To connect your chain to the Axelar network via the Interchain Amplifier, you'll
- Most integrators will begin by using or customizing this [Gateway Contract](https://github.com/axelarnetwork/axelar-amplifier/tree/main/contracts/gateway).
- **Prover Contract**
- A smart contract on the Axelar network that knows how to prove the validity of a transaction on your chain.
- Most integrators will begin by usign or customzing the [multisig prover](https://github.com/axelarnetwork/axelar-amplifier/tree/main/contracts/multisig-prover)
- Most integrators will begin by using or customizing the [multisig prover](https://github.com/axelarnetwork/axelar-amplifier/tree/main/contracts/multisig-prover)
- **Message Relayer**
- A service built with any tech stack that listens for events on your chain and relays them to the Axelar network.
- Get started with our [Message Relayer Example](https://github.com/axelarnetwork/axelar-examples/tree/main/examples/amplifier)
Expand Down
2 changes: 1 addition & 1 deletion src/pages/dev/amplifier/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The Amplifier consists of the following, all on the Axelar network:
To connect to the Amplifier, integrators should:

- Implement and deploy a Gateway to the Axelar Network
- Work with verfiers to vote, prove, and attest to message validity
- Work with verifiers to vote, prove, and attest to message validity
- Provide relaying infrastructure to identify incoming messages and act on outgoing messages

## General Message Passing with Amplifier
Expand Down
2 changes: 1 addition & 1 deletion src/pages/dev/cosmos-gmp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ pub fn multi_send_to_evm(

For a Cosmos blockchain to support receiving GMP messages (naively or via CosmWasm), it should implement the appropriate middleware in Go as part of the consensus layer.

If you have CosmWasm on your Cosmos chain and want to be able to receieve and deliver messages, install [Osmosis IBC-hooks](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-hooks).
If you have CosmWasm on your Cosmos chain and want to be able to receive and deliver messages, install [Osmosis IBC-hooks](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-hooks).

If you don’t support CosmWasm on your Cosmos chain, you'll need to implement and install your own Axelar GMP module to receive and execute messages. See our [sample reference implementation](https://github.com/axelarnetwork/evm-cosmos-gmp-sample/tree/main/native-integration/sample-middleware).

Expand Down
2 changes: 1 addition & 1 deletion src/pages/dev/evm-relayer.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EVM Relayer

The Axelar EVM relayer facilitates communication between different EVM-compatible chains on the Axlear network. Both [legacy and EIP-1559 transaction types](https://www.youtube.com/watch?v=MGemhK9t44Q) are supported.
The Axelar EVM relayer facilitates communication between different EVM-compatible chains on the Axelar network. Both [legacy and EIP-1559 transaction types](https://www.youtube.com/watch?v=MGemhK9t44Q) are supported.

Each chain has a relayer queue that receives transaction data. These queues serve as the relayer’s entry point. The Axelar network has multiple instances of the EVM relayer service running in parallel, waiting to pick up and process messages. This way, multiple transactions can be executed simultaneously. The relayer will try to broadcast the payload until it is either included in a block or has hit the maximum number of attempts. If a process unexpectedly stops or gets killed in the middle of a relay, an internal database will recover the payload and the transaction will be re-tried when the process is back up.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/dev/gas-service/refund.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Refund Prepaid Gas

If the gas fees prepaid to `payNativeGasForContractCall()` or `payNativeGasForContractCallWithToken()` exceeds the actual amount needed for relaying a message to the destination contract, the Gas Service will automatically caclculate the excess gas amount and refund it to the payer’s wallet address by calling `refund()` on the [`AxelarGasService` contract](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity/blob/ad37802dc6d62fff3ab589f2605f7a3e566977dd/contracts/interfaces/IAxelarGasService.sol).
If the gas fees prepaid to `payNativeGasForContractCall()` or `payNativeGasForContractCallWithToken()` exceeds the actual amount needed for relaying a message to the destination contract, the Gas Service will automatically calculate the excess gas amount and refund it to the payer’s wallet address by calling `refund()` on the [`AxelarGasService` contract](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity/blob/ad37802dc6d62fff3ab589f2605f7a3e566977dd/contracts/interfaces/IAxelarGasService.sol).

The refunded amount consists of the total amount paid, minus the network base fee, the actual gas used, and the gas costs estimated for transferring the refund. Refunds are made on the source chain.

Expand Down
6 changes: 3 additions & 3 deletions src/pages/dev/general-message-passing/debug/fork-mainnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ forkAndExport();

This will clone `mainnet` by default and export local RPC endpoints at `http:/localhost:8500/n` with `n` staring from `0`.

## Aditional Options
## Additional Options

`forkAndExport` can take an object of type `CloneLocalOptions` that can specify:
- `chainOutputPath`: a path to save a JSON file with all the information for the chains that are set up. Defaults to `./local.json`.
- `accountsToFund`: a list of addresses to fund.
- `fundAmount`: a string representing the amount of ether to fund accounts with. Defaults to `100 ETH`.
- `env`: a `string` whose value is either `mainnet` or `testnet`, or an `array` of `ChainCloneData`. See the repo for details.
- `chains`: now acts as a filter for which chains to fork. Defaults to all the chains.
- `relayInterval`: amount of time between relay of events in miliseconds. Defaults to `2000`.
- `relayInterval`: amount of time between relay of events in milliseconds. Defaults to `2000`.
- `port`: port to listen to. Defaults to `8500`.
- `afterRelay`: a function `(relayData: RelayData) => void` that will be called after each relay. Mainly to be used for debugging.
- `callback`: a function `(network: Network, info: any) => Promise<null>` that will be called right after setting up each network. Use this to set up additional features, like deploying additional contracts or funding accounts.
- `networkInfo`: the `NetworkInfo` which overwrites the default parameters. See the repo for details.

## Usage

After creating the desired fork, you have access to RPCs (look into the JSON file saved) to them. You can update MetaMask (or any other wallet) to these RPCs and access any dApp online, and everything will happen in the local fork instead of the actual network. All Axelar functionality will happen more quickly (`2s` by default), and you can get debigging capabilites via the `afterRelay` option. Make sure you change MetaMask's RPCs back to the endpoints you trust, to go back to using actual mainnet/testnet.
After creating the desired fork, you have access to RPCs (look into the JSON file saved) to them. You can update MetaMask (or any other wallet) to these RPCs and access any dApp online, and everything will happen in the local fork instead of the actual network. All Axelar functionality will happen more quickly (`2s` by default), and you can get debugging capabilities via the `afterRelay` option. Make sure you change MetaMask's RPCs back to the endpoints you trust, to go back to using actual mainnet/testnet.

Forking requires the use of RPCs to the actual networks being forked. For mainnet and testnet some RPCs are provided as part of `axelar-local-dev`, but we cannot guarantee that they will all work in the future. If you want, you can either tweak them in `./node_modules/@axelar-network/axelar-local-dev/info/` or provide an `env` variable that specifies your own RPCs. You can also copy the files in the `info` directory, alter them, load them and pass either of them as the `env` variable.
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ If you see this, it means that your interchain transfer has been successful!

<Callout emoji="💡">
**Note:** If you get the following `nonce too low` error, wait a few minutes
and run `canonincalInterchainToken.js` again. Some chains have a longer
and run `canonicalInterchainToken.js` again. Some chains have a longer
transaction time than others.
</Callout>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ async function registerAndDeploy() {
const symbol = "NIT";
const decimals = 18;

// Intial token supply
// Initial token supply
const initialSupply = ethers.utils.parseEther("1000");

// Get a signer to sign the transaction
Expand Down Expand Up @@ -416,7 +416,7 @@ async function transferTokens() {
// Calculate gas amount
const gasAmount = await gasEstimator();

// Initate transfer via token
// Initiate transfer via token
const transfer = await interchainToken.interchainTransfer(
"Polygon", // Destination chain
"0x510e5EA32386B7C48C4DEEAC80e86859b5e2416C", // Update with your own wallet address
Expand Down
4 changes: 2 additions & 2 deletions src/pages/dev/solidity-utilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { Callout } from '/src/components/callout'

To facilitate interchain development, we have provided some Solidity utilites. These can be found [here](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity). Each of these is described below, along with their proposed use. To further assist with the development process the [Axelar Chain's Config](https://www.npmjs.com/package/@axelar-network/axelar-chains-config) package has been made available to provide easy access to all the relevant Axelar configurations on each blockchain Axelar is available on.
To facilitate interchain development, we have provided some Solidity utilities. These can be found [here](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity). Each of these is described below, along with their proposed use. To further assist with the development process the [Axelar Chain's Config](https://www.npmjs.com/package/@axelar-network/axelar-chains-config) package has been made available to provide easy access to all the relevant Axelar configurations on each blockchain Axelar is available on.

<Callout emoji="📝">
Note: When deploying a contract with this tool, the msg.sender in the constructor of the app's contract will be the deployer contract address and not the wallet address. So msg.sender should not be used for setting the owner etc. when using these. Instead it should be passed in as a constructor arg
Expand Down Expand Up @@ -74,7 +74,7 @@ For those who may be using [Create2 Deployer](https://github.com/axelarnetwork/a

#### Create2Deployer JS

The above can be used directly, but we also provide a script to execute this functionality from a Jasvscript file. Simply import [`create2Deployer.js`](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity/blob/main/scripts/create2Deployer.js). The following methods are exported from from the `create2Deployer.js` file:
The above can be used directly, but we also provide a script to execute this functionality from a JavaScript file. Simply import [`create2Deployer.js`](https://github.com/axelarnetwork/axelar-gmp-sdk-solidity/blob/main/scripts/create2Deployer.js). The following methods are exported from from the `create2Deployer.js` file:

- `async estimateGasForDeploy(contractJson, args = [])`: estimates the gas needed to deploy a contract with a certain `contractJson` and `args`
- `async estimateGasForDeployAndInit(contractJson, args = [], initArgs = [])`: estimates the gas needed to deploy a contract with a certain `contractJson` and `args`, and to have the `init(...initArgs)` called as part of the deployment.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/node/keyring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { Callout } from "/src/components/callout"

Many Axeler CLI commands require an Axelar account controlled by a secret key. Your secret key must be stored securely so as to minimize the risk of exposure to an attacker.
Many Axelar CLI commands require an Axelar account controlled by a secret key. Your secret key must be stored securely so as to minimize the risk of exposure to an attacker.

Like every Cosmos-based network, Axelar nodes store secret keys in a _keyring_. The keyring can be configured with one of several _backend_ implementations. Learn more about keyring backend configuration from the [Cosmos keyring documentation](https://docs.cosmos.network/v0.44/run-node/keyring.html).

Expand Down
6 changes: 3 additions & 3 deletions src/pages/resources/axelarscan/axelarscan-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Include the following parameters:

* Address: The address you are looking to add.
* Name: The name you want to be displayed for your address.
* Image: The image you want to appear alongisde the name.
* Image: The image you want to appear alongside the name.
* Environment: Whether this address is for mainnet or testnet transactions.

## Example
Expand All @@ -33,7 +33,7 @@ export default [
]
```

No `environnment` was set, so this address will appear on both [mainnet](https://axelarscan.io/account/axelar10d07y265gmmuvt4z0w9aw880jnsr700j7v9daj) and [testnet](https://testnet.axelarscan.io/account/axelar10d07y265gmmuvt4z0w9aw880jnsr700j7v9daj).
No `environment` was set, so this address will appear on both [mainnet](https://axelarscan.io/account/axelar10d07y265gmmuvt4z0w9aw880jnsr700j7v9daj) and [testnet](https://testnet.axelarscan.io/account/axelar10d07y265gmmuvt4z0w9aw880jnsr700j7v9daj).

Add the following to include the address on mainnet only:

Expand All @@ -43,7 +43,7 @@ export default [
address: 'axelar10d07y265gmmuvt4z0w9aw880jnsr700j7v9daj',
name: 'Axelar Governance',
image: '/logos/accounts/axelarnet.svg',
environnment: 'mainnet'
environment: 'mainnet'
}
]
```
Expand Down
Loading

0 comments on commit 2a94006

Please sign in to comment.