Martinh/cctp tutorial #71

martin0995 · 2024-09-12T13:53:58Z

Description

CCTP tutorial page.

Checklist

Required - I have added a label to this PR 🏷️
Required - I have run my changes through Grammarly
If pages have been moved, I have created redirects in the wormhole-mkdocs repo

eshaben

Nice job! Left some comments that sort of attempt to make the steps throughout the guide a little bit more concise and also a recommendation to try out different formats to see if maybe using a different format will improve readability. I'll leave that to you to test out and see what works best 🙂

.snippets/code/tutorials/messaging/cctp/snippet-1.ts

tutorials/messaging/.pages

tutorials/messaging/cctp.md

Co-authored-by: Erin Shaben <[email protected]>

…oundation/wormhole-docs into martinh/cctp-tutorial merged with remote commit

Co-authored-by: Erin Shaben <[email protected]>

…oundation/wormhole-docs into martinh/cctp-tutorial merged remote commit

Co-authored-by: Erin Shaben <[email protected]>

…oundation/wormhole-docs into martinh/cctp-tutorial merged with remote commits

eshaben

Nice! I have not tested the actual code. @ilariae would you mind reviewing and testing this please?

eshaben · 2024-09-20T17:09:08Z

tutorials/messaging/cctp.md

+Before you begin, ensure you have the following:
+
+ - [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm){target=\_blank} installed on your machine
+ - [USDC tokens](https://faucet.circle.com/){target=\_blank} on supported chains


I'd add the specific testnet chains that this tutorial uses here. So they know what tokens to get to follow along with the tutorial

" - USDC tokens{target=_blank} on supported chains. This tutorial uses X"

eshaben · 2024-09-27T00:58:58Z

tutorials/messaging/cctp.md

+
+Before initiating a cross-chain transfer, you must set up the chain context and signers for both the source and destination chains.
+
+1. **Initialize the Wormhole SDK** - initialize the `wormhole` function for the `Testnet` environment, and we specify the platforms (EVM and Solana) we want to support. This allows us to interact with both EVM-compatible chains like Avalanche and non-EVM chains like Solana if needed


Suggested change

1. **Initialize the Wormhole SDK** - initialize the `wormhole` function for the `Testnet` environment, and we specify the platforms (EVM and Solana) we want to support. This allows us to interact with both EVM-compatible chains like Avalanche and non-EVM chains like Solana if needed

1. **Initialize the Wormhole SDK** - initialize the `wormhole` function for the `Testnet` environment and specify the platforms (EVM and Solana) to support. This allows us to interact with both EVM-compatible chains like Avalanche and non-EVM chains like Solana if needed

eshaben · 2024-09-27T00:59:12Z

tutorials/messaging/cctp.md

+    !!! note
+        You can replace `'Testnet'` with `'Mainnet'` if you want to perform transfers on MainNet.
+
+2. **Set up source and destination chains** - we specify the source chain (Avalanche) and the destination chain (Solana) using the `getChain` method. This allows us to define where to send the USDC and where to receive them


Suggested change

2. **Set up source and destination chains** - we specify the source chain (Avalanche) and the destination chain (Solana) using the `getChain` method. This allows us to define where to send the USDC and where to receive them

2. **Set up source and destination chains** - specify the source chain (Avalanche) and the destination chain (Solana) using the `getChain` method. This allows us to define where to send the USDC and where to receive them

eshaben · 2024-09-27T01:00:12Z

tutorials/messaging/cctp.md

+1. **Initialize the Wormhole SDK** - initialize the `wormhole` function for the `Testnet` environment, and we specify the platforms (EVM and Solana) we want to support. This allows us to interact with both EVM-compatible chains like Avalanche and non-EVM chains like Solana if needed
+
+    ```typescript
+    --8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:10:11"


Suggested change

--8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:10:11"

--8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:11:11"

This seems a little weird as the function is never closed with a matching }), so I think it should just be the one line

eshaben · 2024-09-27T01:01:02Z

tutorials/messaging/cctp.md

+    --8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:14:15"
+    ```
+
+3. **Configure the signers** - the `getSigner` function retrieves the signers responsible for signing transactions on the respective chains. This ensures that transactions are correctly authorized on both the source and destination chains


Suggested change

3. **Configure the signers** - the `getSigner` function retrieves the signers responsible for signing transactions on the respective chains. This ensures that transactions are correctly authorized on both the source and destination chains

3. **Configure the signers** - use the `getSigner` function to retrieve the signers responsible for signing transactions on the respective chains. This ensures that transactions are correctly authorized on both the source and destination chains

Can you please actually go through the rest of guide and make these steps like action items? Instead of saying this does this, it should be like do this to achieve this

eshaben · 2024-09-27T01:19:25Z

tutorials/messaging/cctp.md

+
+You will need to provide the below requirements to complete the partial transfer:
+
+- **Transaction ID (`txid`)** - the transaction hash from the source chain where the transfer was initiated


this variable should be txId

eshaben · 2024-09-27T01:19:54Z

tutorials/messaging/cctp.md

+
+You can find the full code for the manual USDC transfer script below:
+
+???- tip "`partial-transfer.ts`"


Please use the code admonition instead for all these expandable elements that show the whole file

eshaben · 2024-09-27T01:22:29Z

tutorials/messaging/cctp.md

+In a manual USDC transfer, you perform each step of the cross-chain transfer process individually. This approach allows for greater control and flexibility over how the transfer is executed, which can be helpful in scenarios where you need to customize certain aspects of the transfer, such as gas management, specific chain selection, or signing transactions manually.
+
+Manual transfers give developers more control over each step, making them useful for custom setups, testing, or when automation isn't available.


Suggested change

In a manual USDC transfer, you perform each step of the cross-chain transfer process individually. This approach allows for greater control and flexibility over how the transfer is executed, which can be helpful in scenarios where you need to customize certain aspects of the transfer, such as gas management, specific chain selection, or signing transactions manually.

Manual transfers give developers more control over each step, making them useful for custom setups, testing, or when automation isn't available.

In a manual USDC transfer, you perform each step of the cross-chain transfer process individually. This approach allows for greater control and flexibility over how the transfer is executed, which can be helpful in scenarios where you need to customize certain aspects of the transfer, such as gas management, specific chain selection, or signing transactions manually.

I felt like that line was a bit repetitive of the previous para

eshaben · 2024-09-27T01:23:02Z

tutorials/messaging/cctp.md

+
+Manual transfers give developers more control over each step, making them useful for custom setups, testing, or when automation isn't available.
+
+This section will guide you through performing a manual USDC transfer across chains using the Wormhole SDK and Circle’s Cross-Chain Transfer Protocol (CCTP).


Suggested change

This section will guide you through performing a manual USDC transfer across chains using the Wormhole SDK and Circle’s Cross-Chain Transfer Protocol (CCTP).

This section will guide you through performing a manual USDC transfer across chains using the Wormhole SDK and Circle’s CCTP.

eshaben · 2024-09-27T01:23:31Z

tutorials/messaging/cctp.md

+
+## Conclusion
+
+In this tutorial, you’ve gained hands-on experience with Circle’s Cross-Chain Transfer Protocol (CCTP) and the Wormhole SDK. You’ve learned to perform manual and automatic USDC transfers across multiple chains and recover partial transfers if needed.


Suggested change

In this tutorial, you’ve gained hands-on experience with Circle’s Cross-Chain Transfer Protocol (CCTP) and the Wormhole SDK. You’ve learned to perform manual and automatic USDC transfers across multiple chains and recover partial transfers if needed.

In this tutorial, you’ve gained hands-on experience with Circle’s CCTP and the Wormhole SDK. You’ve learned to perform manual and automatic USDC transfers across multiple chains and recover partial transfers if needed.

No need to keep spelling out CCTP after doing it the first time

eshaben

Also, can you please add a card to the index page for the Tutorials > Messaging section? Just noticed this was missing. I created a ticket in Jira and assigned it to you to add the other missing one for the token transfers tutorial

martin0995 added 10 commits September 5, 2024 11:06

added snippet and main page structure

9cb2ec3

added helpers file

0792f66

added main snippets for cctp

2f2ae26

finished automatic cctp transfers

79faffe

updated amount from snippet

bac224b

updated amount from snippet

ec1c8ac

created snippet for partial transfers

2ee2434

updated page title

88e8913

grammarly check and partial transfer content

6b7f5ec

updated page description

f6ce866

martin0995 added the A0 - New Content Pull request contains new content pages label Sep 12, 2024

martin0995 requested review from eshaben and dawnkelly09 September 12, 2024 13:53

added resources section

45634bd

eshaben reviewed Sep 17, 2024

View reviewed changes

martin0995 and others added 15 commits September 18, 2024 13:03

updated snippet names accordingly

09be304

updated snippet comments with right steps

96b21a6

aligned snippet steps with tutorial

36edd16

updated page title

741e9b0

updated introduction

8abf25a

updated core concepts section based on feedback

a0ffde4

updated supported chains subsection

6d1c6f9

Update tutorials/messaging/cctp.md

99f98d8

Co-authored-by: Erin Shaben <[email protected]>

Merge branch 'martinh/cctp-tutorial' of https://github.com/wormhole-f…

f0994ff

…oundation/wormhole-docs into martinh/cctp-tutorial merged with remote commit

Update tutorials/messaging/cctp.md

7687c3f

Co-authored-by: Erin Shaben <[email protected]>

updated snippet names with correct order

208facd

colon consistency

446d7d5

Merge branch 'martinh/cctp-tutorial' of https://github.com/wormhole-f…

92190b5

…oundation/wormhole-docs into martinh/cctp-tutorial merged remote commit

Update tutorials/messaging/cctp.md

a0c11ea

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

03b1f1c

Co-authored-by: Erin Shaben <[email protected]>

martin0995 and others added 15 commits September 18, 2024 14:59

Update tutorials/messaging/cctp.md

ee469d8

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

32eea86

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

5ff9020

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

c7a2a4d

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

e2858d4

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

7109dcb

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

acc04fd

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

c1299af

Co-authored-by: Erin Shaben <[email protected]>

Update tutorials/messaging/cctp.md

64aff36

Co-authored-by: Erin Shaben <[email protected]>

Merge branch 'martinh/cctp-tutorial' of https://github.com/wormhole-f…

cf146fd

…oundation/wormhole-docs into martinh/cctp-tutorial merged with remote commits

updated steps for consistency

6101207

updated manual transfer introduction as well as subtitles

e8ba3aa

updated code based on feedback

cfb5ea7

updated titles and subtitles organization

54edaeb

grammarly check

4c07511

martin0995 requested a review from eshaben September 18, 2024 15:26

eshaben requested a review from ilariae September 27, 2024 00:46

eshaben reviewed Sep 27, 2024

View reviewed changes

eshaben reviewed Oct 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Martinh/cctp tutorial #71

Martinh/cctp tutorial #71

martin0995 commented Sep 12, 2024

eshaben left a comment

eshaben left a comment

eshaben Sep 20, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben Sep 27, 2024

eshaben left a comment


		Before initiating a cross-chain transfer, you must set up the chain context and signers for both the source and destination chains.

		1. Initialize the Wormhole SDK - initialize the `wormhole` function for the `Testnet` environment, and we specify the platforms (EVM and Solana) we want to support. This allows us to interact with both EVM-compatible chains like Avalanche and non-EVM chains like Solana if needed

	2. Set up source and destination chains - we specify the source chain (Avalanche) and the destination chain (Solana) using the `getChain` method. This allows us to define where to send the USDC and where to receive them
	2. Set up source and destination chains - specify the source chain (Avalanche) and the destination chain (Solana) using the `getChain` method. This allows us to define where to send the USDC and where to receive them

	--8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:10:11"
	--8<-- "code/tutorials/messaging/cctp/cctp-sdk-2.ts:11:11"

	3. Configure the signers - the `getSigner` function retrieves the signers responsible for signing transactions on the respective chains. This ensures that transactions are correctly authorized on both the source and destination chains
	3. Configure the signers - use the `getSigner` function to retrieve the signers responsible for signing transactions on the respective chains. This ensures that transactions are correctly authorized on both the source and destination chains


		You will need to provide the below requirements to complete the partial transfer:

		- Transaction ID (`txid`) - the transaction hash from the source chain where the transfer was initiated


		You can find the full code for the manual USDC transfer script below:

		???- tip "`partial-transfer.ts`"

		In a manual USDC transfer, you perform each step of the cross-chain transfer process individually. This approach allows for greater control and flexibility over how the transfer is executed, which can be helpful in scenarios where you need to customize certain aspects of the transfer, such as gas management, specific chain selection, or signing transactions manually.

		Manual transfers give developers more control over each step, making them useful for custom setups, testing, or when automation isn't available.


		Manual transfers give developers more control over each step, making them useful for custom setups, testing, or when automation isn't available.

		This section will guide you through performing a manual USDC transfer across chains using the Wormhole SDK and Circle’s Cross-Chain Transfer Protocol (CCTP).


		## Conclusion

		In this tutorial, you’ve gained hands-on experience with Circle’s Cross-Chain Transfer Protocol (CCTP) and the Wormhole SDK. You’ve learned to perform manual and automatic USDC transfers across multiple chains and recover partial transfers if needed.

Martinh/cctp tutorial #71

Are you sure you want to change the base?

Martinh/cctp tutorial #71

Conversation

martin0995 commented Sep 12, 2024

Description

Checklist

eshaben left a comment

Choose a reason for hiding this comment

eshaben left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eshaben left a comment

Choose a reason for hiding this comment