quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

1.11 (#2198)

Browse Source 
* 1.11

* isOptional is custom RPC sample

* Names is one-liner for custom RPCs
This commit is contained in:
Jaco Greeff
2020-04-21 09:38:09 +02:00
committed by GitHub
parent 536369261f
commit 9975f58cfb
13 changed files with 78 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/start/rpc.custom.md
+8 -1
View File
@@ -17,6 +17,11 @@ const api = await ApiPromise.create({
{
name: 'index',
type: 'u64'
},
{
name: 'at',
type: 'Hash',
isOptional: true
}
],
type: 'Balance'
@@ -26,7 +31,9 @@ const api = await ApiPromise.create({
});
```
In the above example we have defined a new method, which is now available on the RPCs as `api.rpc.firstModule.testMethod(u64) => Promise<Balance>`. Do be aware that while defined, the method will only appear if it is in the list as returned by `api.rpc.rpc.methods()`, which is the list of known RPCs the node exposes. When making changes to the node, always ensure that it does expose the RPC method correctly, otherwise it will not be decorated.
In the above example we have defined a new method, which is now available on the RPCs as `api.rpc.firstModule.testMethod(index: u64, at?: Hash) => Promise<Balance>`. In the case of optional params, we have added the `isOptional: true` flag alongside the `name` & `type` in the param definition.
Be aware that while defined, the method will only appear on the API if it is in the list as returned by `api.rpc.rpc.methods()`, which is the list of known RPCs the node exposes. When making changes to the node, always ensure that it does expose the RPC method correctly, otherwise it will not be decorated.
## Definition breakdown