Nano RPC client

A simple and strongly typed client for Nano's RPC, written in Typescript.

Usage

In node, you have to provide a fetch function

1import NanoRpcClient from 'nano-rpc-client'
2import nodeFetch from 'node-fetch'
3
4const client = new NanoRpcClient('https://my.nano.node/rpc', nodeFetch)

---

If you're in the browser, window.fetch is used by default

1import NanoRpcClient from 'nano-rpc-client'
2
3const client = new NanoRpcClient('https://my.nano.node/rpc')

---

RPC command arguments and their results are strongly typed

1const info = await client.accountInfo('nano_1pnano1yzoxyk11geczosh1bwh97w5t1kfmokwz8hkgiy55h6a7rz6dyr1tm')
2
3info.balance // this is a bigint
4info.confirmedBalance // this throws an error at compile time because it doesn't exist
5
6const confirmedInfo = await client.accountInfo('nano_1pnano1yzoxyk11geczosh1bwh97w5t1kfmokwz8hkgiy55h6a7rz6dyr1tm', { includeConfirmed: true })
7
8confirmedInfo.confirmedBalance // this exists (and is a bigint) at compile time because you added the `includeConfirmed` option

---

You can pass an AbortSignal to all calls to cancel them

1const controller = new AbortController()
2
3const confirmedInfo = await client.accountInfo('nano_1pnano1yzoxyk11geczosh1bwh97w5t1kfmokwz8hkgiy55h6a7rz6dyr1tm', undefined, { abortSignal: controller.signal })
4
5if('someCondition')
6    controller.abort()

---

Errors in the RPC command (normally returned in the body) are thrown as RpcErrors that contain a message

1try {
2    const info = await client.accountInfo('')
3} catch (e) {
4    console.log(e.message) // logs "Bad account number"
5}

Goals

• To be the de facto JS RPC client, with strong argument typing and great autocomplete
• To eventually be included as an official package of the nano ecosystem (meaning, distributed under an easily recognizable name like @nano/rpc or @nano-utils/rpc or something like that)
• To support the most current version of the RPC spec
• In the future, validate arguments before the request is made (for example, validate nano address strings or number strings)

Non-goals

• To support versions of the RPC spec other than latest