Index
b'# RSK Truffle Starter Box\n\nThis box comes with everything you need to start using Truffle on [RSK Blockchain](https://developers.rsk.co/rsk/).\nIt includes network configurations for Mainnet, Testnet and the SimpleStorage contract as an example to deploy.\n\n[RSK](https://www.rsk.co/) is an open source platform for Ethereum compatible smart contracts based on the Bitcoin network.\n\n## Requirements\n\n1. [NPM (Node Package Manager)](https://nodejs.org/en/)\nNode.js and NPM are needed, though both are usually installed at once.\n\nGo to [Node.js](https://nodejs.org/en/) if you need to install it.\n\n2. Truffle\n\nInstall Truffle globally\n\n```shell\nnpm install -g truffle\n```\n\n## Installation\n\n1. Create a new folder.\nFor example, create the folder `rsk-starter`.\nNavigate to the folder in the terminal.\n\n```shell\nmkdir rsk-starter\ncd rsk-starter\n```\n\n2. Run the unbox command. It can take some time, as this will install all necessary dependencies.\n\n```shell\ntruffle unbox rsksmart/rsk-starter-box\n```\n\nThis is the result using Windows OS:\n\n\n\n## Development console\n\nTruffle has an interactive console that also spawns a development blockchain. This is very useful for compiling, deploying and testing locally.\n\n3. Run the development console. This command is successful if you see a list of 10 accounts, a mnemonic and the command prompt is now `truffle(develop)>`\n\n```shell\ntruffle develop\n```\n\nYou will now be in the truffle develop REPL with seeded accounts and their associated private keys listed.\n\n```txt\nTruffle Develop started at http://127.0.0.1:9545/\n\nAccounts:\n(0) 0x4579996629f631d5221c9ea0c3552f6dcff61e9e\n(1) 0x52f43fccc4ffcbb9f0a57320401139ef4088093f\n(2) 0xea7e59d8403587bdb1c12758eb33f82dc9e0a451\n(3) 0x9eed1b59ac18360b67b7ef2a069f8c35ad62b009\n(4) 0x064874a46fc29fd15736cc0c890276fe1dfb9ecc\n(5) 0x2c612c461690ab601977595028ba1ed62e98d605\n(6) 0x50a317d18a78e4ad8491c0696582da35ba30b12a\n(7) 0xdf68b82ac51d21c731b8aa3c9c1d65c62ffb1b75\n(8) 0x018c7c87900304eeff2f852def58776b920b9da2\n(9) 0xdc2fe4385c54349c0303e448333a5de1131bc88e\n\nPrivate Keys:\n(0) 0895ef2194a15575ac9e75c5c837853637af444442f7b64dcea60029e68df5f6\n(1) 1ca9f748b4d92ca6b9ffcc4f0027a17189871f250666fa20c08bc901a6757174\n(2) 97e256de57f8206741223fe20953d047429b85f8a0ed5ec00a459cbf6e5859c4\n(3) 7dc0ba635a4fe0af8be559446f34be036bc2aa055a34d81337601ba929b1892c\n(4) c2dc9ba56f683ba2090de3932ab991f60c6e08535d2a8ffcc4c3ddea4b9be2f8\n(5) e4943ce248e556559f5b5e0cc097215a440ca2dafcaddef9fbad79bef58e028d\n(6) fbe436944b525e468209299b0e35f93a287bc0c25411418f10a9c2292ccbca8f\n(7) 0381515a5f83c9c97683a370383f45a4d2c8de61299d8a0e03c2313a5ace2457\n(8) ed39e1a942bf3c48c744bd5282410c811c56dbbec2bd133d09c43cd005a31e7b\n(9) 2dd9fbe98b5a4bad9f619e260f99db699d5b80b3081c0bc283647b576e44b89a\n\nMnemonic: butter mention wealth vicious fancy plastic treat title filter excess witness bus\n\n\xe2\x9a\xa0\xef\xb8\x8f Important \xe2\x9a\xa0\xef\xb8\x8f : This mnemonic was created for you by Truffle. It is not secure.\nEnsure you do not use it on production blockchains, or else you risk losing funds.\n```\n\n4. Take a look at the smart contract `SimpleStorage.sol`. You can check it out in folder `contracts`.\n\nThis smart contract has:\n\n* A variable `storedData` to store a number\n* A function `get()` to return the number stored at variable `storedData`\n* A function `set()` to change the number stored at variable `storedData`\n\n5. Compile and migrate the smart contract. Note inside the development console we don\'t preface commands with truffle.\n\n> To make sure you\'re in the development console, the command prompt must be `truffle(develop)>`\n\n```shell\ncompile\n```\nThe `compile output` should be similar to:\n\n\n\n```shell\nmigrate\n```\n\nAnd the `migrate output` should be similar to:\n\n\n\n6. Running contract tests.\n\nOur box also comes with the file `TestSimpleStorage.js` for testing the smart contract. You can check it out in the `test` folder.\n\nRun this command in the development console:\n\n```shell\ntest\n```\n\nThis `test output` should be similar to:\n\n\n\n**NOTE**: This box is the starting point for the RSK tutorial [Using rsk-starter-box](https://developers.rsk.co/tutorials/truffle-boxes/rsk-starter-box/).\n\n## Using RSK networks\n\nTruffle makes developing on RSK easier because we can configure custom networks for RSK. The networks are already configured in the `truffle-config.js` file.\n\n### Setup an account & get R-BTC\n\n- Get an address using [these instructions](https://developers.rsk.co/rsk/architecture/account-based/ "Account Based RSK Addresses - RSK Developers Portal").\n- For the RSK Testnet, get tR-BTC from [our faucet](https://faucet.testnet.rsk.co/).\n- For the RSK Mainnet, get R-BTC from [an exchange](https://www.rsk.co/#exchanges-rsk).\n\nTake a look `truffle-config.js` file to realize that we are using `HDWalletProvider` with RSK Networks derivations path:\n- RSK Testnet dpath: `m/44\xe2\x80\x99/37310\xe2\x80\x99/0\xe2\x80\x99/0`\n- RSK Mainnet dpath: `m/44\xe2\x80\x99/137\xe2\x80\x99/0\xe2\x80\x99/0`\n\nFor more information check [RSKIP57](https://github.com/rsksmart/RSKIPs/blob/master/IPs/RSKIP57.md).\n\n### Update your mnemonic\n\nPaste the wallet mnemonic in the file `.secret`, located in the folder project, and save it.\n\n### Setup the gas price\n\n**Gas** is the internal pricing for running a transaction or contract. When you send tokens, interact with a contract, send R-BTC, or do anything else on the blockchain, you must pay for that computation. That payment is calculated as gas. In RSK, this is paid in **R-BTC**.\nThe **minimumGasPrice** is written in the block header by miners and establishes the minimum gas price that a transaction should have in order to be included in that block.\n\nTo update the **minimumGasPrice** in our project run this query using cURL:\n\n**Testnet**\n\n```shell\ncurl https://public-node.testnet.rsk.co/ -X POST -H "Content-Type: application/json" \\\n --data \'{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false],"id":1}\' \\\n > .minimum-gas-price-testnet.json\n```\n\n**Mainnet**\n\n```shell\ncurl https://public-node.rsk.co/ -X POST -H "Content-Type: application/json" \\\n --data \'{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false],"id":1}\' \\\n > .minimum-gas-price-mainnet.json\n```\n\nThis query saved the details of latest block to \nfile .minimum-gas-price-testnet.json \nor .minimum-gas-price-mainnet.json, respectively.\n\nIn the `truffle-config.js`, we are reading the parameter `minimumGasPrice` in each json file.\n\nFor more information about the **Gas** and **minimumGasPrice** please go [here](https://developers.rsk.co/rsk/rbtc/gas/ "Gas - RSK Developers Portal").\n\n### Connect to RSK network\n\nRun the truffle console for any RSK network.\n\n```shell\n# Console for Mainnet\ntruffle console --network mainnet\n\n# Console forn Testnet\ntruffle console --network testnet\n```\n\n### Compile and migrate the smart contracts\n\nWe will do it running the below commands directly in the terminal, without using the truffle console, this is to show you an alternative.\n\nOn any of the networks, run this commands in a terminal (not in Truffle console):\n\n```shell\ntruffle compile\n\ntruffle migrate\n```\n\n## Next steps\n\n- **Go to tutorial**\n\nGo to the tutorial [Using rsk-starter-box](https://developers.rsk.co/tutorials/truffle-boxes/rsk-starter-box/) to learn how to interact with `SimpleStorage.sol`. Also, we covered all the steps with more details, explanations, and images.\n\n- **Find more documentation**\n\nCheck out the [RSK developers portal](https://developers.rsk.co/).\n\n- **Do you have questions?**\n\nAsk in [RSK chat](https://gitter.im/rsksmart/getting-started).\n'