How to decorate RPC correctly?

Question

The rpc methods (showing in rpc_methods), are still not showing in their own area, after (attempting to) decorate the rpc.

I have custom rpc on a substrate template.

Here are the rpc_methods:

I have manually described the methods in apps-config/src/api/spec/supersig.ts

import type { OverrideBundleDefinition } from '@polkadot/types/types';

export default {
  rpc: {
    superSig: {
      getProposalState: {
        description: 'Get the proposal state',
        params: [
          {
            name: 'supersig_id',
            type: 'AccountId'
          },
          {
            name: 'call_id',
            type: 'CallId',
            
          }
        ],
        type: 'Result<(ProposalState<AccountId>, u32), DispatchError>'
      },
      get_user_supersigs: {
        description: 'Get supersigs associated to the user.',
        params: [
            {
            name: 'user_account',
            type: 'AccountId'
            },
        ],
        type: 'Vec<SupersigId>'
      },
      list_members: {
        description: 'List members of the supersig',
        params: [
            {
            name: 'supersig_id',
            type: 'AccountId'
            }
        ],
        type: 'Vec<(AccountId, Role)'
      },
      list_proposals: {
        description: 'List proposals associated to a supersig',
        params: [
            {
            name: 'supersig_id',
            type: 'AccountId'
            }
        ],
        type: 'Result<(Vec<ProposalState<AccountId>>, u32), DispatchError>'
      },
    },
  },
} as OverrideBundleDefinition;

I then renamed my local custom node-template, and then launched it using this command:

./target/release/node-template --chain="./supersig-raw.json" --alice --rpc-cors all --rpc-methods=unsafe

I named the chain to "supersig" and id: supersig in theh chain-spec,

and added the chain to a local hosted polkadot-js/apps (this branch):

However, the rpc methods are still not showing in their own area, which I attempted to decorate.

1. Could you provide some guidance for what i am missing?
2. type: 'Result<(Vec<ProposalState<AccountId>>, u32), DispatchError>' is that a correct way to create the return type in the rpc module?

Answer 1

1. Names, which are shown in the rpc.methods, are not related to chain name. So, you change your chain name won't affect those names. These names will only be affected by the annotations on the rpc method. e.g. The following rpc method name is did_getMetadata.

#[method(name = "did_getMetadata")]
    fn get_metadata(&self, did: DecentralizedId, key: String) -> RpcResult<String>;

2. RpcResult<(Vec<ProposalState>, u32)> is great. And, if you want to return a struct in RpcResult, you should check if it requires more annotations on that struct. Instead of struct, I suggest to use pure primitive tupple.

Finally, try use state-call instead of custom rpc, because every time you need to create/modify a rpc api, you'll need to re-deploy the node binary. If you use state-call, its pure wasm runtime, so if some changes are needed, then you just need to upgrade the runtime.

Answer 2

Not sure but maybe this will help you ? In mangata this is how we generate types and also RPC methods. Mangata types