diff --git a/README b/README deleted file mode 100644 index b63548b011256a8fbb8cc04bd62af04d76699679..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,46 +0,0 @@ -1) Install Ubuntu -2) add-apt-repository -y ppa:ethereum/ethereum -3) apt update -4) apt install ethereum solc jq ncurses-bin -5) run start.sh -6) create your contract (there is already one deployed, so *do*not* confuse the two) -7) insert.sh "I'm doing great today." -8) wait for next block to be sealed/mined: sleep 15 -9) verify.sh "Hi there" -10) verify.sh "I'm doing great today." -11) Try the basic explorer.sh -12) consider this crontab: @reboot bfa/network5445/start.sh - -== network5445/start.sh -requires: geth - -Starts a node on the 5445 BFA test net. Creates a genesis.json if you don't have one already. -One is already included in this package, which will allow you to connect to the existing BFA testnet. - -== create.contract -requires: geth, solc, jq - -Compiles and deploys a contract to the blockchain. A local "node1" must already be running. - -Argument 1 is the contract to compile. - -Example: ./create.contract src/contract.TimestampDocument.sol - -== insert.sh -requires: geth - -Inserts the checksum of a text into the compiled contract. - -== verify.sh -requires: geth - -Returns the first blocknumber where the SHA256 checksum of a document was seen (0 for no match). - -== explorer.sh -requires: curl, jq, tput (ncurses-bin) - -Simple script to look at blocks - -== src/contract.TimestampDocument.sol - -The initial Timestamp service. Could be made better. diff --git a/README.md b/README.md index 2f92cd0a79784df58f085b4be62f36e46cd69ce2..b43572252b58812a9b07650ef0e0b84904e5973a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ # Blockchain Federal Argentina -# TEST NETWORK +## TEST NETWORK + +1. Install Ubuntu +2. add-apt-repository -y ppa:ethereum/ethereum +3. apt update +4. apt install ethereum solc jq ncurses-bin +5. run start.sh +6. create your contract (there is already one deployed, so *do*not* confuse the two) +7. insert.sh "I'm doing great today." +8. wait for next block to be sealed/mined: sleep 15 +9. verify.sh "Hi there" +10. verify.sh "I'm doing great today." +11. Try the basic explorer.sh +12. consider this crontab: @reboot bfa/network5445/start.sh + +## network5445/start.sh +requires: **geth** + +Starts a node on the 5445 BFA test net. Creates a genesis.json if you don't have one already. +One is already included in this package, which will allow you to connect to the existing BFA testnet. + +## create.contract +requires: **geth**, **solc**, **jq** + +Compiles and deploys a contract to the blockchain. A local "node1" must already be running. + +Argument 1 is the contract to compile. + +Example: `./create.contract src/contract.TimestampDocument.sol` + +## insert.sh +requires: **geth** + +Inserts the checksum of a text into the compiled contract. + +## verify.sh +requires: **geth** + +Returns the first blocknumber where the SHA256 checksum of a document was seen (0 for no match). + +## explorer.sh +requires: **curl**, **jq**, **tput** _(ncurses-bin)_ + +Simple script to look at blocks + +## src/contract.TimestampDocument.sol + +The initial Timestamp service. Could be made better.