Skip to content

Commit

Permalink
fix: capitalization of MetaMask (#657)
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenFluin authored Dec 11, 2023
1 parent 1be513e commit 3a236a2
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 75 deletions.
77 changes: 40 additions & 37 deletions STYLE-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,61 +6,61 @@ This style guide is inspired by the [Google developer documentation style guide]

## Table of contents

* [Voice and tone](#voice-and-tone)
* [Document structure](#document-structure)
* [Content format](#content-format)
- [Voice and tone](#voice-and-tone)
- [Document structure](#document-structure)
- [Content format](#content-format)

## Voice and tone

* Be friendly, respectful, and not overly pedantic, like you're pair-programming with a friend.
* Refer to [Google's word list](https://developers.google.com/style/word-list) when unsure how to phrase something.
- Be friendly, respectful, and not overly pedantic, like you're pair-programming with a friend.
- Refer to [Google's word list](https://developers.google.com/style/word-list) when unsure how to phrase something.

### When addressing the reader

* Address the reader directly by using the second-person "you."
* Do not use the word "I." When speaking on Axelar's behalf, use "we."
- Address the reader directly by using the second-person "you."
- Do not use the word "I." When speaking on Axelar's behalf, use "we."

| **Recommended** | **Not recommended** |
| --- | --- |
| Hardhat and Foundry are local development platforms. Use Remix if you prefer an online editor. | Hardhat and Foundry are local development platforms. I'd use Remix if I preferred an online editor. |
| We recommend using Metamask for this tutorial. | I recommend using Metamask for this tutorial. |
| **Recommended** | **Not recommended** |
| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| Hardhat and Foundry are local development platforms. Use Remix if you prefer an online editor. | Hardhat and Foundry are local development platforms. I'd use Remix if I preferred an online editor. |
| We recommend using MetaMask for this tutorial. | I recommend using MetaMask for this tutorial. |

### When referring to a third party user or developer

* Use the singular "they" when referring to a third party user or developer.
- Use the singular "they" when referring to a third party user or developer.

| **Recommended** | **Not recommended** |
| --- | --- |
| A user can check their transactions on Axelarscan. | A user can check his or her transactions on Axelarscan. |
| **Recommended** | **Not recommended** |
| -------------------------------------------------- | ------------------------------------------------------- |
| A user can check their transactions on Axelarscan. | A user can check his or her transactions on Axelarscan. |

### Accessibility

* Use "earlier", "preceding", or "following" to refer to the position of a code snippet or UI element in a document rather than "above," "below," or "left-hand side."
- Use "earlier", "preceding", or "following" to refer to the position of a code snippet or UI element in a document rather than "above," "below," or "left-hand side."

| **Recommended** | **Not recommended** |
| --- | --- |
| Start up the Hardhat command-line interface by typing the following command. | Start up the Hardhat command-line interface by typing the command below. |
| Copy the address from the preceding section. | Copy the address from the section above. |
| **Recommended** | **Not recommended** |
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| Start up the Hardhat command-line interface by typing the following command. | Start up the Hardhat command-line interface by typing the command below. |
| Copy the address from the preceding section. | Copy the address from the section above. |

## Document structure

* Avoid a wall of text whenever possible.
* Break a long section up into subsections with the appropriate headings.
* Add screenshots when a UI is not likely to change.
- Avoid a wall of text whenever possible.
- Break a long section up into subsections with the appropriate headings.
- Add screenshots when a UI is not likely to change.

### Code comments

* Comment in the code directly whenever possible.
* Add bullet points directly above or below the code snippet if it makes the code more clear.
- Comment in the code directly whenever possible.
- Add bullet points directly above or below the code snippet if it makes the code more clear.

**Recommended**

`sendToMany` will need to do the following:

* Get the address of a token from its symbol
* Send funds to another address
* Approve the gateway to spend funds
* Encode the recipient addresses on the destination chain to ensure that they are `byte`s, since GMP messages must be of this type
- Get the address of a token from its symbol
- Send funds to another address
- Approve the gateway to spend funds
- Encode the recipient addresses on the destination chain to ensure that they are `byte`s, since GMP messages must be of this type

```solidity
function sendToMany(
Expand Down Expand Up @@ -91,7 +91,7 @@ function sendToMany(
// token. _destinationAddrs is a list that contains
// the addresses of the ERC-2O token's final
// recipients once the transaction has arrived
// at the destination chain.
// at the destination chain.
bytes memory recipientAddressesEncoded = abi.encode(_destinationAddrs);
// Output: a list of addresses in bytes
Expand All @@ -104,11 +104,11 @@ function sendToMany(

```solidity`
function sendToMany(
string memory _destChain,
string memory _destContractAddr,
address[] calldata _destinationAddrs,
string memory _symbol,
uint256 _amount
string memory \_destChain,
string memory \_destContractAddr,
address[] calldata \_destinationAddrs,
string memory \_symbol,
uint256 \_amount
) external payable {

require(msg.value > 0, "Gas payment required");
Expand All @@ -120,7 +120,9 @@ function sendToMany(
IERC20(tokenAddress).approve(address(gateway), _amount);

bytes memory recipientAddressesEncoded = abi.encode(_destinationAddrs);

}

```
### Section headings
Expand All @@ -146,7 +148,7 @@ function sendToMany(
| **Recommended** | **Not recommended** |
| --- | --- |
| In Metamask, go to the **Tokens** tab and click **Import Tokens**. | In Metamask, go to the “Tokens” tab and click “Import Tokens.” |
| In MetaMask, go to the **Tokens** tab and click **Import Tokens**. | In MetaMask, go to the “Tokens” tab and click “Import Tokens.” |
### Italic font
Expand Down Expand Up @@ -199,4 +201,5 @@ Implement the following to send an interchain transaction with Axelar:
* `AxelarExecutable` – This is a contract that handle a message on the destination chain once a transaction has been sent to the Axelar network.
* `IAxelarGateway` – The Axelar Gateway
* `IAxelarGasService` – The Axelar Gas Service
* `IERC20` – This represents the ERC-20 token interface to access ERC-20-related functionality.
* `IERC20` – This represents the ERC-20 token interface to access ERC-20-related functionality.
```
2 changes: 1 addition & 1 deletion src/pages/controller/add-evm-chain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ axelard q evm bytecode avalanche gateway-deployment
Deploy the above bytecode to a smart contract on the EVM chain.

<Callout emoji="💡">
Tip: Deploy the gateway contract however you wish. One option is to use [version 5 of MyEtherWallet](https://v5.myetherwallet.com/) with Metamask as suggested in the video [Onboarding Avalanche to the Axelar Network](https://www.youtube.com/watch?v=iZgqneh7s88).
Tip: Deploy the gateway contract however you wish. One option is to use [version 5 of MyEtherWallet](https://v5.myetherwallet.com/) with MetaMask as suggested in the video [Onboarding Avalanche to the Axelar Network](https://www.youtube.com/watch?v=iZgqneh7s88).
<iframe
width="80%"
height="430"
Expand Down
4 changes: 2 additions & 2 deletions src/pages/dev/axelarjs-sdk/tx-status-query-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ const provider = new ethers.providers.JsonRpcProvider(
);

// Optional
// By default, The sdk uses `window.ethereum` wallet as a sender wallet e.g. Metamask.
// By default, The sdk uses `window.ethereum` wallet as a sender wallet e.g. MetaMask.
// This option allows caller to pass `privateKey` or `provider` to the sdk directly
const senderOptions = { privateKey: "0x", provider };

Expand Down Expand Up @@ -117,7 +117,7 @@ const provider = new ethers.providers.JsonRpcProvider(
);

// Optional
// By default, The sdk uses `window.ethereum` wallet as a sender wallet e.g. Metamask.
// By default, The sdk uses `window.ethereum` wallet as a sender wallet e.g. MetaMask.
// This option allows caller to pass `privateKey` or `provider` to the sdk directly
const senderOptions = { privateKey: "0x", provider };

Expand Down
8 changes: 4 additions & 4 deletions src/pages/learn/cli/axl-from-evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Optional: query your new `{EVM_TEMP_ADDR}`:
axelard q nexus latest-deposit-address {EVM_CHAIN} axelarnet {MY_ADDR}
```

Use Metamask to send some wrapped AXL tokens on `{EVM_CHAIN}` to the new temporary deposit address `{EVM_TEMP_ADDR}`. Save the transaction hash `{EVM_TX_HASH}` for later.
Use MetaMask to send some wrapped AXL tokens on `{EVM_CHAIN}` to the new temporary deposit address `{EVM_TEMP_ADDR}`. Save the transaction hash `{EVM_TX_HASH}` for later.

<Callout type="error" emoji="🔥">
Danger: Send only `Axelar` ERC20 tokens to `{EVM_TEMP_ADDR}`. Any other token sent to `{EVM_TEMP_ADDR}` will be lost.
Expand Down Expand Up @@ -84,10 +84,10 @@ axelard q evm batched-commands {EVM_CHAIN} {BATCH_ID}

Wait for `status: BATCHED_COMMANDS_STATUS_SIGNED` and copy the `execute_data`.

Use Metamask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.
Use MetaMask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.

<Callout type="error" emoji="🔥">
Danger: Post your transaction to the correct chain! Set your Metamask network to `{EVM_CHAIN}`.
Danger: Post your transaction to the correct chain! Set your MetaMask network to `{EVM_CHAIN}`.
</Callout>

<Callout type="warning" emoji="⚠️">
Expand All @@ -111,7 +111,7 @@ axelard q evm gateway-address {EVM_CHAIN}

</Callout>

To send a transaction to `{GATEWAY_ADDR}` using Metamask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)
To send a transaction to `{GATEWAY_ADDR}` using MetaMask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)

Optional: Check your Axelar `my_account` account AXL token balance as per [Basic node management](/node/basic) so that you can observe balance change.

Expand Down
16 changes: 8 additions & 8 deletions src/pages/learn/cli/axl-to-evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Transfer AXL tokens from Axelar to an EVM chain using the terminal.
- You have downloaded the Axelar blockchain and are comfortable with [Basic node management](/node/basic).
- Your Axelar node has an account named `my_account` that you control. Let `{MY_ADDR}` denote the address of your `my_account` account.
- Select an EVM chain `{EVM_CHAIN}` from: Ethereum, Avalanche, Fantom, Moonbeam, Polygon.
- Complete steps from [Metamask for EVM chains](/resources/metamask) to connect your Metamask to `{EVM_CHAIN}`.
- Complete steps from [MetaMask for EVM chains](/resources/metamask) to connect your MetaMask to `{EVM_CHAIN}`.
- You need both AXL tokens and `{EVM_CHAIN}` tokens to pay transaction fees.
- **Testnet:**
- Get some `{EVM_CHAIN}` testnet tokens as per [Metamask for EVM chains](/resources/metamask).
- Get some `{EVM_CHAIN}` testnet tokens as per [MetaMask for EVM chains](/resources/metamask).
- Get some AXL tokens from the Axelar faucets: [testnet](https://faucet.testnet.axelar.dev/).
- **Mainnet:** You are responsible for obtaining your own tokens.
- `{EVM_DEST_ADDR}` is an address controlled by you on the external EVM chain `{EVM_CHAIN}`. (In your Metamask, for example.) This is where your AXL tokens will be sent.
- `{EVM_DEST_ADDR}` is an address controlled by you on the external EVM chain `{EVM_CHAIN}`. (In your MetaMask, for example.) This is where your AXL tokens will be sent.
- `{AMOUNT}` is the amount of AXL tokens you wish to transfer, denominated in `uaxl`. Recall that `1 AXL = 1000000 uaxl`. See [Testnet resources](/resources/testnet) or [Mainnet resources](/resources/mainnet) for minimum transfer amounts.

## Send AXL tokens from Axelar to an EVM chain
Expand Down Expand Up @@ -50,7 +50,7 @@ axelard tx bank send my_account {AXELAR_TEMP_ADDR} {AMOUNT}uaxl --from my_accoun
<Callout emoji="📝">
Note: Third-party monitoring tools will automatically complete the remaining steps of this process.

Wait a few minutes then check your Metamask for the AXL tokens. Don't forget to import the AXL token into Metamask so you can see your balance as described in [Metamask for EVM chains](/resources/metamask).
Wait a few minutes then check your MetaMask for the AXL tokens. Don't forget to import the AXL token into MetaMask so you can see your balance as described in [MetaMask for EVM chains](/resources/metamask).
</Callout>

<Callout type="warning" emoji="⚠️">
Expand Down Expand Up @@ -86,10 +86,10 @@ axelard q evm batched-commands {EVM_CHAIN} {BATCH_ID}

Wait for `status: BATCHED_COMMANDS_STATUS_SIGNED` and copy the `execute_data`.

Use Metamask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.
Use MetaMask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.

<Callout type="error" emoji="🔥">
Danger: Post your transaction to the correct chain! Set your Metamask network to `{EVM_CHAIN}`.
Danger: Post your transaction to the correct chain! Set your MetaMask network to `{EVM_CHAIN}`.
</Callout>

<Callout type="warning" emoji="⚠️">
Expand All @@ -113,8 +113,8 @@ axelard q evm gateway-address {EVM_CHAIN}

</Callout>

To send a transaction to `{GATEWAY_ADDR}` using Metamask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)
To send a transaction to `{GATEWAY_ADDR}` using MetaMask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)

You should see `{AMOUNT}` of asset AXL in your `{EVM_CHAIN}` Metamask account.
You should see `{AMOUNT}` of asset AXL in your `{EVM_CHAIN}` MetaMask account.

Congratulations! You have transferred AXL tokens from Axelar to an external EVM chain!
8 changes: 4 additions & 4 deletions src/pages/learn/cli/ust-from-evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Output should contain
successfully linked {EVM_TEMP_ADDR} and {TERRA_DEST_ADDR}
```

Use Metamask to send some wrapped AXL tokens on `{EVM_CHAIN}` to the new temporary deposit address `{EVM_TEMP_ADDR}`. Save the transaction hash `{EVM_TX_HASH}` for later.
Use MetaMask to send some wrapped AXL tokens on `{EVM_CHAIN}` to the new temporary deposit address `{EVM_TEMP_ADDR}`. Save the transaction hash `{EVM_TX_HASH}` for later.

<Callout type="error" emoji="🔥">
Danger: Send only `Axelar Wrapped UST` ERC20 tokens to `{EVM_TEMP_ADDR}`. Any other token sent to `{EVM_TEMP_ADDR}` will be lost.
Expand Down Expand Up @@ -73,10 +73,10 @@ axelard q evm batched-commands {EVM_CHAIN} {BATCH_ID}

Wait for `status: BATCHED_COMMANDS_STATUS_SIGNED` and copy the `execute_data`.

Use Metamask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.
Use MetaMask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.

<Callout type="error" emoji="🔥">
Danger: Post your transaction to the correct chain! Set your Metamask network to `{EVM_CHAIN}`.
Danger: Post your transaction to the correct chain! Set your MetaMask network to `{EVM_CHAIN}`.
</Callout>

<Callout type="warning" emoji="⚠️">
Expand All @@ -100,7 +100,7 @@ axelard q evm gateway-address {EVM_CHAIN}

</Callout>

To send a transaction to `{GATEWAY_ADDR}` using Metamask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)
To send a transaction to `{GATEWAY_ADDR}` using MetaMask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)

Execute the pending IBC transfer:

Expand Down
10 changes: 5 additions & 5 deletions src/pages/learn/cli/ust-to-evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Wait a few minutes for the IBC relayer to relay your transaction to Axelar.
<Callout emoji="📝">
Note: Third-party monitoring tools will automatically complete the remaining steps of this process.

Wait a few minutes then check your Metamask for the UST tokens. Don't forget to import the UST token into Metamask so you can see your balance as described in [Metamask for EVM chains](/resources/metamask).
Wait a few minutes then check your MetaMask for the UST tokens. Don't forget to import the UST token into MetaMask so you can see your balance as described in [MetaMask for EVM chains](/resources/metamask).
</Callout>

<Callout type="warning" emoji="⚠️">
Expand Down Expand Up @@ -100,10 +100,10 @@ axelard q evm batched-commands {EVM_CHAIN} {BATCH_ID}

Wait for `status: BATCHED_COMMANDS_STATUS_SIGNED` and copy the `execute_data`.

Use Metamask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.
Use MetaMask to send a transaction on `{EVM_CHAIN}` with the `execute_data` to the Axelar gateway contract address `{GATEWAY_ADDR}`.

<Callout type="error" emoji="🔥">
Danger: Post your transaction to the correct chain! Set your Metamask network to `{EVM_CHAIN}`.
Danger: Post your transaction to the correct chain! Set your MetaMask network to `{EVM_CHAIN}`.
</Callout>

<Callout type="warning" emoji="⚠️">
Expand All @@ -127,8 +127,8 @@ axelard q evm gateway-address {EVM_CHAIN}

</Callout>

To send a transaction to `{GATEWAY_ADDR}` using Metamask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)
To send a transaction to `{GATEWAY_ADDR}` using MetaMask: paste hex from `execute_data` above into "Hex Data" field. (Do not send tokens!)

You should see `{AMOUNT}` of asset AXL in your `{EVM_CHAIN}` Metamask account.
You should see `{AMOUNT}` of asset AXL in your `{EVM_CHAIN}` MetaMask account.

Congratulations! You have transferred AXL tokens from Axelar to an external EVM chain!
Loading

1 comment on commit 3a236a2

@vercel
Copy link

@vercel vercel bot commented on 3a236a2 Dec 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.