| commit | 0cc4ad1a779ea309ccbef19296b21fcfc221534f | [log] [tgz] |
|---|---|---|
| author | gopuman <gopuman@node0.gopuman-216998.resilientdb-pg0.utah.cloudlab.us> | Wed Sep 11 15:30:37 2024 -0600 |
| committer | gopuman <gopuman@node0.gopuman-216998.resilientdb-pg0.utah.cloudlab.us> | Wed Sep 11 15:30:37 2024 -0600 |
| tree | 57502da35759385502f582b77b4b29f3a7c7c091 | |
| parent | d7964cd999ed72e6360ef2504e50635ee9b68a2f [diff] |
Fixed error during installation
The ResDB Smart Contracts CLI is a tool for creating, deploying, and managing smart contracts within the ResilientDB ecosystem. It is designed to work seamlessly with other ResilientDB projects, providing a streamlined interface for developers.
Before installing and using the Smart Contracts CLI, ensure you have the following prerequisites installed on your system:
solc is required to compile the smart contracts. Install solc on Linux using the following commands:
sudo add-apt-repository ppa:ethereum/ethereum sudo apt-get update sudo apt-get install -y solc
Node.js and npm are required to run the Smart Contracts CLI. Follow the instructions below to install them based on your operating system.
sudo apt update sudo apt install -y nodejs npm
brew update
brew install node
config.js ⚙️ResDB_HomeThe ResDB_Home path points to the directory where the ResilientDB installation resides. This path allows the CLI to locate and execute ResilientDB-related binaries and scripts.
config.js ImplementationThe config.js file contains logic to prompt the user for the ResDB_Home path the first time they use the CLI and then stores this path for future use. Here’s how it works:
ResDB_Home environment variable is already set.~/.smart-contracts-cli-config.json) to see if the ResDB_Home path has been saved previously.ResDB_Home path if neither the environment variable nor the configuration file provides it.const path = require('path'); const inquirer = require('inquirer'); const fs = require('fs-extra'); const os = require('os'); const CONFIG_FILE_PATH = path.join(os.homedir(), '.smart-contracts-cli-config.json'); async function getResDBHome() { if (process.env.ResDB_Home) { return process.env.ResDB_Home; } if (await fs.pathExists(CONFIG_FILE_PATH)) { const config = await fs.readJson(CONFIG_FILE_PATH); if (config.resDBHome) { process.env.ResDB_Home = config.resDBHome; return config.resDBHome; } } return null; } async function setResDBHome(resDBHome) { process.env.ResDB_Home = resDBHome; await fs.writeJson(CONFIG_FILE_PATH, { resDBHome }); } async function promptForResDBHome() { const answers = await inquirer.prompt([ { type: 'input', name: 'resDBHome', message: 'Please enter the ResDB_Home path:', }, ]); const resDBHome = answers.resDBHome; await setResDBHome(resDBHome); return resDBHome; } module.exports = { getResDBHome, setResDBHome, promptForResDBHome, };
To get started with the ResDB Smart Contracts CLI:
sudo npm install -g.smart-contracts-cli <command> <options>.ResDB_Home path.The create command initializes a new account using ResilientDB's smart contract tools.
smart-contracts-cli create --config <path_to_config>
path_to_config: Path to the configuration file.The compile command compiles a Solidity smart contract into a JSON file using solc.
smart-contracts-cli compile -s <inputFile.sol> -o <outputFile.json>
inputFile.sol: Path to the Solidity smart contract file.outputFile.json: Name of the resulting JSON file.Make sure solc (Solidity compiler) is installed on your system. Refer to the Prerequisites section in the README for installation instructions.
The deploy command deploys the smart contract.
smart-contracts-cli deploy --config <service.config> --contract <contract.json> \ --name <tokenName> --arguments <parameters> --owner <address>
service.config: Client configuration pathcontract.json: Path to the contract json filetokenName: Name of the contract createdparameters: Parameters to create the contract objectaddress: Contract owner's addressThe execute command executes a smart contract function using ResilientDB's smart contract tools.
smart-contracts-cli execute --config <service.config> --sender <senderAddress> \ --contract <contractAddress> --function <functionName> --arguments <parameters>
service.config: Path to the client configuration file.senderAddress: Address of the sender executing the function.contractAddress: Address of the deployed contract.functionName: Name of the function to execute.parameters: Arguments to pass to the function.Example:
smart-contracts-cli execute --config service/tools/config/interface/service.config \ --sender 0x67c6697351ff4aec29cdbaabf2fbe3467cc254f8 \ --contract 0xfc08e5bfebdcf7bb4cf5aafc29be03c1d53898f1 \ --function "transfer(address,uint256)" \ --arguments "0x1be8e78d765a2e63339fc99a66320db73158a35a,100"