Using Web3.js to Deploy Smart Contracts on Moonbeam¶
Introduction¶
This guide walks you through the process of using the Solidity compiler and web3.js to deploy and interact with a Solidity-based smart contract on a Moonbeam standalone node. Given Moonbeam’s Ethereum compatibility features, the web3.js library can be used directly with a Moonbeam node.
The guide assumes that you have a local Moonbeam node running in --dev mode. You can find instructions to set up a local Moonbeam node here.
Note
This tutorial was created using the v3 release of Moonbase Alpha. The Moonbeam platform, and the Frontier components it relies on for Substrate-based Ethereum compatibility, are still under very active development. The examples in this guide assume an Ubuntu 18.04-based environment and will need to be adapted accordingly for MacOS or Windows.
Checking Prerequisites¶
If you followed the "Setting Up a Node" tutorial, you should have a local Moonbeam node producing blocks that looks like this:
In addition, for this tutorial, we need to install Node.js (we'll go for v15.x) and the npm package manager. You can do this by running in your terminal:
curl -sL https://deb.nodesource.com/setup_15.x | sudo -E bash -
sudo apt install -y nodejs
We can verify that everything installed correctly by querying the version for each package:
node -v
npm -v
As of the writing of this guide, versions used were 15.2.1 and 7.0.8, respectively.
Next, we can create a directory to store all our relevant files (in a separate path from the local Moonbeam node files) by running:
mkdir incrementer && cd incrementer/
And create a simple package.json file:
npm init --yes
With the package.json file created, we can then install both the web3.js and the Solidity compiler (fixed at version v0.7.4) packages, by executing:
npm install web3
npm install solc@0.7.4
To verify the installed version of web3.js or the Solidity compiler you can use the ls command:
npm ls web3
npm ls solc
As of the writing of this guide, versions used were 1.3.0 and 0.7.4 (as mentioned before), respectively.
Our setup for this example is going to be pretty simple. We are going to have the following files:
- Incrementer.sol: the file with our Solidity code
- compile.js: it will compile the contract with the Solidity compiler
- deploy.js: it will handle the deployment to our local Moonbeam node
- get.js: it will make a call to the node to get the current value of the number
- increment.js: it will make a transaction to increment the number stored on the Moonbeam node
- reset.js: the function to call that will reset the number stored to zero
The Contract File and Compile Script¶
The contract file¶
The contract we will use is a very simple incrementer (arbitrarily named Incrementer.sol, and which you can find here). The Solidity code is the following:
pragma solidity ^0.7.4;
contract Incrementer {
uint256 public number;
constructor(uint256 _initialNumber) public {
number = _initialNumber;
}
function increment(uint256 _value) public {
number = number + _value;
}
function reset() public {
number = 0;
}
}
Our constructor function, that runs when the contract is deployed, sets the initial value of the number variable that is stored in the Moonbeam node (default is 0). The increment function adds _value provided to the current number, but a transaction needs to be sent as this modifies the stored data. And lastly, the reset function resets the stored value to zero.
Note
This contract is just a simple example that does not handle values wrapping around, and it is only for illustration purposes.
The compile file¶
The only purpose of the compile.js file (arbitrarily named, and which you can find here), is to use the Solidity compiler to output the bytecode and interface of our contract.
First, we need to load the different modules that we will use for this process. The path and fs modules are included by default in Node.js (that is why we didn't have to install it before).
Next, we have to read the content of the Solidity file (in UTF8 encoding).
Then, we build the input object for the Solidity compiler.
And finally, we run the compiler and extract the data related to our incrementer contract because, for this simple example, that is all we need.
const path = require('path');
const fs = require('fs');
const solc = require('solc');
// Compile contract
const contractPath = path.resolve(__dirname, 'Incrementer.sol');
const source = fs.readFileSync(contractPath, 'utf8');
const input = {
language: 'Solidity',
sources: {
'Incrementer.sol': {
content: source,
},
},
settings: {
outputSelection: {
'*': {
'*': ['*'],
},
},
},
};
const tempFile = JSON.parse(solc.compile(JSON.stringify(input)));
const contractFile = tempFile.contracts['Incrementer.sol']['Incrementer'];
module.exports = contractFile;
The Deploy Script and Interacting with our Contract¶
The deploy file¶
The deployment file (which you can find here) is divided into two subsections: the initialization and the deploy contract.
First, we need to load our web3.js module and the export of the compile.js file, from which we will extract the bytecode and abi.
Next, define the privKey variable as the private key of our genesis account, which is where all the funds are stored when deploying your local Moonbeam node, and what is also used to sign the transactions. The address is needed to specify the form value of the transaction.
And lastly, create a local Web3 instance, where we set the provider to connect to our local Moonbeam node.
To deploy the contract, we create an asynchronous function to handle the transaction promises. First, we need to create a local instance of our contract using the web3.eth.Contract(abi), from which we will call the deploy function. For this function, provide the bytecode and the arguments input of the constructor function. In our case, this was just one that was arbitrarily set to five.
Then, to create the transaction, we use the web3.eth.accounts.signTransaction(tx, privKey) command, where we have to define the tx object with some parameters such as: from address, the encoded abi from the previous step, and the gas limit. The private key must be provided as well to sign the transaction.
const Web3 = require('web3');
const contractFile = require('./compile');
// Initialization
const bytecode = contractFile.evm.bytecode.object;
const abi = contractFile.abi;
const privKey =
'99B3C12287537E38C90A9219D4CB074A89A16E9CDB20BF85728EBD97C343E342'; // Genesis private key
const address = '0x6Be02d1d3665660d22FF9624b7BE0551ee1Ac91b';
const web3 = new Web3('http://localhost:9933');
// Deploy contract
const deploy = async () => {
console.log(`Attempting to deploy from account: ${address}`);
const incrementer = new web3.eth.Contract(abi);
const incrementerTx = incrementer.deploy({
data: bytecode,
arguments: [5],
});
const createTransaction = await web3.eth.accounts.signTransaction(
{
from: address,
data: incrementerTx.encodeABI(),
gas: await incrementerTx.estimateGas(),
},
privKey
);
const createReceipt = await web3.eth.sendSignedTransaction(
createTransaction.rawTransaction
);
console.log(`Contract deployed at address ${createReceipt.contractAddress}`);
};
deploy();
To get the estimated gas to deploy this contract we can use the estimateGas method. This can differ from the actual gas consumed at the moment of execution but can provide a reference value.
With the transaction message created and signed (you can console.log(createTransaction) to see the v-r-s values), we can now deploy it using the web3.eth.sendSignedTransaction(signedTx) by providing the rawTransaction from the createTransaction object. Lastly, we run our deploy function.
Note
The deploy.js script provides the contract address as an output. This comes handy as it is used for the contract interaction files.
Files to interact with the contract¶
In this section, we will quickly go over the files that interact with our contract, either by making calls or sending transactions to it.
First, let's overview the get.js file (the simplest of them all, which you can find here), that fetches the current value stored in the Moonbeam node. We need to load our Web3 module and the export of the compile.js file, from which we will extract the abi.
Next, we create a local Web3 instance. And lastly, we need to provide the contract address (which is log in the console by the deploy.js file).
The following step is to create a local instance of the contract by using the web3.eth.Contract(abi, contractAddress) command. Then, wrapped in an async function, we can write the contract call by running contractInstance.methods.myMethods(), where we set the method or function that we want to call and provide the inputs for this call. This promise returns the data that we can log in the console. And lastly, we run our get function.
const Web3 = require('web3');
const { abi } = require('./compile');
// Initialization
const web3 = new Web3('http://localhost:9933');
const contractAddress = '0xC2Bf5F29a4384b1aB0C063e1c666f02121B6084a';
// Contract Call
const incrementer = new web3.eth.Contract(abi, contractAddress);
const get = async () => {
console.log(`Making a call to contract at address ${contractAddress}`);
const data = await incrementer.methods.number().call();
console.log(`The current number stored is: ${data}`);
};
get();
Let's now define the file to send a transaction that will add the value provided to our number. The increment.js file (which you can find here) is somewhat different to the previous example, and that is because here we are modifying the stored data, and for this, we need to send a transaction that pays gas. However, the initialization part of the file is similar. The only differences are that the private key must be defined for signing and that we've defined a _value that corresponds to the value to be added to our number.
The contract transaction starts by creating a local instance of the contract as before, but when we call the corresponding incrementer(_value) method, where we pass in _value.
Then, as we did when deploying the contract, we need to create the transaction with the corresponding data (wrapped in a async function), sign it with the private key, and send it. Note that we are calculating the gas using the estimateGas method as before. Lastly, we run our incrementer function.
const Web3 = require('web3');
const { abi } = require('./compile');
// Initialization
const privKey =
'99B3C12287537E38C90A9219D4CB074A89A16E9CDB20BF85728EBD97C343E342'; // Genesis private key
const address = '0x6Be02d1d3665660d22FF9624b7BE0551ee1Ac91b';
const web3 = new Web3('http://localhost:9933');
const contractAddress = '0xC2Bf5F29a4384b1aB0C063e1c666f02121B6084a';
const _value = 3;
// Contract Tx
const incrementer = new web3.eth.Contract(abi, contractAddress);
const incrementTx = incrementer.methods.increment(_value);
const increment = async () => {
console.log(
`Calling the increment by ${_value} function in contract at address ${contractAddress}`
);
const createTransaction = await web3.eth.accounts.signTransaction(
{
from: address,
to: contractAddress,
data: incrementTx.encodeABI(),
gas: await incrementTx.estimateGas(),
},
privKey
);
const createReceipt = await web3.eth.sendSignedTransaction(
createTransaction.rawTransaction
);
console.log(`Tx successfull with hash: ${createReceipt.transactionHash}`);
};
increment();
The reset.js file (which you can find here), is almost identical to the previous example. The only difference is that we need to call the reset() method which takes no input. In this case, we are manually setting the gas limit of the transaction to 40000, as the estimatedGas() method returns an invalid value (something we are working on).
const Web3 = require('web3');
const { abi } = require('./compile');
// Initialization
const privKey =
'99B3C12287537E38C90A9219D4CB074A89A16E9CDB20BF85728EBD97C343E342'; // Genesis private key
const address = '0x6Be02d1d3665660d22FF9624b7BE0551ee1Ac91b';
const web3 = new Web3('http://localhost:9933');
const contractAddress = '0xC2Bf5F29a4384b1aB0C063e1c666f02121B6084a';
// Contract Tx
const incrementer = new web3.eth.Contract(abi, contractAddress);
const resetTx = incrementer.methods.reset();
const reset = async () => {
console.log(
`Calling the reset function in contract at address ${contractAddress}`
);
const createTransaction = await web3.eth.accounts.signTransaction(
{
from: address,
to: contractAddress,
data: resetTx.encodeABI(),
gas: '40000',
},
privKey
);
const createReceipt = await web3.eth.sendSignedTransaction(
createTransaction.rawTransaction
);
console.log(`Tx successfull with hash: ${createReceipt.transactionHash}`);
};
reset();
Interacting with the Contract¶
With all the files ready, we can proceed to deploy our contract the local Moonbeam node. To do this, we execute the following command in the directory where all the files are:
node deploy.js
After a successful deployment, you should get the following output:
First, let's check and confirm that that the value stored is equal to the one we passed in as the input of the constructor function (that was 5), we do this by running:
node get.js
With the following output:
Then, we can use our incrementer file, remember that _value = 3. We can immediately use our getter file to prompt the value after the transaction:
node incrementer.js
node get.js
With the following output:
Lastly, we can reset our number by using the reset file:
node reset.js
node get.js
With the following output:
We Want to Hear From You¶
This example provides context on how you can start working with Moonbeam and how you can try out its Ethereum compatibility features such as the web3.js library. We are interested in hearing about your experience following the steps in this guide or your experience trying other Ethereum-based tools with Moonbeam. Feel free to join us in the Moonbeam Discord here. We would love to hear your feedback on Moonbeam and answer any questions that you have.