Skip to content
This repository was archived by the owner on Feb 15, 2025. It is now read-only.

Commit b56ac65

Browse files
committed
Update README
1 parent 7b02f24 commit b56ac65

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,15 @@ The repo is composed as a Truffle project. The test suite can be found in `test/
2222

2323
The Sale contract deploys the token contract, disburses funds to pre-sale purchasers and then deploys timelock contracts to store the founders tokens. `Disbursement.sol` and `Filter.sol` comprise the timelock contracts. Two `Disbursement.sol` contracts are deployed which unlock funds at a particular date. The `Filter.sol` contracts sit in front of them and allow particular addresses to withdraw particular amounts of funds.
2424

25+
# Using the repo to deploy a real token
2526
Config files where the parameters of your own sale can be filled in are in the `conf` directory.
2627

28+
Note that the `owner` in `sale.json` MUST BE the first address generated by the mnemonic in `secrets.json`. Note that you MUST change the default mnemonic in `secrets.json` or you WILL BE PWNED. Once you've done that you MUST NEVER commit your `secrets.json`. KEEP IT SECRET. It is in the .gitignore. Do not commit it once you've changed it. If your production mnemonic is compromised you are fully pwned.
29+
30+
DO NOT USE THE DEFAULT MNEMONIC.
31+
DO NOT SHARE OR COMMIT THE MNEMONIC YOU CHANGE IT TO.
32+
33+
Make sure all the tests pass before deploying. You probably won't have all of your founders' private keys and so expect to see warnings on those tests. It will take a long time for the tests in the "Sale period 0" block to begin since the testRPC has to be force-mined for millions of blocks.
34+
35+
Having done all that you can `truffle migrate --network mainnet`. Save the contents of your build directory, you'll want to have all that data.
36+

0 commit comments

Comments
 (0)