From 4c34ba3eea3441eb55d92ea6e1f88b12007c948a Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:03:33 +0100 Subject: [PATCH 1/9] Create README.md --- .../quick-start/create-to-earn/README.md | 109 ++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 docs/tutorials/quick-start/create-to-earn/README.md diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md new file mode 100644 index 00000000..9aed81a9 --- /dev/null +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -0,0 +1,109 @@ + +# Wormhole Tutorial Program ๐Ÿช + +Congratulations to all participants of the Encode x Wormhole Hackathon 2024! ๐ŸŽ‰ + +Your incredible projects and dedication have truly impressed us. As a token of appreciation and to encourage knowledge sharing within our community, we're excited to introduce the **Wormhole Blockchain Tutorial Program**. + +## Earn Additional Prizes! ๐Ÿ’ธ + +Weโ€™re offering a chance for you to earn more rewards by turning your hackathon projects into tutorials: + +- **Tutorial Submission Reward**: Receive **$50** for each accepted tutorial. +- **Maximum Tutorials Accepted**: Up to **5 tutorials** per hackathon, totaling **$250** in additional prizes up for grabs! + +## How to Submit Your Tutorial + +To participate, please follow these guidelines to ensure your tutorial is clear, complete, and helpful to others. + +### 1. **Tutorial Content** + +Your tutorial should include the following sections: + +- **Introduction**: Briefly describe your project from the specific Hackathon and its main objectives. +- **Setup Instructions**: Provide detailed steps to set up the project environment, including any dependencies. +- **Code Walkthrough**: Offer a clear explanation of key parts of your code. +- **Usage**: Instructions on how to use the project, including example commands or inputs. +- **Testing Locally**: Steps for running local tests and expected outcomes. +- **Deployment**: Instructions for deploying the project to a testnet or mainnet, if applicable. +- **Testing on Testnet**: How to test the deployed project on a testnet. +- **Additional Resources**: Links to relevant documentation, libraries, or tools used in your project. + +### 2. **Format and Submission** + +- **Format**: Submit your tutorial in Markdown format (.md). Ensure clarity and proper organization with headings and subheadings. +- **Repository**: Fork the [Wormhole Docs Repository](https://github.com/wormhole-foundation/docs.wormhole.com/tree/main)) and add your tutorial as a new file in the `tutorials/quick-start` folder. +- **Naming Convention**: Name your file in the format `project-name-tutorial.md`. For example, if your project is named "CrossChainApp," name your file `crosschainapp-tutorial.md`. +- **Pull Request**: Create a Pull Request (PR) with your tutorial. In the PR description, include a brief summary of the tutorial and mention the hackathon it was developed at. + +### 3. **Example Tutorial** + +Hereโ€™s a brief example of how to structure your tutorial: + +#### HelloToken + +This tutorial demonstrates a Solidity contract that can be deployed on various EVM chains to create a cross-chain application. Users can request token transfers from one contract to an address on a different chain. + +**Example Project**: Cross-Chain Token Transfer Dapp. Project developed during the Encode x Wormhole Hackathon 2024. + +**Summary**: +Included in this repository are: +- Example Solidity Code +- Example Forge local testing setup +- Testnet Deploy Scripts +- Example Testnet testing setup + +**Environment Setup**: +- Node 16.14.1 or later, npm 8.5.0 or later: [Install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- Forge 0.2.0 or later: [Install Forge](https://book.getfoundry.sh/getting-started/installation) + +**Testing Locally**: +Clone the repository, navigate to it, build, and run unit tests: +```bash +git clone https://github.com/wormhole-foundation/hello-token.git +cd hello-token +npm run build +forge test +``` +Expected output: +``` +Running 1 test for test/HelloToken.t.sol:HelloTokenTest +[PASS] testCrossChainDeposit() (gas: 1338038) +Test result: ok. 1 passed; 0 failed; finished in 5.64s +``` + +**Deploying to Testnet**: +Ensure you have a wallet with at least 0.05 Testnet AVAX and 0.01 Testnet CELO. Obtain these tokens from the respective testnet faucets. + +```bash +EVM_PRIVATE_KEY=your_wallet_private_key npm run deploy +``` + +**Testing on Testnet**: +Ensure you have a wallet with at least 0.02 Testnet AVAX. Also, ensure contracts are deployed on the testnet as described above. + +To test sending and receiving a message on testnet: +```bash +EVM_PRIVATE_KEY=your_wallet_private_key npm run test +``` + +**Getting Started**: +Write a HelloToken contract that lets users send tokens to an address on another chain. Use the Wormhole TokenBridge for cross-chain transfers. + +For detailed implementation, see the example provided in the `hello-token` repository. + +### 4. **Review Process** ๐Ÿ“ + +- **Evaluation**: Tutorials will be reviewed for completeness, accuracy, and clarity. +- **Notification**: You will be notified upon acceptance or if further revisions are needed. +- **Payment**: Accepted tutorials will be rewarded with $50, and payments will be processed within 30 days. + +### 5. **Additional Notes** + +- Ensure your content is original and you have the rights to share any included code or resources. +- For any questions or assistance, please open an issue in this repository or contact us at [support@wormholeblockchain.org](mailto:support@wormholeblockchain.org). + +Thank you for your contributions and for helping to expand the Wormhole Blockchain community. We look forward to your tutorials! + + +### **Please adjust the prize amount, total acceptable tutorials and payment timeline as decided. Thank you wormhole Team ๐Ÿš€** From 3794f1bc0f7ac1347b52ad4af6e7f8a33b99d007 Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:04:26 +0100 Subject: [PATCH 2/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index 9aed81a9..5041193e 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -1,9 +1,9 @@ # Wormhole Tutorial Program ๐Ÿช -Congratulations to all participants of the Encode x Wormhole Hackathon 2024! ๐ŸŽ‰ +Congratulations to all our dear Hackathon participants ๐ŸŽ‰ -Your incredible projects and dedication have truly impressed us. As a token of appreciation and to encourage knowledge sharing within our community, we're excited to introduce the **Wormhole Blockchain Tutorial Program**. +Your incredible projects and dedication have truly impressed us. As a token of appreciation and to encourage knowledge sharing within our community, we're excited to introduce the **Wormhole Tutorial Program**. ## Earn Additional Prizes! ๐Ÿ’ธ From dcc9a89bcc4f2bda7ff6a70aa116957cf5d29255 Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:06:18 +0100 Subject: [PATCH 3/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index 5041193e..a8c48b3f 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -1,11 +1,11 @@ -# Wormhole Tutorial Program ๐Ÿช +# ๐Ÿช Wormhole Tutorial Program Congratulations to all our dear Hackathon participants ๐ŸŽ‰ Your incredible projects and dedication have truly impressed us. As a token of appreciation and to encourage knowledge sharing within our community, we're excited to introduce the **Wormhole Tutorial Program**. -## Earn Additional Prizes! ๐Ÿ’ธ +## ๐Ÿ’ธ Earn Additional Prizes! Weโ€™re offering a chance for you to earn more rewards by turning your hackathon projects into tutorials: @@ -32,7 +32,7 @@ Your tutorial should include the following sections: ### 2. **Format and Submission** - **Format**: Submit your tutorial in Markdown format (.md). Ensure clarity and proper organization with headings and subheadings. -- **Repository**: Fork the [Wormhole Docs Repository](https://github.com/wormhole-foundation/docs.wormhole.com/tree/main)) and add your tutorial as a new file in the `tutorials/quick-start` folder. +- **Repository**: Fork the [Wormhole Docs Repository](https://github.com/wormhole-foundation/docs.wormhole.com/tree/main) and add your tutorial as a new file in the `tutorials/quick-start` folder. - **Naming Convention**: Name your file in the format `project-name-tutorial.md`. For example, if your project is named "CrossChainApp," name your file `crosschainapp-tutorial.md`. - **Pull Request**: Create a Pull Request (PR) with your tutorial. In the PR description, include a brief summary of the tutorial and mention the hackathon it was developed at. From ab37f2f7a882cd83f5e4c6b2e7b0973e41399bd6 Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:07:54 +0100 Subject: [PATCH 4/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index a8c48b3f..7b782c33 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -9,8 +9,8 @@ Your incredible projects and dedication have truly impressed us. As a token of a Weโ€™re offering a chance for you to earn more rewards by turning your hackathon projects into tutorials: -- **Tutorial Submission Reward**: Receive **$50** for each accepted tutorial. -- **Maximum Tutorials Accepted**: Up to **5 tutorials** per hackathon, totaling **$250** in additional prizes up for grabs! +- **Tutorial Submission Reward**: Submit a tutorial based on your hackathon project and earn **$50** for each accepted tutorial. +- **Maximum Tutorials Accepted**: To ensure high-quality content, we will accept up to 5 tutorials per hackathon. This means a total of **$250** in additional prizes for each hackathon. ## How to Submit Your Tutorial From 2938127320597dc25ddc00e88efa2eedd0a5e7e1 Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:09:08 +0100 Subject: [PATCH 5/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index 7b782c33..4b7afe99 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -10,7 +10,7 @@ Your incredible projects and dedication have truly impressed us. As a token of a Weโ€™re offering a chance for you to earn more rewards by turning your hackathon projects into tutorials: - **Tutorial Submission Reward**: Submit a tutorial based on your hackathon project and earn **$50** for each accepted tutorial. -- **Maximum Tutorials Accepted**: To ensure high-quality content, we will accept up to 5 tutorials per hackathon. This means a total of **$250** in additional prizes for each hackathon. +- **Maximum Tutorials Accepted**: To ensure high-quality content, we will accept up to 5 tutorials per hackathon. This means a total of **$250** in additional prizes up for grabs! ๐ŸŽฏ ## How to Submit Your Tutorial From fef3cb77430e190b3290aa645344a749292ab78a Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:15:00 +0100 Subject: [PATCH 6/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index 4b7afe99..bcab63b5 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -105,5 +105,12 @@ For detailed implementation, see the example provided in the `hello-token` repos Thank you for your contributions and for helping to expand the Wormhole Blockchain community. We look forward to your tutorials! +--- -### **Please adjust the prize amount, total acceptable tutorials and payment timeline as decided. Thank you wormhole Team ๐Ÿš€** +#### Conclusion + +In closing, I want to highlight that the prize amounts, total number of acceptable tutorials, and payment timelines mentioned are hypothetical and open for adjustment based on Wormholeโ€™s discretion. + +This approach ensures that tutorials remain current with the latest hackathons and developments, providing new developers with a rich array of up-to-date examples. This not only fosters a vibrant community but also accelerates learning and innovation within the Wormhole ecosystem. + +Thank you for considering this suggestion and for your ongoing support in enhancing the developer experience with Wormhole! ๐Ÿš€ From 4ac8931aa4a5b964534fb135a59a2344d483c147 Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:20:25 +0100 Subject: [PATCH 7/9] Update README.md --- .../quick-start/create-to-earn/README.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index bcab63b5..d20be7f6 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -1,4 +1,14 @@ +#### Disclaimer + +Please note that the prize amounts, total number of acceptable tutorials, and payment timelines mentioned are hypothetical and subject to adjustment based on Wormholeโ€™s discretion. + +This approach ensures that tutorials remain current with the latest hackathons and developments, providing new developers with a rich array of up-to-date examples. This not only fosters a vibrant community but also accelerates learning and innovation within the Wormhole ecosystem. + +Thank you for considering this suggestion and for your ongoing support in enhancing the developer experience with Wormhole! ๐Ÿš€ + +--- + # ๐Ÿช Wormhole Tutorial Program Congratulations to all our dear Hackathon participants ๐ŸŽ‰ @@ -38,13 +48,11 @@ Your tutorial should include the following sections: ### 3. **Example Tutorial** -Hereโ€™s a brief example of how to structure your tutorial: +Hereโ€™s a detailed example of how to structure your tutorial: #### HelloToken -This tutorial demonstrates a Solidity contract that can be deployed on various EVM chains to create a cross-chain application. Users can request token transfers from one contract to an address on a different chain. - -**Example Project**: Cross-Chain Token Transfer Dapp. Project developed during the Encode x Wormhole Hackathon 2024. +This tutorial demonstrates how to build a Solidity contract that enables cross-chain token transfers using Wormhole. This example is based on a project developed during the Encode x Wormhole Hackathon 2024. **Summary**: Included in this repository are: @@ -54,8 +62,8 @@ Included in this repository are: - Example Testnet testing setup **Environment Setup**: -- Node 16.14.1 or later, npm 8.5.0 or later: [Install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) -- Forge 0.2.0 or later: [Install Forge](https://book.getfoundry.sh/getting-started/installation) +- **Node.js**: 16.14.1 or later, npm 8.5.0 or later. [Install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- **Forge**: 0.2.0 or later. [Install Forge](https://book.getfoundry.sh/getting-started/installation) **Testing Locally**: Clone the repository, navigate to it, build, and run unit tests: @@ -88,9 +96,9 @@ EVM_PRIVATE_KEY=your_wallet_private_key npm run test ``` **Getting Started**: -Write a HelloToken contract that lets users send tokens to an address on another chain. Use the Wormhole TokenBridge for cross-chain transfers. +Write a HelloToken contract that allows users to send tokens to an address on another chain. Use the Wormhole TokenBridge for cross-chain transfers. -For detailed implementation, see the example provided in the `hello-token` repository. +For detailed implementation, refer to the example provided in the `hello-token` repository. ### 4. **Review Process** ๐Ÿ“ @@ -106,11 +114,3 @@ For detailed implementation, see the example provided in the `hello-token` repos Thank you for your contributions and for helping to expand the Wormhole Blockchain community. We look forward to your tutorials! --- - -#### Conclusion - -In closing, I want to highlight that the prize amounts, total number of acceptable tutorials, and payment timelines mentioned are hypothetical and open for adjustment based on Wormholeโ€™s discretion. - -This approach ensures that tutorials remain current with the latest hackathons and developments, providing new developers with a rich array of up-to-date examples. This not only fosters a vibrant community but also accelerates learning and innovation within the Wormhole ecosystem. - -Thank you for considering this suggestion and for your ongoing support in enhancing the developer experience with Wormhole! ๐Ÿš€ From f5b975470584d822157b56bd3f537125c0343fdd Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:23:01 +0100 Subject: [PATCH 8/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index d20be7f6..d2351a95 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -1,14 +1,13 @@ #### Disclaimer -Please note that the prize amounts, total number of acceptable tutorials, and payment timelines mentioned are hypothetical and subject to adjustment based on Wormholeโ€™s discretion. +Prize amounts, tutorials accepted and payment timelines are hypothetical and may be adjusted by Wormhole. This process keeps tutorials up-to-date with the latest hackathons and helps new developers access a range of current examples, fostering community growth and innovation. -This approach ensures that tutorials remain current with the latest hackathons and developments, providing new developers with a rich array of up-to-date examples. This not only fosters a vibrant community but also accelerates learning and innovation within the Wormhole ecosystem. - -Thank you for considering this suggestion and for your ongoing support in enhancing the developer experience with Wormhole! ๐Ÿš€ +Thank you for considering this suggestion and for your dedication in enhancing the developer experience with Wormhole! ๐Ÿš€ --- + # ๐Ÿช Wormhole Tutorial Program Congratulations to all our dear Hackathon participants ๐ŸŽ‰ From ab64094bc4579438fc8b95c44fc01a3083d697dd Mon Sep 17 00:00:00 2001 From: Winner Emeka Date: Tue, 3 Sep 2024 10:24:33 +0100 Subject: [PATCH 9/9] Update README.md --- docs/tutorials/quick-start/create-to-earn/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/quick-start/create-to-earn/README.md b/docs/tutorials/quick-start/create-to-earn/README.md index d2351a95..53bd424c 100644 --- a/docs/tutorials/quick-start/create-to-earn/README.md +++ b/docs/tutorials/quick-start/create-to-earn/README.md @@ -1,7 +1,7 @@ #### Disclaimer -Prize amounts, tutorials accepted and payment timelines are hypothetical and may be adjusted by Wormhole. This process keeps tutorials up-to-date with the latest hackathons and helps new developers access a range of current examples, fostering community growth and innovation. +Prize amounts, tutorials accepted, payment timelines and contact email are hypothetical and may be adjusted by Wormhole. This process keeps tutorials up-to-date with the latest hackathons and helps new developers access a range of current examples, fostering community growth and innovation. Thank you for considering this suggestion and for your dedication in enhancing the developer experience with Wormhole! ๐Ÿš€