Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend example usages for all client methods in the readme.md #7

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

blouflashdb
Copy link
Owner

@blouflashdb blouflashdb commented Jan 12, 2025

Extend example usages for all client methods in the README.md file.

  • BlockchainClient
    • Add example usage for getBlockNumber
    • Add example usage for getBlockByHash
  • BlockchainStream
    • Add example usage for subscribeForBlockHashes
  • ConsensusClient
    • Add example usage for isConsensusEstablished
    • Add example usage for sendTransaction
  • MempoolClient
    • Add example usage for pushTransaction
    • Add example usage for mempoolContent
  • NetworkClient
    • Add example usage for getPeerId
    • Add example usage for getPeerCount
  • PolicyClient
    • Add example usage for getPolicyConstants
    • Add example usage for getEpochAt
  • SerdeHelper
    • Add example usage for serializeToHex
    • Add example usage for deserializeFromHex
  • ValidatorClient
    • Add example usage for getAddress
    • Add example usage for isElected
  • WalletClient
    • Add example usage for importRawKey
    • Add example usage for createAccount
  • ZkpComponentClient
    • Add example usage for getZkpState

For more details, open the Copilot Workspace session.

Extend example usages for all client methods in the `README.md` file.

* **BlockchainClient**
  - Add example usage for `getBlockNumber`
  - Add example usage for `getBlockByHash`
* **BlockchainStream**
  - Add example usage for `subscribeForBlockHashes`
* **ConsensusClient**
  - Add example usage for `isConsensusEstablished`
  - Add example usage for `sendTransaction`
* **MempoolClient**
  - Add example usage for `pushTransaction`
  - Add example usage for `mempoolContent`
* **NetworkClient**
  - Add example usage for `getPeerId`
  - Add example usage for `getPeerCount`
* **PolicyClient**
  - Add example usage for `getPolicyConstants`
  - Add example usage for `getEpochAt`
* **SerdeHelper**
  - Add example usage for `serializeToHex`
  - Add example usage for `deserializeFromHex`
* **ValidatorClient**
  - Add example usage for `getAddress`
  - Add example usage for `isElected`
* **WalletClient**
  - Add example usage for `importRawKey`
  - Add example usage for `createAccount`
* **ZkpComponentClient**
  - Add example usage for `getZkpState`

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/blouflashdb/nimiq-rpc?shareId=XXXX-XXXX-XXXX-XXXX).
@blouflashdb blouflashdb merged commit 74d553d into main Jan 12, 2025
1 check passed
@blouflashdb blouflashdb deleted the extend-readme-examples branch January 12, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant