feat: did rpc

[weichweich]

fixes #2016

• add rpc endpoints to query DID information

todo:

• RPC methods not decorated
• service endpoints
• query by did

Examples

query using did

❯ curl -s -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_query", "params":["5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN"]}' http://127.0.0.1:19933/ | jq

Response

{
  "jsonrpc": "2.0",
  "result": {
    "accounts": [
      "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
    ],
    "details": {
      "attestation_key": null,
      "authentication_key": "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1",
      "delegation_key": null,
      "deposit": {
        "amount": "2007900000000000",
        "owner": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
      },
      "key_agreement_keys": [],
      "last_tx_counter": 3,
      "public_keys": {
        "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1": {
          "block_number": 120,
          "key": {
            "PublicVerificationKey": {
              "Sr25519": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN"
            }
          }
        }
      }
    },
    "identifier": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN",
    "service_endpoints": [
      {
        "id": "123",
        "service_types": [
          "twitter"
        ],
        "urls": [
          "example.com"
        ]
      }
    ],
    "w3n": "alice-0"
  },
  "id": 1
}

query using w3n

❯ curl -s -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_queryByWeb3Name", "params":["alice-0"]}' http://127.0.0.1:19933/ | jq

Response

{
  "jsonrpc": "2.0",
  "result": {
    "accounts": [
      "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
    ],
    "details": {
      "attestation_key": null,
      "authentication_key": "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1",
      "delegation_key": null,
      "deposit": {
        "amount": "2007900000000000",
        "owner": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
      },
      "key_agreement_keys": [],
      "last_tx_counter": 3,
      "public_keys": {
        "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1": {
          "block_number": 120,
          "key": {
            "PublicVerificationKey": {
              "Sr25519": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN"
            }
          }
        }
      }
    },
    "identifier": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN",
    "service_endpoints": [
      {
        "id": "123",
        "service_types": [
          "twitter"
        ],
        "urls": [
          "example.com"
        ]
      }
    ],
    "w3n": "alice-0"
  },
  "id": 1
}

query using linked account

❯ curl -s -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_queryByAccount", "params":["5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"]}' http://127.0.0.1:19933/ | jq

Response

{
  "jsonrpc": "2.0",
  "result": {
    "accounts": [
      "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
    ],
    "details": {
      "attestation_key": null,
      "authentication_key": "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1",
      "delegation_key": null,
      "deposit": {
        "amount": "2007900000000000",
        "owner": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
      },
      "key_agreement_keys": [],
      "last_tx_counter": 3,
      "public_keys": {
        "0x15ba41bf8842ae185ae06110a63e6cc7ac36d8a8ea217746231bef46c1379ab1": {
          "block_number": 120,
          "key": {
            "PublicVerificationKey": {
              "Sr25519": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN"
            }
          }
        }
      }
    },
    "identifier": "5FKxrLQM24ZhLxcaQfJR3uMxMZh5gU6E4CP3yghPJLzCDnHN",
    "service_endpoints": [
      {
        "id": "123",
        "service_types": [
          "twitter"
        ],
        "urls": [
          "example.com"
        ]
      }
    ],
    "w3n": "alice-0"
  },
  "id": 1
}

Checklist:

• I have verified that the code works
  • No panics! (checked arithmetic ops, no indexing array[3] use get(3), ...)
• I have verified that the code is easy to understand
  • If not, I have left a well-balanced amount of inline comments
• I have left the code in a better state
• I have documented the changes (where applicable)
  

[weichweich]

Had to touch a lot of files unfortunately.

• all fields in DidDetails should be public. How should dependent crates use this? Create getters for everything and clone each part!?
• updated the dependencies
• fixed some features

[weichweich]

reordered to keep the impl blocks together

[weichweich]

default-features = false is not needed and should not be used in dev-dependencies

[weichweich]

we can derive RuntimeDebug. No need to implement that our self

[tjwelde]

Add an example please

[ntn-x2]

Didn't look thoroughly into it. I just had few personal opinions.

[ntn-x2]

Since it's used in all runtimes, why don't we move it into common? So far we have the same features deployed in all runtimes.

[weichweich]

yeah it's a huge chunk of code. I would like to slim it down a bit but wasn't sure how.
The issue is, since it's implemented for the runtime you can't move it out there.
The impl also has to be in the impl_runtime_apis! block.

[weichweich]

I could move the following to commons since it's shared between all queries.

let accounts = pallet_did_lookup::ConnectedAccounts::<Runtime>::iter_key_prefix(&owner_info.owner).collect();
let service_endpoints = did::ServiceEndpoints::<Runtime>::iter_prefix(&owner_info.owner).map(|e|From::from(e.1)).collect();
did_rpc_runtime_api::RawDidDocument {
  identifier: owner_info.owner,
  w3n: Some(name.into()),
  accounts,
  service_endpoints,
  details: details.into(),
}

[wischli]

Apart from the renaming of DidDocument, for which I don't have a strong opinion, and moving some code to common, it LGTM!

[ntn-x2]

Amazingly written code... especially from a certain point on..... 🙏