Skip to content

Commit 58e5045

Browse files
authored
Create files and populating files other than ecosystem
1 parent 69b9041 commit 58e5045

38 files changed

+589
-1
lines changed
File renamed without changes.

docs/airdrops/socials.md

Whitespace-only changes.

docs/airdrops/token-sale.md

Whitespace-only changes.

docs/chain.md

Whitespace-only changes.

docs/developers/api.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### API
2+
3+
There are multiple APIs exposed by nodes. These APIs allow for programmatic access to some of the daemons that run on the node.
4+
5+
All of the APIs follow the REST architectural style.
6+
7+
The APIs are as follows:
8+
9+
* [Algod](https://developer.algorand.org/docs/rest-apis/algod/)
10+
* [Indexer](https://developer.algorand.org/docs/rest-apis/indexer/)
11+
* [Kmd](https://developer.algorand.org/docs/rest-apis/kmd/)

docs/developers/cli.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Command Line Interface (CLI)
2+
3+
There is a CLI available for interacting with the different daemons on nodes.
4+
5+
The CLIs are as follows:
6+
7+
* [Goal](https://developer.algorand.org/docs/clis/goal/goal/)
8+
* [Kmd](https://developer.algorand.org/docs/clis/kmd/)
9+
* [Algokey](https://developer.algorand.org/docs/clis/algokey/algokey/)
10+
* [Diagcfg](https://developer.algorand.org/docs/clis/diagcfg/diagcfg/)
11+
* [Conduit](https://developer.algorand.org/docs/clis/conduit/conduit/)
12+
* [Indexer](https://developer.algorand.org/docs/clis/indexer/indexer/)
13+
* [Tealdbg](https://developer.algorand.org/docs/clis/tealdbg/tealdbg/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Interacting With Voi Blockchain
2+
3+
Interacting with the Voi blockchain is always done through a node in the network. A node is a device with sufficient resources running the appropriate software that is connected to the network.
4+
5+
Every node on the Voi blockchain network runs Voi Algod, software built into the node that allows users to interact with the network. There are 3 main ways to interact with the network through a node. There is the Command Line Interface (CLI), a series of APIs and SDKs implemented in a number of languages.
6+
7+
Developers should [run a local instance of a node](node-runners/run-a-participation-node.md) so that they can interact with Voi blockchain.
8+
9+
There are also [public APIs](developers/tools.md) available that expose the API of a node run by a 3rd party.

docs/developers/networks.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Networks
2+
3+
Voi blockchain will have two public networks, mainnet & testnet. Right now, there only exists the testnet network.
4+
5+
6+
### Mainnet
7+
8+
Coming soon.
9+
10+
11+
### Testnet
12+
13+
Genesis ID: voitest-v1
14+
15+
Genesis Hash: IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=
16+
17+
18+
### Devnet
19+
20+
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.

docs/developers/sdk.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### SDK
2+
3+
In order to simply access the APIs there are a number of SDKs available in different languages.
4+
5+
Currently there is official SDK support for:
6+
7+
* [JavaScript](https://github.com/algorand/js-algorand-sdk)
8+
* [Go](https://github.com/algorand/go-algorand-sdk)
9+
* [Python](https://github.com/algorand/py-algorand-sdk)
10+
* [Java](https://github.com/algorand/java-algorand-sdk)
11+
12+
There are also some community maintained SDKs:
13+
14+
* [.Net](https://github.com/FrankSzendzielarz/dotnet-algorand-sdk)
15+
* [Dart](https://pub.dev/packages/algorand_dart)
16+
* PHP
17+
* [ffsolutions](https://github.com/ffsolutions/php-algorand-sdk)
18+
* [rootsoft](https://github.com/RootSoft/algorand-php)
19+
* [Rust](https://github.com/manuelmauro/algonaut)
20+
* [Swift](https://github.com/Jesulonimi21/Swift-Algorand-Sdk)
21+
* [C](https://github.com/vertices-network/c-vertices-sdk)
22+
* [Unity](https://assetstore.unity.com/packages/decentralization/infrastructure/algorand-sdk-for-unity-247704)

docs/developers/smart-contracts.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Smart Contracts
2+
3+
Smart contracts on Voi blockchain can be written using multiple languages that then compile down to TEAL before being deployed to the blockchain using the SDKs or the goal CLI. You can write in TEAL, but it is considered easier to use a higher level abstraction language.
4+
5+
The Official Languages are as follows:
6+
7+
* [Python](https://algorandfoundation.github.io/puya/)
8+
* [PyTeal](https://github.com/algorand/pyteal)
9+
* [Reach](https://github.com/reach-sh/reach-lang)
10+
* [Teal](https://developer.algorand.org/docs/get-details/dapps/avm/teal/)
11+
12+
Community created languages:
13+
14+
* [Tealish](https://github.com/tinymanorg/tealish)
15+
* [Tealscript](https://github.com/algorandfoundation/TEALScript)

docs/developers/start-here.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Start Here
2+
3+
Voi blockchain comes complete with all of the resources necessary for developers to do what they do best, build.
4+
5+
Voi blockchain is a decentralized network. This requires developers to be able to interface through the endpoints of nodes that are connected to the network in order to read or write to the ledger.

docs/developers/tools.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Tools
2+
3+
In order to make development easier there are a number of ecosystem specific tools that exist.
4+
5+
6+
7+
* [Algokit](https://github.com/algorandfoundation/algokit-cli)
8+
* [Beaker](https://github.com/algorand-devrel/beaker)
9+
* [Conduit](https://github.com/algorand/conduit)
10+
* [Indexer](https://github.com/algorand/indexer)
11+
* Public Node API URLs:
12+
* [https://testnet-api.voi.nodly.io/](https://testnet-api.voi.nodly.io/)
13+
* [https://testnet-idx.voi.nodly.io/](https://testnet-idx.voi.nodly.io/)
14+
* Smart Assets NFT Indexer
15+
* [https://arc72-idx.voirewards.com/api-docs/](https://arc72-idx.voirewards.com/api-docs/)
16+
* Smart Assets interaction library
17+
* [https://github.com/temptemp3/ulujs](https://github.com/temptemp3/ulujs)
18+
* [Block Explorer](https://voi.observer/explorer/home)
19+
* Smart Asset Explorer
20+
* [https://shellyssandbox.xyz/](https://shellyssandbox.xyz/)

docs/ecosystem/governance.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Governance
2+
3+
Voi's L1 blockchain governance model is inspired by the tripartite system used in various global governments, with its own unique adaptations. This model is structured around three distinct branches: Judicial (Block Authority Inc.), Legislative (Voi Council), and Executive (Voi Foundation), each tasked with specific functions and responsibilities to ensure equitable distribution of power and prevent dominance by any single person or entity.
4+
5+
The essence of adopting this tripartite system is to promote a community-driven approach, democratizing decision-making and maintaining the blockchain's operation in the best interests of its whole ecosystem.
6+
7+
Here’s an overview of each branch:
8+
9+
1. **Voi Council (Legislative):** This branch comprises community-elected members who reflect the community's voice, interest and priorities. It is responsible for crafting and modifying governance rules, as well as proposing new initiatives.
10+
2. **Voi Foundation (Executive):** This branch includes both elected and appointed community members. It is responsible for the implementation of policies and decisions formulated by the Council, aligning daily operations with the community’s values and objectives.
11+
3. **Voi Inc. (Judicial):** Operated by the founders and appointed members, this branch provides guidance and ensures continuity. It safeguards the constitution and the blockchain’s core principles, acting as a guardian against unnecessary or capricious changes, ensuring amendments are justified and significant.
12+
13+
Voi’s governance model is built on the principle of checks and balances, ensuring that no branch overpowers another and that the blockchain remains a balanced, transparent, and equitable system for all participants. It is an on-chain mechanism that ensures dedicated members of the Voi ecosystem can influence the future of the network and ecosystem.

docs/ecosystem/projects.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Projects
2+
3+
https://voiager.org/
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Submitting Proposals
2+
3+
This process is currently being developed. This section will be updated soon to reflect that information.

docs/ecosystem/tokenomics.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Tokenomics
2+
3+
Voi's economic design is engineered for long-term, sustainable ecosystem growth, with a full resource distribution plan spanning 20 years. This mitigates severe inflation, protecting users and stakeholders' interests.
4+
5+
To expedite scale within the first five years, Voi will distribute the ecosystem stake during this period. Subsequently, the newly formed future foundations will gradually receive their 5% allocations over the following decade, amounting to a total of 20%.
6+
7+
To swiftly bootstrap the network and ecosystem as well as later counteract inflation, early incentives are front-loaded and entirely allocated within the first 18 months.
8+
9+
Block rewards, meanwhile, are to be fully allocated over the 20-year span. This ensures that node operators can sustain themselves purely from block rewards and network security contributions until the network becomes self-sustaining on fees alone.
10+
11+
Consequently, Voi ensures that 75% of network ownership directly benefits the community in various ways, demonstrating our commitment to user-focused growth and long-term network stability.

docs/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Voi Chain
2+
3+
Voi is a community-owned and operated L1 blockchain and ecosystem.
4+
5+
Voi uniquely allocates a majority of the ecosystem’s resources to those directly adding value to the network. Voi aims mto solve the problem found in many blockchains today, which is a lack of decentralization, lack of self governance, lack of community investment, and continued complexity that inhibits mainstream usage.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Become A Relay Runner
2+
3+
In order to become a relay runner your node would not only need to be configured to do so, but will also need to be added to the DNS.
4+
5+
This means there is a requirement for you to register to become a relay runner so that we can add your node to the network.

docs/node-runners/overview.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Overview
2+
3+
The Voi blockchain, like every blockchain is underpinned by a network of nodes.
4+
5+
A node is a piece of software that runs on a device with sufficient resources, the correct environment and a connection to the internet. It’s these independent nodes communicating with each other that enables the blockchain to operate.
6+
7+
This software can be configured in different ways depending on what you want the node to do. The configuration of the software will also dictate the resources required for the software to run effectively.
8+
9+
Some common configurations are:
10+
11+
12+
13+
* Participation
14+
* Relay
15+
* Lite
16+
* Archival
17+
18+
19+
### Participation Nodes
20+
21+
Participation nodes are the nodes that participate in consensus and that transactions are submitted from. These are the nodes that accounts are staked on and they store the last 1000 blocks of the ledger.
22+
23+
24+
### Relay Nodes
25+
26+
Relay nodes are used for routing messages between other node types.
27+
28+
29+
### Lite Nodes
30+
31+
Lite nodes can be used to submit transactions to the network or access non-historical states.
32+
33+
34+
### Archival Nodes
35+
36+
Archival nodes store the entire ledger, as such they may also have the indexer software installed on the node as well to more efficiently and effectively query the ledger.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Run A Node
2+
3+
Running a participation node is the best way to help secure the network in a fully permissionless way.
4+
5+
There are a number of tools available to make the running of a participation node extremely easy no matter what your experience level is and what device you have available to you.
6+
7+
Node running options:
8+
9+
* [Voi Swarm](https://voinetwork.github.io/voi-swarm/)
10+
* For use on a dedicated linux server.
11+
* One line install.
12+
* [Aust’s 1 Click Node](https://github.com/AustP/austs-one-click-node)
13+
* For use on any local device with a graphical interface such as a laptop running windows, MacOS or Linux.
14+
* Installable application.
15+
* Custom
16+
* Setup manually however you wish.
17+
* Guides such as [D13’s](https://d13.co/posts/set-up-voi-participation-node/) exist.

docs/noderunners.md

Whitespace-only changes.

docs/understanding-voi/accounts.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
## Accounts
3+
4+
Accounts at their core are structures that contain a few different objects including keys, They are commonly referred to as Addresses as one of the objects that they encapsulate that is visible and commonly used is the Address of the account.
5+
6+
7+
### Structure
8+
9+
10+
#### Address
11+
12+
The address is the human readable version of the public key that is used as a unique identifier for your account. It is what is used when it comes to identifying and specifying recipients and senders within transactions.
13+
14+
Your address can be freely shared and is how you and others will uniquely identify your account.
15+
16+
17+
#### Seed Phrase
18+
19+
On Voi the seed phrase for an account is 25 human readable words in a specific order.
20+
21+
From this seed phrase you can derive the private key that is used to sign transactions.
22+
23+
You should never share your seed phrase because you can derive the private key from it.
24+
25+
26+
#### Private Key
27+
28+
The private key of the account can be considered the keys to the castle. With this key you have full control over the account and can derive the public key.
29+
30+
The private key is what is used behind the scenes when you interact with Voi and proves that you own the account and so the address that you are using.
31+
32+
You should never share your private key as you use them to sign data and transactions or verify signatures.
33+
34+
35+
#### Public Key
36+
37+
The public key is seldom exposed, but it is used to derive the address of the account.
38+
39+
Public keys can be freely shared, but it is unlikely you will need to, or that you will even see your public key.
40+
41+
42+
### Attributes
43+
44+
45+
#### Balance
46+
47+
Every account has an associated balance. That is the number of Voi tokens that it holds.
48+
49+
50+
#### Minimum Balance
51+
52+
Every account that exists on Voi has a minimum balance. This starts at 0.1 Voi and increases with each smart contract opted into or standard asset held. Opting out of already opted into smart contracts or full removal of standard assets from an account decreases the minimum balance.
53+
54+
As the number of accounts created increases it means that the amount of Voi locked up increases too. It’s worth noting here that every smart contract has an account too, so every smart contract also increases the amount of locked up Voi.
55+
56+
57+
#### Participation Status
58+
59+
Every account on Voi is either Offline or Online. By default all accounts are set to be offline.
60+
61+
Offline accounts are not participating in consensus. Online accounts are participating in consensus and are staking their balance on a node to
62+
[help secure the network](node-runners/overview.md).
63+
64+
65+
### Features
66+
67+
Below are features special to Voi that drastically improve the network’s user experience when compared to other chains.
68+
69+
70+
#### Multisig
71+
72+
Multisig accounts are represented in Voi the same as normal accounts and are not smart contract based like in other networks.
73+
74+
The primary difference between them and a standard account is that they have a defined threshold on the number of accounts in the multisig that are needed to sign a transaction.
75+
76+
The address of a multisig account is derived from the ordered list of the standard accounts that make up the multisig. Multisigs cannot be nested with other multisig accounts so the ordered list used to derive them can only be made up of standard accounts.
77+
78+
79+
#### Rekeying
80+
81+
Rekeying is a feature that swaps out the private key that is used to sign for an account to a different one.
82+
83+
This means that accounts can maintain the same public key and address, but a different private key from another account must be used to sign transactions instead. The original private key cannot be used to sign transactions.
84+
85+
You should be sure to retain access to the original private key as if you close out an account then the rekey is reset.

docs/understanding-voi/assets.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
## Assets
3+
4+
Assets on Voi come in two different flavors. Each of which are powerful and can be leveraged in different ways to achieve the same outcome.
5+
6+
Both can be used to represent Fungible & Non-Fungible resources on the Voi blockchain as assets.
7+
8+
The main difference is that Standard Assets require a recipient to opt in to receive the asset first and they are not as extensible as Smart Assets.
9+
10+
11+
### Smart Assets
12+
13+
Smart assets are represented by smart contracts and are created and interacted with by transactions that interact with smart contracts.
14+
15+
16+
### Standard Assets
17+
18+
Standard assets exist without the need for smart contracts and are created and interacted with by transactions alone.

docs/understanding-voi/blocks.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Blocks
2+
3+
These are the tamper proof data structures that can contain 0 or more signed transactions that were submitted to the network after the previous block was produced.
4+
5+
Each block has a reference to the previous one which enables them to be chained together to form an immutable ledger.
6+
7+
Blocks are only written to the ledger after being certified via the consensus process by accounts staked on nodes which form the network.

0 commit comments

Comments
 (0)