Create instructions on how to create expose ports necessary to create an SDK connection to both the Consenus Nodes plus the Mirror Node

[jeromy-cannon]

Tasks

Preview Give feedback

1. Create a docs/content/User/SDK.md
2. Add a 'SDK Usage' + ref: "/User/SDK.md" element in docs/data/menu/main.yml
3. Reference instructions on how to create a client node and fill out the consensus node network manually, similar to how we do in solo using Client.fromConfig()
4. it looks like the mirror node can also be configured inside there: https://github.com/hashgraph/hedera-sdk-js/blob/ac4914112cb80deadd12ac350e19e27b06d43bf1/src/client/Client.js#L54-L54, or alternatively use nodeClient.setMirrorNetwork()
5. we should add a test case to verify that it works correctly
6. we need to ensure that we are providing the steps to expose the port forwards for both the consenus nodes as well as the mirror node network

[JeffreyDallas]

setMirrorNetwork shown as not implemented yet

https://github.com/hashgraph/hedera-sdk-js/blob/e44cdf846c99107976d07bc1d7b4476a060aacff/src/client/Client.js#L240
https://github.com/hashgraph/hedera-sdk-js/blob/e44cdf846c99107976d07bc1d7b4476a060aacff/src/client/Client.js#L735

[leninmehedy]

@JeffreyDallas and @jeromy-cannon I was thinking of the outline below where someone would be able to setup a network, accounts and use a code example to query the network. We could use it for a technical workshop.

Table of contents:

• Setup a network using solo
• Create account using solo
• Top-up account (e.g. with 10000 HBAR) using solo
• Retrieve account keys (DER encoded private key)
  (use kubectl command to retrieve from secrets unless solo allows to retrieve it)
• Create your .env File with MY_ACCOUNT_ID and MY_PRIVATE_KEY (DER encoded private key): Something like https://docs.hedera.com/hedera/getting-started/environment-set-up#step-3-create-your-.env-file)
• Expose consensus node port (50211) to different ports using kubectl

  # for example, please test and update as required
   kubectl port-forward svc/haproxy-node0-svc -n solo 50211:30311 &
   kubectl port-forward svc/haproxy-node1-svc -n solo 50211:30411 &
   kubectl port-forward svc/haproxy-node2-svc -n solo 50211:30511 &

• Create a JS SDK client and query ledger
  (We need to provide a working code that uses JS SDK and the solo provisioned network. Existing doc provides example of using testnet, but people should be using a local network for testing)
  • Load MY_ACCOUNT_ID and MY_PRIVATE_KEY from .env file (need to provide code example like here: https://docs.hedera.com/hedera/getting-started/environment-set-up#step-3-create-your-.env-file)
  • prepare network object which is a map of: host:port: accountId (we should load from the .env file since port exposure is manual and people don't need to change code if ports are changed)

  {
    "127.0.0.1:30311": "0.0.3"
    "127.0.0.1:30411": "0.0.4"
    "127.0.0.1:30511": "0.0.5"
  }
  

  • Use: this._nodeClient = Client.fromConfig({ network: network, scheduleNetworkUpdate: false })
  • Set operator-key and operator-id: this._nodeClient.setOperator(operatorId, operatorKey)
  • Query the account balance:

    solo/src/commands/node/tasks.ts

    Line 459 in 356f341

    const balance = await new AccountBalanceQuery()

*** We may provide examples of other SDK (Java & GO) separately or in the same doc ***

[JeffreyDallas]

Great suggestion, I just started yesterday with some sample code

main...00816-D-client-doc-example

One thing I would suggest is that an solo end user may not care about what is under hood, they
just want a hedera network to interact with their apps.

So we should do as much as possible to avoid them to touch kubectl or anything cluster specific commands.
maybe we could have a solo create account command that will display newly created account id
and private key, so user does not need the trouble to retrieve it with kubectl

[jeromy-cannon]

@leninmehedy , yes, this is similar to what I was thinking as well. We have an example folder already created as well.

[swirlds-automation]

🎉 This issue has been resolved in version 0.32.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