diff --git a/docs/assets/AramidHomepage.png b/docs/assets/AramidHomepage.png new file mode 100644 index 00000000..72a6c56a Binary files /dev/null and b/docs/assets/AramidHomepage.png differ diff --git a/docs/assets/AramidOriginChainSelect.png b/docs/assets/AramidOriginChainSelect.png new file mode 100644 index 00000000..5c7a9074 Binary files /dev/null and b/docs/assets/AramidOriginChainSelect.png differ diff --git a/docs/assets/AramidProcessingConfirmation.png b/docs/assets/AramidProcessingConfirmation.png new file mode 100644 index 00000000..74730340 Binary files /dev/null and b/docs/assets/AramidProcessingConfirmation.png differ diff --git a/docs/assets/AramidReviewTransaction.png b/docs/assets/AramidReviewTransaction.png new file mode 100644 index 00000000..74730340 Binary files /dev/null and b/docs/assets/AramidReviewTransaction.png differ diff --git a/docs/assets/DEXSwapInterface.png b/docs/assets/DEXSwapInterface.png new file mode 100644 index 00000000..55ee95a4 Binary files /dev/null and b/docs/assets/DEXSwapInterface.png differ diff --git a/docs/assets/iBuyDestinationAddress.png b/docs/assets/iBuyDestinationAddress.png new file mode 100644 index 00000000..1296e4c5 Binary files /dev/null and b/docs/assets/iBuyDestinationAddress.png differ diff --git a/docs/assets/iBuyHomepage.png b/docs/assets/iBuyHomepage.png new file mode 100644 index 00000000..e5e91624 Binary files /dev/null and b/docs/assets/iBuyHomepage.png differ diff --git a/docs/developers/networks.md b/docs/developers/networks.md index 30734a07..978a3a94 100644 --- a/docs/developers/networks.md +++ b/docs/developers/networks.md @@ -1,6 +1,6 @@ # Networks -Voi blockchain will have two public networks, mainnet and testnet. Right now, there only exists the testnet network. +Voi blockchain has one public network, mainnet. Mainnet is the live production network where real transactions occur. For development and testing purposes, developers are encouraged to use a local development network via AlgoKit. ### Mainnet @@ -8,12 +8,15 @@ Genesis ID: `voimain-v1.0` Genesis Hash: `r20fSQI8gWe/kFZziNonSPCXLwcQmH/nxROvnnueWOk=` -### Testnet +**Public API Endpoints** -Genesis ID: `voitest-v1` +| Service | URL | +| --- | --- | +| Algod | https://mainnet-api.voi.nodely.dev | +| Indexer | https://mainnet-idx.voi.nodely.dev | -Genesis Hash: `IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=` +### Local Development Network -### Devnet +For development and testing, the recommended approach is to spin up a local network using AlgoKit. AlgoKit provides a one command local development environment with a pre-configured node, indexer and other developer tooling out of the box. Once your application is ready you can deploy directly to mainnet. -It is also possible for developers to spin up their own local network for development purposes before deploying their applications to the Testnet environment and then subsequently the Mainnet environment. +For more information on getting started with AlgoKit see the developer quickstart. \ No newline at end of file diff --git a/docs/ecosystem/bounty-boards/services.md b/docs/ecosystem/bounty-boards/services.md index 64a07f64..052a548a 100644 --- a/docs/ecosystem/bounty-boards/services.md +++ b/docs/ecosystem/bounty-boards/services.md @@ -7,7 +7,7 @@ Rather than having fixed bounties, service providers are encouraged to submit tr By leveraging the collective strength of Core Partners, especially those structured as DAOs, Voi fosters a truly decentralized ecosystem where decision-making and execution are community-driven and efficient. -The bounty board is not a definitive list of what is needed in the ecosystem. It is a list of some services identified by the community as desirable to have. +The bounty board is not a definitive list of what is needed in the ecosystem. It is a list of some services identified by the community as desirable to have. Have an idea for a service not on this board? Anyone can propose a new service, get community approval and start contributing. If you believe there is a gap in the ecosystem you can fill, submit a proposal and let the community decide. **Proposals for providing services don't need to be restricted to what is on the bounty board.** @@ -28,20 +28,17 @@ By leveraging the collective strength of Core Partners, Voi fosters a truly dece | **Category** | **Service** | **Description** | **Key Responsibilities** | |--------------|-------------|-----------------|--------------------------| -| **Network** | **Network Stress Testers** | Responsible for conducting thorough stress tests on the Voi network to ensure its robustness and reliability. | - Conducting stress tests on the Voi network.
- Recording and analyzing test results.
- Publishing detailed reports on findings. | -| | **Relay Network Management** | Manages the relay network's efficiency by using stress test results and monitoring failures to ensure optimal performance. | - Reviewing stress test results and applying insights to improve the network.
- Tracking network failures and applying penalties based on established criteria.
- Capturing relay peer data for record-keeping.
- Calculating and submitting monthly relay compensation for approval.
- Communicating with relay runners as needed. | -| | **Testnet Maintenance** | Ensures that the Voi testnet is always up-to-date, functional, and accessible for developers and testers. | - Ensuring the Voi testnet is functional, up-to-date, and accessible.
- Monitoring and refilling faucets to support developer testing.
- Providing ongoing support to developers using the testnet. | +| **Network** | **Network Management** | Responsible for conducting thorough stress tests on the Voi network and managing the relay network's efficiency to ensure robustness, reliability and optimal performance. | - Conducting stress tests on the Voi network.
- Recording and analyzing test results.
- Publishing detailed reports on findings.
- Tracking network failures and applying penalties based on established criteria.
- Capturing relay peer data for record-keeping.
- Calculating and submitting monthly relay compensation for approval.
- Communicating with relay runners as needed. | | **Marketing**| **Social Media Management** | Handles the Voi ecosystem's social media presence, engaging with the community and increasing brand visibility. | - Managing social media channels such as Twitter.
- Creating and scheduling weekly content.
- Engaging with the Voi community online. | | | **Public Relations** | Focuses on securing positive media coverage for Voi and building relationships with media outlets. | - Securing positive media coverage for Voi.
- Building relationships with media outlets and influencers. | | | **Missionaries** | Aims to expand the Voi ecosystem by onboarding new users and reaching out to other blockchain communities. | - Onboarding new users to the Voi ecosystem.
- Expanding outreach to attract users from other blockchain ecosystems. | -| | **Raiders** | Engages in proactive efforts to combat FUD and increase Voi's visibility across various social media platforms. | - Combatting FUD (Fear, Uncertainty, and Doubt) on social media with facts, truth and respect.
- Coordinating raids to increase Voi’s visibility in other ecosystems.
- Recruiting and managing a team of Voi supporters for these efforts. | -| **Moderation** | **Discord & Telegram Moderators** | Ensures that Voi’s online communities remain safe, secure, and welcoming for all members. | - Ensuring Voi’s Discord and Telegram communities are safe, secure, and welcoming.
- Enforcing community guidelines and addressing any issues promptly. | +| | **Voiagers** | Engages in proactive efforts to increase Voi's visibility and foster a positive community presence across social media platforms. | - Engaging and supporting community members through active participation.
- Increasing Voi's visibility in other ecosystems.
- Recruiting and managing a team of Voi supporters for these efforts. | +| **Moderation** | **Discord & Telegram Moderators** | Ensures that Voi's online communities remain safe, secure, and welcoming for all members. | - Ensuring Voi's Discord and Telegram communities are safe, secure, and welcoming.
- Enforcing community guidelines and addressing any issues promptly. | | **Education** | **External Course Instructors** | Develops and delivers educational content to promote Voi to a broader audience, targeting various user groups. | - Developing and delivering educational courses about Voi to external audiences.
- Targeting different user groups, including developers, node runners, and power users. | -| **Entertainment** | | | | -| **Administration** | **Committe Leadership** | Resposible for administrative tasks related to the committees of Voi. | - Meeting agendas.
- Working with the committee to get proposals ready for the council.
- Coordinating committee members.
- General administrative tasks needed for the smooth functioning of the committees. | +| **Administration** | **Committee Leadership** | Responsible for administrative tasks related to the committees of Voi. | - Meeting agendas.
- Working with the committee to get proposals ready for the council.
- Coordinating committee members.
- General administrative tasks needed for the smooth functioning of the committees. | ## How to Apply -Interested in one of the bounties? [Submit your application](../../governance/submitting-proposals.md) via the [Ecosystem Services Grants](../../governance/proposals/types-of-grants.md) process. Be sure to include your experience, a proposed plan of action, and any relevant previous work. +Interested in one of the bounties? [Submit your application](../../governance/submitting-proposals.md) via the [Ecosystem Services Grants](../../governance/proposals/service-grants.md) process. Be sure to include your experience, a proposed plan of action, and any relevant previous work. ## Review Process All submissions will be reviewed by the Voi Council via the [following process](../../governance/proposals/application-process.md). @@ -49,4 +46,4 @@ All submissions will be reviewed by the Voi Council via the [following process]( If your application is accepted, you will be notified, and the task will be officially assigned to you. ## Completion and Reward -Upon successful completion of the task, submit your deliverables for approval. Once reviewed and approved, you will receive your reward in the specified token or amount. +Upon successful completion of the task, submit your deliverables for approval. Once reviewed and approved, you will receive your reward in the specified token or amount. \ No newline at end of file diff --git a/docs/guides/acquiring-and-bridging.md b/docs/guides/acquiring-and-bridging.md index 53fafd4a..bbff8500 100644 --- a/docs/guides/acquiring-and-bridging.md +++ b/docs/guides/acquiring-and-bridging.md @@ -1,4 +1,85 @@ -# Acquiring and Bridging VOI +# Acquiring VOI +There are three ways to get VOI tokens onto the Voi blockchain. You can buy directly using fiat or crypto via iBuyVoi, purchase on a centralized exchange if you are located outside the United States, or bridge assets from another blockchain using Aramid Finance. Read through the options below and pick the one that works best for you. -Please refer to this [Guide to Acquiring & Bridging Voi](https://docs.google.com/document/d/1rOLdlhbLGGa9QNcaff8EG3FidOlopTC1JZtzkLsYPn0/edit) to learn how to get VOI tokens onto the Voi blockchain. +--- + +## Before You Start + +You will need a Voi compatible wallet set up before you can receive VOI. If you do not have one yet, set one up first using one of the wallets below. + +- [Kibisis](https://kibis.is/) - Browser extension wallet, most popular in the Voi ecosystem +- [Lute](https://lute.app/) - Web based wallet with strong Ledger hardware support +- [Biatec](https://wallet.biatec.io/) - Web based wallet option + +When setting up your wallet, write down your seed phrase and store it somewhere safe. Anyone with your seed phrase has full access to your funds. Do not share it with anyone. + +--- + +## Option A: Buy Directly via iBuyVoi (Recommended) + +iBuyVoi is the simplest way to get VOI and works for users everywhere including the United States. You can fund your Voi wallet using fiat currency, Algorand or Base chain assets directly without needing a centralized exchange account. + +![iBuyVoi homepage](../assets/iBuyHomepage.png) + +1. Go to [iBuyVoi](https://www.ibuyvoi.com/) +2. Select your funding method, fiat currency, Algorand or Base +3. Enter your Voi wallet address as the destination + +![iBuyVoi destination address field](../assets/iBuyDestinationAddress.png) + +4. Enter the amount you want to acquire +5. Complete the transaction and wait for VOI to arrive in your wallet + +--- + + +## Option B: Bridge from Another Chain + +If you have assets on Algorand, Base or Arbitrum you can bridge them to the Voi blockchain using [Aramid Finance](https://www.aramid.finance/). This is also the recommended route for US based users who cannot use the centralized exchanges above. + +You can bridge two types of assets to Voi: + +- **aVOI (Aramid VOI)** from Algorand, which arrives as VOI directly in your Voi wallet +- **USDC** from Algorand, Base or Arbitrum, which arrives as Aramid USDC on Voi and needs one additional swap step to become VOI + +### Bridging aVOI or USDC to Voi + +1. Make sure you have a Voi compatible wallet ready to receive your tokens (Kibisis, Lute or Biatec) +2. Go to [Aramid Finance](https://www.aramid.finance/) and click Launch Bridge + +![Aramid Finance homepage](../assets/AramidHomepage.png) + +3. Select your origin chain (Algorand, Base or Arbitrum) and the asset you are bridging (aVOI or USDC) +4. Connect your origin chain wallet + +![Aramid bridge with origin chain and asset selected](../assets/AramidOriginChainSelect.png) + +5. Enter your Voi wallet address in the Destination Address field +6. Enter the amount you want to bridge and click Review Transaction + +![Aramid bridge with destination address and amount filled in](../assets/AramidReviewTransaction.png) + +7. Sign the transaction in your origin wallet and wait for the bridge to process. This can take a few minutes. + +![Aramid bridge processing confirmation](../assets/AramidProcessingConfirmation.png) + +### If You Bridged USDC: Swap to VOI + +If you bridged USDC it will arrive as Aramid USDC in your Voi wallet. You need one more step to convert it to VOI using a DEX on the Voi blockchain. + +1. Go to [Humble](https://voi.humble.sh/) or [Nomadex](https://voi.nomadex.app/) and connect your Voi wallet +2. Select Aramid USDC as the input token and VOI as the output token + +![Humble or Nomadex swap interface](../assets/DEXSwapInterface.png) + +3. Enter the amount and complete the swap +4. You now have VOI on the Voi blockchain + +If you bridged aVOI directly it arrives as VOI automatically and no swap is needed. + +--- + +## Getting Help + +If you run into any issues at any step, head to the **#support** channel in the [Voi Discord](https://discord.gg/voi-network) where community members and the core team can help you out. \ No newline at end of file