Skip to content
Permalink
Browse files

Merge remote-tracking branch 'upstream/master'

  • Loading branch information...
DuqueKarl committed Mar 27, 2019
2 parents cf02cf4 + 17769c8 commit 7b2ba792617cd17c8201bf756a7441c14c83a7f2
Showing with 1,119 additions and 34 deletions.
  1. BIN docs/assets/Rewards.png
  2. BIN docs/assets/accountinfo.png
  3. BIN docs/assets/candidates.png
  4. BIN docs/assets/confirmationmessage.jpeg
  5. BIN docs/assets/enteraddress.png
  6. BIN docs/assets/importwallet.png
  7. BIN docs/assets/login.jpeg
  8. BIN docs/assets/login2.jpeg
  9. BIN docs/assets/loginconfirmation.jpeg
  10. BIN docs/assets/overview.png
  11. BIN docs/assets/overview.pptx
  12. BIN docs/assets/scanqr.jpeg
  13. BIN docs/assets/tomomaster.jpeg
  14. BIN docs/assets/vote.png
  15. BIN docs/assets/voteconfirmation.png
  16. BIN docs/assets/voteinformation.jpeg
  17. BIN docs/assets/votesuccessful.jpeg
  18. BIN docs/assets/walletwelcome.png
  19. +3 βˆ’0 docs/developers/blockheader.md
  20. +3 βˆ’0 docs/developers/clicommands.md
  21. +2 βˆ’0 docs/developers/dappdeploytuto.md
  22. +3 βˆ’0 docs/developers/icosmartcontract.md
  23. +3 βˆ’0 docs/developers/multisigwallet.md
  24. +7 βˆ’0 docs/developers/tutoprivatenet.md
  25. +8 βˆ’0 docs/developers/txtypes.md
  26. +2 βˆ’0 docs/general/networks.md
  27. +23 βˆ’8 docs/get-started/apply-node.md
  28. 0 docs/get-started/beginner.md
  29. +34 βˆ’0 docs/get-started/how_to_read.md
  30. 0 docs/get-started/overview.md
  31. +44 βˆ’0 docs/get-started/productoverview.md
  32. +21 βˆ’14 docs/get-started/run-node.md
  33. +1 βˆ’1 docs/get-started/voting.md
  34. +201 βˆ’0 docs/masternode/create-tomochain-masternode.md
  35. +613 βˆ’0 docs/masternode/masternode-setup-guide.md
  36. +4 βˆ’0 docs/masternode/tomonative.md
  37. +38 βˆ’0 docs/tomowallet/features.md
  38. +80 βˆ’0 docs/tomowallet/voting.md
  39. +29 βˆ’11 mkdocs.yml
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN +18.7 KB docs/assets/login.jpeg
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN +42.3 KB docs/assets/vote.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,3 @@
This shows the different fields included in a block header of TomoChain.

## Content to be updated
@@ -0,0 +1,3 @@
This shows useful CLI commands for developers to work with the TomoChain client `tomo`.

