futureversecom / trn-js-api

The Root Network JS/TS API library for browsers and Node environments

The Root Network JavaScript API

Getting Started

Visit https://docs-beta.therootnetwork.com to get started with TRN JavaScript API

Packages

@therootnetwork/api

A utility package that complements the @polkadot/api to connect and interact with the Root Network node.

@therootnetwork/api-types

A utility package that supplements @therootnetwork/api, and makes Root Network specific types available from @polkadot/{api, types}/augment.

@therootnetwork/evm

A utility package that simplifies EVM development on the Root Network.

Provide Feedback

• Start a Discussion with a question, a piece of feedback, or an idea you want to share with the team.
• Open an Issue if you believe you've encountered a bug that you want to flag for the team.

Contribution

If you spot gaps in the information provided or are uncertain about any specific area, please do log an issue. Alternatively, if you are inclined that way, you can make a pull request.

trn-js-api's Issues

Allow option to return fail result if proxy call is failed

Currently, if call wrapped around Futurepass failed, it's a silent one. The error details is tucked inside the proxy.ProxyExecuted which is easy to miss.

We should look at adding option to fail the extrinsic when that happen just like when any other failed extrinsic https://github.com/futureversecom/trn-js-api/blob/main/packages/extrinsic/src/libs/send.ts#L36

It needs to be optional flag to avoid breaking changes downstream, as they might have had their own error catching logic.

The proposed location is a 3rd parameter to the send function

export async function send(
  extrinsicOrResult: Extrinsic | Result<Extrinsic, Error>,
  onProgress?: ProgressCallback,
  options: { failedIfProxyError: boolean } = { failedIfProxyError: false }
)

Provide option to use a full node instead of archive node

At the moment the getPublicProvider function only returns archive nodes, which can be a lot slower than full nodes. It would be nice to pass an option to this function to get the full nodes back instead.

`wrapWithFeeProxy` returns an error when trying estimate fee

As per the conversation here https://futureverse.slack.com/archives/C04CSC7SGD8/p1718577232284409?thread_ts=1718346059.147479&cid=C04CSC7SGD8

client.js:1 Error: Wrap::Cannot convert 3.1204634625585274e+21 to a BigInt
    at eval (index.js:1:1806)
    at eval (index.js:1:4892)
    at Generator.throw (<anonymous>)
    at s (index.js:1:875)Caused by: SyntaxError: Cannot convert 3.1204634625585274e+21 to a BigInt (at index.js:1:10158)
    at BigInt (<anonymous>)
    at eval (index.js:1:10158)
    at Generator.next (<anonymous>)
    at a (index.js:1:836)

Provide a `describe` function from `createDispatcher`

That "describe" the extrinsic that about to be sent

Things to describe

• Encoded payload that is signed by external wallets
• Internal call in human readable form