diff --git a/vmware-blockchain-ethereum-developer-kit/README.md b/vmware-blockchain-ethereum-developer-kit/README.md index 1d814af04..b0dc85375 100644 --- a/vmware-blockchain-ethereum-developer-kit/README.md +++ b/vmware-blockchain-ethereum-developer-kit/README.md @@ -20,107 +20,6 @@ Using the developer kit, Ethereum developer(s) can start developing or porting t | RAM | 12 GB of RAM or more | | Disk Space | 50 GB of free disk space or more | -# Pre-requisites - System Software for Linux -| Software | Versions | -|-----------|-------------| -| minikube |1.25.1 or more https://minikube.sigs.k8s.io/docs/start/ | -| Kubectl |Client Version: v1.23.4 or more -| |Server Version: v1.23.1 or more https://kubernetes.io/docs/tasks/tools/ | -| docker | 18.06.1-ce, build e68fc7a or above https://docs.docker.com/engine/install/ubuntu/ | - -# Pre-requisites - System Software for macOS -| Software | Versions | -|-----------|-------------| -| minikube | 1.25.1 or more https://minikube.sigs.k8s.io/docs/start/ | -| Kubectl | Client Version: v1.23.4 or more | -| | Server Version: v1.23.1 or more https://kubernetes.io/docs/tasks/tools/ | -| VirutalBox | 6.x https://www.virtualbox.org/wiki/Downloads | - -# Pre-requisites - Install Python modules -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit -pip3 install -r vmbc/config/requirements.txt -``` -# Pre-requisites - Starting Minikube -See scripts under`minikube` folder that provides convenience scripts to start and delete minikube. -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/minikube -./minikube-start.sh -``` -## Make sure 'minikube status' has the expected output described below. -``` -minikube status - -minikube -type: Control Plane -host: Running -kubelet: Running -apiserver: Running -kubeconfig: Configured -``` -# VMware Blockchain Change directory -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/vmbc/script -``` -# VMware Blockchain Set the username and password -``` -./vmbc-cli --set-username-password --username username --password password -``` -# VMware Blockchain Deployment -``` -./vmbc-cli --deployment-type PROVISION -``` -After successful completion of the above provision command, VMBC_URL (VMware Blockchain Deployment URL) will be printed on the console. An example would be VMBC_URL=http://192.168.49.2:30545. Note that the IP address could be different in your minkikube setup. - -In case you have already provisioned VMBC, VMBC_URL is available in ./vmbc/.env.config. - -For VMware Blockchain Deployment, the chainid is 5000. - -If you are using Metamask, in the add network section, please make sure to use the above VMBC_URL and chainid 5000. - -If you are using Hardhat, replace the url with the above VMBC_URL and chainid with 5000 in hardhat.config.ts. An example would be in the "networks" section, "concord" endpoint in https://github.com/vmware-samples/vmware-blockchain-samples/blob/master/hardhat/hardhat.config.ts. - -# VMware Blockchain Healthcheck -``` -./vmbc-cli --healthcheck -``` -# VMware Blockchain Gas Free Mode for Ethereum -In the public Ethereum network, gas refers to the cost necessary to perform a transaction on the network. Miners set the price of gas based on supply and demand for the computational power of the network needed to process smart contracts and other transactions. Requiring a fee for every transaction executed on the network provides a layer of security to the Ethereum network by making it too expensive for malicious users to spam the network. VMware Blockchain is a private, permissioned, and managed network, therefore it is not necessary to charge for computation power. In addition, the SBFT protocol it uses protects it from byzantine attacks. Since gas fees are not needed, VMBC supports a gas-free mode which simplifies Dapp deployment. - - -# Deploy Block Explorer (Optional) -Block Explorer can be used to view and search ethereum transactions and blocks in the VMware Blockchain deployment -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/explorer -./k8s-explorer-launch.sh -``` -# Deploy ELK stack (Optional) -Elasticsearch can be used to search and view system logs in the VMware Blockchain deployment -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/elk - -./elk-elastic-launch.sh ; ( make sure that elasticsearch is working before moving further ) - -./elk-kibana-launch.sh ; ( make sure that kibana is working before moving further ) - -./elk-fluentd-lanch.sh -``` -# Deploy sample dapp (Optional) -This Dapp demonstrates swapping of ERC-20 tokens across different ethereum accounts -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/dapp -./k8s-dapp-launch.sh -``` -# VMware Blockchain Deployment Cleanup -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/vmbc/script -./vmbc-cli --deployment-type DEPROVISION -``` -# Minikube Cleanup -``` -cd vmware-blockchain-samples/vmware-blockchain-ethereum-developer-kit/minikube -./minikube-delete.sh -``` # Popular tools to use with VMware Blockchain Ethereum Developer Kit Hardhat @@ -134,7 +33,7 @@ Mythril # Supported JSON-RPC API endpoints **API reference**: https://ethereum.org/en/developers/docs/apis/json-rpc/ - +``` eth_accounts eth_blockNumber @@ -180,3 +79,4 @@ eth_sendTransaction net_listening net_version +``` \ No newline at end of file