Skip to content

Commit a47cbd2

Browse files
authored
style(docs): improve formatting and whitespace in documentation (#1345)
1 parent 6f25c15 commit a47cbd2

File tree

4 files changed

+26
-30
lines changed

4 files changed

+26
-30
lines changed

src/content/docs/dev/general-message-passing/sui/gmp-example.mdx

+15-14
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,20 @@ It takes four parameters.
6060
1. `payload`: A `vector<u8>` representation of the cross-chain message being sent.
6161

6262
```move
63-
public fun prepare_message(
64-
channel: &Channel,
65-
destination_chain: String,
66-
destination_address: String,
67-
payload: vector<u8>,
68-
): MessageTicket {
69-
message_ticket::new(
70-
channel.to_address(),
71-
destination_chain,
72-
destination_address,
73-
payload,
74-
VERSION,
75-
)
76-
}
63+
public fun prepare_message(
64+
channel: &Channel,
65+
destination_chain: String,
66+
destination_address: String,
67+
payload: vector<u8>,
68+
): MessageTicket {
69+
message_ticket::new(
70+
channel.to_address(),
71+
destination_chain,
72+
destination_address,
73+
payload,
74+
VERSION,
75+
)
76+
}
7777
```
7878

7979
### Receive Message
@@ -123,6 +123,7 @@ The executable function will pass in the [ApprovedMessage](#approvedmessage) tha
123123

124124
```move
125125
public fun execute(call: ApprovedMessage, singleton: &mut Singleton) {
126+
126127
let (_, _, _, payload) = singleton.channel.consume_approved_message(call);
127128
128129
event::emit(Executed { data: payload });

src/content/docs/dev/send-tokens/interchain-tokens/developer-guides/link-custom-tokens-deployed-across-multiple-chains-into-interchain-tokens.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -522,7 +522,7 @@ async function getTokenManagerAddress() {
522522
signer,
523523
);
524524

525-
// Get the interchainTokenFactory contract instance
525+
// Get the interchainTokenFactory contract instance
526526
const interchainTokenFactoryContract = await getContractInstance(
527527
interchainTokenFactoryContractAddress,
528528
interchainTokenFactoryContractABI,
@@ -815,4 +815,4 @@ For further examples utilizing the Interchain Token Service, check out the follo
815815

816816
- [Interchain Token Service Documentation](/dev/send-tokens/interchain-tokens/intro/)
817817
- [Interchain Tokens GitHub Repository](https://github.com/axelarnetwork/interchain-token-service/tree/main)
818-
- [AxelarJS SDK](https://github.com/axelar-network/axelarjs-sdk)
818+
- [AxelarJS SDK](https://github.com/axelarnetwork/axelarjs-sdk)

src/content/docs/dev/send-tokens/interchain-tokens/developer-guides/programmatically-create-a-canonical-token.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -494,4 +494,4 @@ For further examples utilizing the Interchain Token Service, check out the follo
494494

495495
- [Interchain Token Service Documentation](/dev/send-tokens/interchain-tokens/intro/)
496496
- [Interchain Tokens GitHub Repository](https://github.com/axelarnetwork/interchain-token-service/tree/main)
497-
- [AxelarJS SDK](https://github.com/axelar-network/axelarjs-sdk)
497+
- [AxelarJS SDK](https://github.com/axelarnetwork/axelarjs-sdk)

src/content/docs/dev/send-tokens/interchain-tokens/developer-guides/programmatically-create-a-token.mdx

+8-13
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ PRIVATE_KEY= // Add your account private key here
7373
```
7474

7575
<aside>
76-
💡 If you will push this project on GitHub, create a `.gitignore` file and include `.env`.
76+
💡 If you will push this project on GitHub, create a `.gitignore` file and
77+
include `.env`.
7778
</aside>
7879

7980
Then, create a file with the name `hardhat.config.js` and add the following code snippet:
@@ -301,7 +302,7 @@ async function gasEstimator() {
301302
EvmChain.AVALANCHE,
302303
GasToken.ETH,
303304
700000,
304-
1.1
305+
1.1,
305306
);
306307

307308
return gas;
@@ -319,14 +320,13 @@ Create a `deployToRemoteChain()` function that will perform token remote deploym
319320

320321
// Deploy to remote chain: Avalanche Fuji
321322
async function deployToRemoteChain() {
322-
323323
// Get a signer for authorizing transactions
324324
const signer = await getSigner();
325325
// Get contract for remote deployment
326326
const interchainTokenFactoryContract = await getContractInstance(
327327
interchainTokenFactoryContractAddress,
328328
interchainTokenFactoryContractABI,
329-
signer
329+
signer,
330330
);
331331

332332
// Estimate gas fees
@@ -339,12 +339,7 @@ async function deployToRemoteChain() {
339339
// Initiate transaction
340340
const txn = await interchainTokenFactoryContract[
341341
"deployRemoteInterchainToken(bytes32,string,uint256)"
342-
](
343-
salt,
344-
"Avalanche",
345-
gasAmount,
346-
{ value: gasAmount }
347-
);
342+
](salt, "Avalanche", gasAmount, { value: gasAmount });
348343

349344
console.log(`Transaction Hash: ${txn.hash}`);
350345
}
@@ -410,7 +405,7 @@ async function transferTokens() {
410405
const interchainToken = await getContractInstance(
411406
"0x5dcDf836212CAc43dacb81af07fF84D805422f6c", // Update with new token address
412407
interchainTokenContractABI, // Interchain Token contract ABI
413-
signer
408+
signer,
414409
);
415410

416411
// Calculate gas amount
@@ -422,7 +417,7 @@ async function transferTokens() {
422417
"0x510e5EA32386B7C48C4DEEAC80e86859b5e2416C", // Update with your own wallet address
423418
ethers.utils.parseEther("25"), // Transfer 25 tokens
424419
"0x", // Empty data payload
425-
{ value: gasAmount } // Transaction options
420+
{ value: gasAmount }, // Transaction options
426421
);
427422
console.log("Transfer Transaction Hash:", transfer.hash);
428423
}
@@ -497,4 +492,4 @@ For further examples utilizing the Interchain Token Service, check out the follo
497492

498493
- [Interchain Token Service Documentation](/dev/send-tokens/interchain-tokens/intro/)
499494
- [Interchain Tokens GitHub Repository](https://github.com/axelarnetwork/interchain-token-service/tree/main)
500-
- [AxelarJS SDK](https://github.com/axelar-network/axelarjs-sdk)
495+
- [AxelarJS SDK](https://github.com/axelarnetwork/axelarjs-sdk)

0 commit comments

Comments
 (0)