From 8474884c99beee4ba518d289893ac6f2bae2c8af Mon Sep 17 00:00:00 2001 From: Wil Wade Date: Mon, 22 Jul 2024 12:51:45 -0400 Subject: [PATCH] Add getAllGrantedDelegationsByMsaId to Pallet README Documentation (#2091) # Goal The goal of this PR is to add a missing RPC to the documentation and update the PR template checklist to be more helpful at catching this. # Discussion - Happy to make other changes to the PR template if any are suggested. --- .github/pull_request_template.md | 16 +++++++++------- pallets/msa/README.md | 11 ++++++----- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b175dfe01e..4ac7eb45c0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,12 +4,14 @@ The goal of this PR is Closes # Discussion - + +- # Checklist -- [ ] Chain spec updated -- [ ] Custom RPC OR Runtime API added/changed? Updated js/api-augment. -- [ ] Design doc(s) updated -- [ ] Tests added -- [ ] Benchmarks added -- [ ] Weights updated +- [ ] Updated Pallet Readme? +- [ ] Updated js/api-augment for Custom RPC OR Runtime API? +- [ ] Design doc(s) updated? +- [ ] Unit Tests added? +- [ ] e2e Tests added? +- [ ] Benchmarks added? +- [ ] Spec version incremented? diff --git a/pallets/msa/README.md b/pallets/msa/README.md index 22aef5ff43..ca78f5585d 100644 --- a/pallets/msa/README.md +++ b/pallets/msa/README.md @@ -60,11 +60,12 @@ See the [Rust Docs](https://frequency-chain.github.io/frequency/pallet_msa/palle Note: May be restricted based on node settings and configuration. -| Name | Description | Call | Node Version | -| ---------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | -| Check Delegations | Test a list of MSAs to see if they have delegated to the provider MSA | [`checkDelegations`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.check_delegations) | v1.0.0+ | -| Delegation Schema Grants | Fetch the list of Schema Ids that a delegator has granted to a provider | [`grantedSchemaIdsByMsaId`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_granted_schemas_by_msa_id) | v1.0.0+ | -| Get Control Keys by MSA Id\* | Fetch the list of current control keys for an MSA from the off-chain index | [`getKeysByMsaId`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_keys_by_msa_id) | v1.10.0+ | +| Name | Description | Call | Node Version | +| ----------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| Check Delegations | Test a list of MSAs to see if they have delegated to the provider MSA | [`checkDelegations`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.check_delegations ) | v1.0.0+ | +| Delegation Schema Grants | Fetch the list of Schema Ids that a delegator has granted to a provider | [`grantedSchemaIdsByMsaId`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_granted_schemas_by_msa_id) | v1.0.0+ | +| Get Control Keys by MSA Id\* | Fetch the list of current control keys for an MSA from the off-chain index | [`getKeysByMsaId`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_keys_by_msa_id) | v1.10.0+ | +| Get All Delegations by MSA Id | Retreives all delegations and schemas, active and inactive, for an MSA ID | ['getAllGrantedDelegationsByMsaId'](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_all_granted_delegations_by_msa_id) | v1.13.0+ | \* Must be enabled with off-chain indexing