While you are developing your application, you can use the Hedera supported networks (previewnet and testnet) to test your application against. In addition to using those networks, you have the option to set-up your own local consensus node and mirror node for testing purposes.
With your local network set-up you can:
Create and submit transactions and queries to a consensus node
Interact with the mirror node via REST APIs
1. Set-up your local network
Set-up your local network by following the instructions found in the readme of the hedera-local-node project. This will create a Hedera network composed of one consensus node and one mirror node. The consensus node will process incoming transactions and queries. The mirror node stores the history of transactions. Both nodes are created at startup.
2. Configure your network
Once you have your local network up and running, you will need to configure your Hedera client to point to your local network in your project of choice. Your project should have your language specific Hedera SDK as a dependency and imported into your project. You may reference the environment set-up instructions if you don't know how.
Your local network IP address and port will be 127.0.0.1:50211 and your local mirror node IP and port will be 127.0.0.1:5600. The consensus node account ID is 0.0.3. This is the node account ID that will receive your transaction and query requests. It is recommended to store these variables in an environment or config file. These values will be hard-coded in the example for demonstration purposes.
Configure your local network by using Client.forNetwork(). This allows you to set a custom consensus network by providing the IP address and port. Client.setMirrorNetwork() allows you to set a custom mirror node network by providing the IP address and port.
//Create your local clientClient client =Client.forNetwork(Collections.singletonMap("127.0.0.1:50211",AccountId.fromString("0.0.3"))).setMirrorNetwork(List.of("127.0.0.1:5600"));
//Create your local clientconstnode= {"127.0.0.1:50211":newAccountId(3)};constclient=Client.forNetwork(node).setMirrorNetwork("127.0.0.1:5600");
//Create your local clientnode :=make(map[string]hedera.AccountID, 1)node["127.0.0.1:50211"] =hedera.AccountID{Account: 3}mirrorNode := []string{"127.0.0.1:5600"}client := hedera.ClientForNetwork(node)client.SetMirrorNetwork(mirrorNode)
3. Set your local node transaction fee paying account
You will need and account ID and key to pay for the fees associated with each transaction and query that is submitted to your local network. You will use the account ID and key provided by the local node on startup to set-up your operator account ID and key. The operator is the default account that pays for transaction and query fees.
Note: It is not good practice to post your private keys in any public place. These keys are provided only for development and testing purposes only. They do not exist on any production networks.
Submit a transaction that will create a new account in your local network. The console should print out the new account ID. In this example, we are using the same key as the transaction fee paying account as the key for the new account. You can also create a new key if you wish.
//Submit a transaction to your local nodeTransactionResponse newAccount =newAccountCreateTransaction().setKey(PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137")).setInitialBalance(newHbar(1)).execute(client);//Get the receiptTransactionReceipt receipt =newAccount.getReceipt(client);//Get the account IDAccountId newAccountId =receipt.accountId;System.out.println(newAccountId);
//Submit a transaction to your local nodeconstnewAccount=awaitnewAccountCreateTransaction().setKey(PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137")).setInitialBalance(newHbar(1)).execute(client);//Get receiptconstreceipt=awaitnewAccount.getReceipt(client);//Get the account IDconstnewAccountId=receipt.accountId;console.log(newAccountId);
//Submit a transaction to your local nodenewAccount, err := hedera.NewAccountCreateTransaction().SetKey(privateKey).SetInitialBalance(hedera.HbarFromTinybar(1000)).Execute(client)if err !=nil {println(err.Error(), ": error getting balance")return}//Get receiptreceipt, err := newAccount.GetReceipt(client)//Get the account IDnewAccountId := receipt.AccountIDfmt.Print(newAccountId)
5. View your transaction
You can view the executed transaction by querying your local mirror node.
The local mirror node endpoint URL is http://localhost:5551/.
You can view the transactions that were submitted to your local node by submitting this request:
http://localhost:5551/api/v1/transactions
The list of supported mirror node REST APIs can be found here. You have now set-up your local environment. Check out the following links for more examples.
importcom.hedera.hashgraph.sdk.*;importjava.io.IOException;importjava.util.Collections;importjava.util.List;importjava.util.concurrent.TimeoutException;publicclassLocalNode {publicstaticvoidmain(String[] args) throwsTimeoutException,PrecheckStatusException,ReceiptStatusException,InterruptedException,IOException {//Create your local clientClient client =Client.forNetwork(Collections.singletonMap("127.0.0.1:50211",AccountId.fromString("0.0.3"))).setMirrorNetwork(List.of("127.0.0.1:5600"));//Set the transaction fee paying accountclient.setOperator(AccountId.fromString("0.0.2"),PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137"));//Submit a transaction to your local nodeTransactionResponse newAccount =newAccountCreateTransaction().setKey(PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137")).setInitialBalance(newHbar(1)).execute(client);//Get the receipt TransactionReceipt receipt =newAccount.getReceipt(client);//Get the account IDAccountId newAccountId =receipt.accountId;System.out.println(newAccountId); }}
const {Client,PrivateKey,Hbar,AccountId,AccountCreateTransaction,} =require("@hashgraph/sdk");asyncfunctionmain() {//Create your local clientconstnode= {"127.0.0.1:50211":newAccountId(3)}constclient=Client.forNetwork(node).setMirrorNetwork("127.0.0.1:5600");//Set the transaction fee paying accountclient.setOperator(AccountId.fromString("0.0.2"),PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137"));//Submit a transaction to your local nodeconstnewAccount=awaitnewAccountCreateTransaction().setKey(PrivateKey.fromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137")).setInitialBalance(newHbar(1)).execute(client);//Get receiptconstreceipt=awaitnewAccount.getReceipt(client);//Get the account IDconstnewAccountId=receipt.accountId;console.log(newAccountId); }voidmain();
packagemainimport ("fmt""github.com/hashgraph/hedera-sdk-go/v2")funcmain() {//Create your local node client node :=make(map[string]hedera.AccountID, 1) node["127.0.0.1:50211"] =hedera.AccountID{Account: 3} mirrorNode := []string{"127.0.0.1:5600"} client := hedera.ClientForNetwork(node) client.SetMirrorNetwork(mirrorNode)//Set the transaction fee paying account accountId, err := hedera.AccountIDFromString("0.0.2") privateKey, err := hedera.PrivateKeyFromString("302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137") client.SetOperator(accountId, privateKey)//Submit a transaction to your local node newAccount, err := hedera.NewAccountCreateTransaction().SetKey(privateKey).SetInitialBalance(hedera.HbarFromTinybar(1000)).Execute(client)if err !=nil {println(err.Error(), ": error getting balance")return }//Get receipt receipt, err := newAccount.GetReceipt(client)//Get the account ID newAccountId := receipt.AccountID fmt.Print(newAccountId)}