## Content to be updated
@@ -0,0 +1,2 @@
For developers who are interested in building and deploying DApps on TomoChain, please
refer to [this article](https://medium.com/tomochain/how-to-build-a-dapp-on-tomochain-85532a1192e7) for a detailed guideline.
@@ -0,0 +1,3 @@
This guides developers how to deploy an ICO smart contract on TomoChain.

## Content to be updated
@@ -0,0 +1,3 @@
This shows how to deploy a multisignature wallet on TomoChain.

## Content to be updated
@@ -0,0 +1,7 @@
This tutorial shows how to setup a private TomoChain testnet on a local machine.
The purpose is to help developers familiarise TomoChain's source code and initial setup
so that one can learn to contribute to the development of TomoChain.
The tutorial is alo a first step for any developer who wants to customize TomoChain's
source code to use in a private or consortium environment.

## Content to be updated
@@ -0,0 +1,8 @@
This shows the different transaction types processed in the TomoChain blockchain.

* Send TOMO to an external account
* Send TOMO to a smart contract
* Send tokens from one contract to another contract
* Send a signing transaction in TomoChain

## Content to be updated
@@ -13,6 +13,8 @@ TomoChain, a independent public blockchain, the most efficient platform for the
- Block finality: `>75%`
- Consensus nodes: up to 150 (masternodes)
- Genesis block date: `December 14th, 2018`
- Transaction fee: gas price 0.25 Gwei
- Smart contract creation fee: gas price 10000 Gwei, gas limit >= 1000000

### Usefull links

@@ -1,16 +1,27 @@
Once your full node is up and running, you need to apply it to make him eligible as a masternode.
Once your full node is up and running, you need to apply
it to make it eligible as a masternode.
[This page](/get-started/run-node/) shows a tutorial for beginners to run a full node.

## Getting sufficient TOMO
As 50'000 TOMO are required to apply, the first thing to do is to fill out the following [form](https://docs.google.com/forms/d/183UxYRET9I183L7lFHCredjaTd9oj4kmf4UdH7eLNNs):
As 50'000 TOMO are required to apply:

* If you plan to run your node on testnet, you need to
fill out the following [form](https://docs.google.com/forms/d/183UxYRET9I183L7lFHCredjaTd9oj4kmf4UdH7eLNNs):
to get 50k TOMO for testnet.

<iframe src="https://docs.google.com/forms/d/e/1FAIpQLSf0BiG8Rs5v4ItkwykgWUXsavLRZNA9W_EHTDis7klk5mNJnw/viewform?embedded=true" width="640" height="900" frameborder="0" marginheight="0" marginwidth="0">Loading...</iframe>

Our team will then review your request and send you the required funds.

*Note: Those TOMO are only usable in testnet, they have absolutely no trading value*
*Note: Those testnet TOMO are only usable in testnet, they have absolutely no trading value*

* If you plan to run your node on mainnet, you need to acquire at least 50k TOMO on
exchanges that list TOMO.
Please refer to [this page](https://tomochain.com/about-us/) for which exchanges listing TOMO.

## Applying to become a masternode
You can now apply by going on the [TomoMaster](https://master.testnet.tomochain.com) page.
You can now apply by going to the TomoMaster page for
[testnet](https://master.testnet.tomochain.com) or [mainnet](https://master.tomochain.com).
Login with the wallet that contains your newly received 50'000 TOMO.

On the top right corner, click on "Become a Candidate".
@@ -25,12 +36,16 @@ Confirm with apply and proceed to make the payement.
Your full node will now be listed on TomoMaster.
People can view its details and vote for it.

If your node is in the top 150 most voted nodes, it will be promoted as a masternode and will start producing blocks at the next epoch.
If your node is in the top 150 most voted nodes, it will be promoted
as a masternode and will start producing blocks at the next epoch.

## Resigning your masternode
In case you want to stop your node, you need to resign it from the governance first in order to retrieve your locked funds.
Access [TomoMaster](https://master.testnet.tomochain.com), go to your candidate detail page, and click the `Resign` button.
Your funds will be available to withdraw 30 days after the resignation.
In case you want to stop your node, you need to resign it from TomoMaster first
in order to retrieve your locked funds.
Access TomoMaster for [testnet](https://master.testnet.tomochain.com) or
[mainnet](https://master.tomochain.com), go to your candidate detail page,
and click the `Resign` button.
Your funds will be available to withdraw 1440 epochs (around 30 days) after the resignation.

After resigning successfully, you can stop your node. If you ran it with `tmn`, simply run:
```
No changes.
@@ -0,0 +1,34 @@
# How to read this documentation site
The documentation site is designed to facilitate readers
in understanding what are written on the site.

* For voters: Voters who mainly vote for masternodes to receive rewards are
encouraged to our tutorials on [how to connect wallets to TomoChain](/get-started/wallet) and [how to vote](/get-started/voting/).

* For masternode owners: A masternode is an important entity in TomoChain's ecosystem.
A TomoChain masternode is a server which uses its computing power to
contribute to the network. Its job is to create and sign blocks.
For this contribution to the network, masternodes receive rewards in
the form of TOMO.
A masternode must satisfy a [minimum requirements](/masternode/masternode-setup-guide/#technical-requirements-recommendations) about
its computing power, RAM, and storage
in order to stably maintain the network.
A financial requirement of 50k TOMO is also needed to [apply](/masternode/masternode-setup-guide/#11-apply-for-masternode-candidacy)
to become a masternode candidate.
For this, masternode owners are highly recommended to carefully read our dedicated guide
to [running a masternode](/masternode/masternode-setup-guide),
using [tmn](/masternode/masternode-setup-guide/#6-installing-tmn-utility) and [Docker](/masternode/masternode-setup-guide/#5-setup-docker-logged-in-as-new-user).
Also, masternode owners can follow our [tutorial](https://medium.com/tomochain/how-to-run-a-tomochain-masternode-from-a-to-z-3793752dc3d1) on TomoChain medium page
and our [wiki page](https://github.com/tomochain/docs/wiki).


* For developers: We highly encourage developers to contribute to the development of
TomoChain ecosystem growth.
For this reason, we have been building a set of developer tutorials and documentation
on developing DApps to be run on TomoChain as well as to contribute to the development
of TomoChain's products.
This [DApp tutorial](/advance/dappdeploytuto/) shows how to deploy a smart contract
on TomoChain.
For developers who are curious about TomoChain's source code, this
[private TomoChain testnet](/advance/tutoprivatenet/) guides you how to setup
a private TomoChain testnet.
No changes.
@@ -0,0 +1,44 @@
This page will provide users with an overview of TomoChain's product map and
[how to read](/get-started/how_to_read/) the documentation site, depending on readers' interest.

# Overview of TomoChain's products

The backbone of TomoChain's products and ecosystem is the TomoChain blockchain
with its innovative Proof-of-Staking Voting (PoSV) consensus.
To facilitate interactions between users (including voters and masternode owners)
and the TomoChain blockchain,
a set of products have been built, including TomoScan, TomoMaster, TomoWallet,
and our stats page.
TomoChain has been also developing a decentralized exchange protocol with
its relayer-based architecture.
These products will be continuously improved in our long-term plan.
Furthermore, more highly innovative products and technologies will be intensively
developed and researched to make TomoChain become an ideal platform for blockchain
games, open finance, and enterprise-oriented applications.

![overview](/assets/overview.png)

* **TomoChain**: TomoChain is the backbone public blockchain of TomoChain's product map.

* **TomoScan**: TomoScan provides a user friendly,
details and perfection-oriented user interface for TomoChain block explorer.
From a user perspective, TomoScan brings TomoChain’s transparency to users,
because all block, transaction, finality, smart contracts,
dApp and token information are read from TomoChain and shown to users.
Furthermore, TomoScan also offers technical visualisations and does
useful statistics about the TomoChain performance, token holders and
other functionalities.

* **TomoMaster**: The `Governance dApp` - TomoMaster, provides a professional
UI that allows to see the list of masternodes and candidates,
to deposit 50k TOMO to become a masternode candidate, to vote for masternodes,
and to show masternode performance statistics.

* **TomoWallet**: Tomo Wallet is the official mobile wallet for TomoChain,
aiming to store the TOMO native coin and tokens issued on TomoChain.
Tomo Wallet also allows users to vote for masternodes and track rewards.

* **TomoX**: TomoX is a decentralized cryptocurrency exchange directly
integrated into the core layer of the TomoChain blockchain.
Decentralized exchanges called relayers built following the TomoX
standard will all interact with TomoX.
@@ -1,13 +1,12 @@
With the recent release of TomoChain Testnet 2.0 with our PoSV consensus, you might be interested in creating a TomoChain full node and applying it to be a masternode.

To run a full node and meet the requirements to apply on our governance DApp, you have to run two services:

- The [TomoChain client](https://github.com/tomochain/tomochain), our TomoChain implementation written in _Go_.
- [Telegraf](https://github.com/influxdata/telegraf), an agent to collect performance metrics of your full node.
This tutorial shows you how to run a full node and meet the requirements
to apply to becoming a masternode candidate on TomoMaster,
you have to run the [TomoChain client](https://github.com/tomochain/tomochain),
which is our TomoChain implementation written in _Go_.

## General hardware notice

Our team extensively tested performances and came up with those minimal requirements for any TomoChain masternode host.
The TomoChain team has extensively tested performances and
come up with those minimal requirements for any TomoChain masternode host.

**Testnet**

@@ -25,19 +24,23 @@ Our team extensively tested performances and came up with those minimal requirem
- Must use an IaaS ("cloud") provider of your choice (AWS, Digital Ocean, Google Cloud, etc.)
- Storage must be SSD

We recommand prioritizing CPU. For example with Digital Ocean, pick a CPU optimized droplet. On AWS EC2, an C5 type instance would be a perfect match.
We recommand prioritizing CPU. For example with Digital Ocean, pick a CPU optimized droplet.
On AWS EC2, an C5 type instance would be a perfect match.

The full node will serve on port `30303` udp and tcp for p2p communication with other nodes, `8545` tcp for RPC api and `8546` tcp for websocket api.
The full node will serve on port `30303` udp and tcp for p2p
communication with other nodes, `8545` tcp for RPC api and `8546` tcp for websocket api.
You may need to edit your firewall configuration accordingly.

If you have other production grade environment than cloud provider at your displosal, please tell us more about on our [Gitter](https://gitter.im/tomochain).
If you have other production grade environment than cloud provider at your displosal,
please tell us more about on our [Gitter](https://gitter.im/tomochain).

## tmn

We made a simple command line interface called [tmn](https://github.com/tomochain/masternode) to easily and quickly start a TomoChain masternode.
We made a simple command line interface called [tmn](https://github.com/tomochain/masternode)
to easily and quickly start a TomoChain full node.
It takes care of starting the necessary docker containers with the proper settings for you.
It will really suit you if you don't already have a big infrastructure running.
Spin up a machine in your favorite cloud and get your masternode running in a few minutes!
Spin up a machine in your favorite cloud and get your full node running in a few minutes!

### Prerequisites

@@ -76,6 +79,7 @@ You can choose here to connect it to the TomoChain Testnet or Mainnet (once laun

`--pkey`: The private key of the account that your full node will use.
A TomoChain full node uses an account to be uniquely identified and to receive transaction fee.

**Important note:** we advise for security measures to use a fresh new account for your masternode.
This is not the account who will receive the rewards.
The rewards are sent to the account who will make the 50k TOMO initial deposit.
@@ -88,9 +92,12 @@ tmn start --name [YOUR_NODE_NAME] \
--pkey [YOUR_COINBASE_PRIVATE_KEY]
```

Once started, you should see your node on the [stats page](https://stats.testnet.tomochain.com)!
Once started, you should see your node on the [testnet stats page](https://stats.testnet.tomochain.com)
or the [mainnet stats page](https://stats.tomochain.com),
depending on which net you are connecting to!

Note: it can take up to one hour to properly sync the entire blockchain.
Note: it can take up to one hour or more (depending on the
blockchain data size) to properly sync the entire blockchain.

### Usage

@@ -49,7 +49,7 @@ Once configured, you can vote for masternodes by clicking on the `Vote` button.

![Vote](/assets/vote.jpg)

At least 10 TOMO is required per vote. After clicking submit, your TOMO will be sent to the voting smart contract and locked there.
At least 100 TOMO is required per vote. After clicking submit, your TOMO will be sent to the voting smart contract and locked there.

## Reward
Every epoch (~30 minutes), you will automatically receive rewards for each masternode you voted for.
Oops, something went wrong.

0 comments on commit 7b2ba79

Please sign in to comment.
You can’t perform that action at this time.