Smart contracts for RSK are written using Solidity (a Javascript like programming language) and are fully compatible with Ethereum Smart Contracts, so you can migrate your existing Ethereum Smart Contract to RSK without changing the smart contract.
New to Solidity? You can learn more using the Solidity docs.
You can edit Solidity using any text editor but it is a good idea to use more advanced tools, the following is a list of some of them:
Truffle is an open source framework that facilitates the testing and development of smart contracts. It allows you to connect to a local RSK node and call the compiler, run unit tests, and publish your smart contracts easily. Check out this tutorial which demonstrates the usage of Truffle and Ganache with a local RSK node.
In this tutorial, we will use Truffle for compiling and publishing our smart contracts.
Enter the following commands in the terminal to install truffle on your local machine
npm install -g truffle
Then create a new folder and a truffle project using the commands below:
mkdir rsk-truffle-example
cd rsk-truffle-example
truffle init
The init command will create 3 folders and a configuration file for this project. The solidity files are in the contracts folder.
In this tutorial, we are going to use the token contract code from [Consensys/Token] (https://github.com/ConsenSys/Tokens) as the example.
Now create two files named EIP20.sol
and EIP20Interface.sol
:
pragma solidity ^0.4.21;
contract EIP20Interface {
/* This is a slight change to the ERC20 base standard.
function totalSupply() constant returns (uint256 supply);
is replaced with:
uint256 public totalSupply;
This automatically creates a getter function for the totalSupply.
This is moved to the base contract since public getter functions are not
currently recognised as an implementation of the matching abstract
function by the compiler.
*/
/// total amount of tokens
uint256 public totalSupply;
/// @param _owner The address from which the balance will be retrieved
/// @return The balance
function balanceOf(address _owner) public view returns (uint256 balance);
/// @notice send `_value` token to `_to` from `msg.sender`
/// @param _to The address of the recipient
/// @param _value The amount of token to be transferred
/// @return Whether the transfer was successful or not
function transfer(address _to, uint256 _value) public returns (bool success);
/// @notice send `_value` token to `_to` from `_from` on the condition it is approved by `_from`
/// @param _from The address of the sender
/// @param _to The address of the recipient
/// @param _value The amount of token to be transferred
/// @return Whether the transfer was successful or not
function transferFrom(address _from, address _to, uint256 _value) public returns (bool success);
/// @notice `msg.sender` approves `_spender` to spend `_value` tokens
/// @param _spender The address of the account able to transfer the tokens
/// @param _value The amount of tokens to be approved for transfer
/// @return Whether the approval was successful or not
function approve(address _spender, uint256 _value) public returns (bool success);
/// @param _owner The address of the account owning tokens
/// @param _spender The address of the account able to transfer the tokens
/// @return Amount of remaining tokens allowed to spent
function allowance(address _owner, address _spender) public view returns (uint256 remaining);
// solhint-disable-next-line no-simple-event-func-name
event Transfer(address indexed _from, address indexed _to, uint256 _value);
event Approval(address indexed _owner, address indexed _spender, uint256 _value);
}
EIP20.sol:
pragma solidity ^0.4.21;
import "./EIP20Interface.sol";
contract EIP20 is EIP20Interface {
uint256 constant private MAX_UINT256 = 2**256 - 1;
mapping (address => uint256) public balances;
mapping (address => mapping (address => uint256)) public allowed;
/*
NOTE:
The following variables are OPTIONAL vanities. One does not have to include them.
They allow one to customise the token contract & in no way influences the core functionality.
Some wallets/interfaces might not even bother to look at this information.
*/
string public name; //fancy name: eg Simon Bucks
uint8 public decimals; //How many decimals to show.
string public symbol; //An identifier: eg SBX
function EIP20(
uint256 _initialAmount,
string _tokenName,
uint8 _decimalUnits,
string _tokenSymbol
) public {
balances[msg.sender] = _initialAmount; // Give the creator all initial tokens
totalSupply = _initialAmount; // Update total supply
name = _tokenName; // Set the name for display purposes
decimals = _decimalUnits; // Amount of decimals for display purposes
symbol = _tokenSymbol; // Set the symbol for display purposes
emit Transfer(msg.sender, msg.sender, 0);
emit Approval(msg.sender, msg.sender, 0);
}
function transfer(address _to, uint256 _value) public returns (bool success) {
require(balances[msg.sender] >= _value);
balances[msg.sender] -= _value;
balances[_to] += _value;
emit Transfer(msg.sender, _to, _value); //solhint-disable-line indent, no-unused-vars
return true;
}
function transferFrom(address _from, address _to, uint256 _value) public returns (bool success) {
uint256 allowance = allowed[_from][msg.sender];
require(balances[_from] >= _value && allowance >= _value);
balances[_to] += _value;
balances[_from] -= _value;
if (allowance < MAX_UINT256) {
allowed[_from][msg.sender] -= _value;
}
emit Transfer(_from, _to, _value); //solhint-disable-line indent, no-unused-vars
return true;
}
function balanceOf(address _owner) public view returns (uint256 balance) {
return balances[_owner];
}
function approve(address _spender, uint256 _value) public returns (bool success) {
allowed[msg.sender][_spender] = _value;
emit Approval(msg.sender, _spender, _value); //solhint-disable-line indent, no-unused-vars
return true;
}
function allowance(address _owner, address _spender) public view returns (uint256 remaining) {
return allowed[_owner][_spender];
}
}
We also need to create a migration script in the migration folder.
migrations/2_deploy_tokens.js
const EIP20 = artifacts.require('./EIP20.sol');
module.exports = (deployer) => {
deployer.deploy(EIP20, 10000, 'Simon Bucks', 1, 'SBX');
};
We are going to deploy the example smart contract on to RSK Testnet.
First, we need to obtain an account on RSK Testnet and get some tR-BTC from the Testnet faucet.
Create new Account with MetaMask
custom RPC
Get tR-BTC
Visit the faucet to gain some tR-BTC to use in the Testnet.
Enter the account address from MetaMask and wait several minutes for MetaMask to refresh the new balance.
Edit the truffle-config.js
to be same as the code below. The truffle-config.js
file directs Truffle to connect to the public Testnet node.
var HDWalletProvider = require('@truffle/hdwallet-provider')
var mnemonic = 'thing tuition ranch ... YOUR MNEMONIC'
var publicNode = 'https://public-node.testnet.rsk.co:443'
module.exports = {
networks: {
rskTestnet: {
provider: () =>
new HDWalletProvider(mnemonic, publicNode),
network_id: '*',
gas: 2500000,
gasPrice: 183000
}
},
compilers : {
solc: {
version: "0.4.24",
evmVersion: "byzantium"
}
}
}
Enter the following commands in the Terminal to compile and deploy the contracts.
truffle console --network rskTestnet
truffle compile
truffle migrate
Once the deployment is successful. We can call smart contract methods directly in the truffle console.
Check Account Balance
Enter the following command into truffle console.
EIP20.deployed().then((instance=>instance.balanceOf("0xa07982385a16f0C7a9eEbAD5F44d2093A2856997")))
EIP20 is the name of our contract. This command will print out the balance of account address 0xa07982385a16f0C7a9eEbAD5F44d2093A2856997
as a big number. To see it as an integer, change the command to
EIP20.deployed().then((instance=>instance.balanceOf("0xa07982385a16f0C7a9eEbAD5F44d2093A2856997").then(b=>b.toNumber())))
Transfer Token Directly Between Two Accounts
Now use the following command to transfer 1 token from the minter account to another account
EIP20.deployed().then((instance=>instance.transfer("0x7dadb9d442cfe7fc75fd472d63afc16934d7aa44", 1)))
After its successful execution, check the minter’s account again to see the change in balance.
EIP20.deployed().then((instance=>instance.balanceOf("0xa07982385a16f0C7a9eEbAD5F44d2093A2856997").then(b=>b.toNumber())))
Deploying Smart Contracts to RSK Mainnet can follow the same steps as the Testnet.
The public node of RSK Main Net is https://public-node.rsk.co
You will be able to check the Mainnet’s transactions and blocks in real time at explorer.rsk.co/
To deploy onto Mainnet, we need to get some R-BTC through the 2-way peg mechanism between BTC and R-BTC.
Go to top