search

xmtp / didethresolver

XMTP Registry Resolver
MIT License
3 stars 1 forks source link

Endpoint: 'resolveDid' #4

Closed jac18281828 closed 9 months ago

jac18281828 commented 10 months ago

Discussed in https://github.com/xmtp/didethresolver/discussions/3

Originally posted by **jac18281828** November 29, 2023 ## Endpoint Documentation: `resolveDid` ### Overview The `resolveDid` endpoint is designed to receive an Ethereum public key and return did document in a JSON format. This endpoint is part of our decentralized data service, which provides access to decentralized identity. ### Endpoint ``` POST /api/v1/resolveDid ``` ### Request Format The request should be a JSON object containing one field: `publicKey`. - `publicKey` (string, required): The Ethereum public key (starting with '0x'). Example Request: ```json { "publicKey": "0x123abc..." } ``` ### Response Format The response will be a JSON object containing a did document for related to the provided Ethereum public key. Example Response: ```json { "@context": [ "https://www.w3.org/ns/did/v1", "https://w3id.org/security/suites/ed25519-2020/v1" ], "controller": "did:ethr:0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "id": "did:ethr:0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "service": [ { "id": "did:ethr:0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "recipientKeys": "0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "serviceEndpoint": "https://xmtp.com/resolver", "type": "MessagingService" } ], "verificationMethod": [ { "controller": "did:ethr:0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "id": "did:ethr:0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "publicKeyMultibase": "0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad", "type": "Ed25519VerificationKey2020" } ] ``` ### Error Handling In case of an error (e.g., invalid public key, server error), the endpoint will return a JSON object with an `error` field describing the issue. Example Error Response: ```json { "error": "Invalid public key format" } ``` ### Security and Authentication - The endpoint is open access. ### Future requirements - Access control - All requests must be made over HTTPS. - Rate limiting is applied to prevent abuse. ### Support Please refer to the DID specification: [DID](https://www.w3.org/TR/did-core/)
insipx commented 10 months ago

These things can all be handled in the monolithic gateway server crate, so we need only focus on the business logic for this crate

I would also like to add

It would be nice to spin up something like kraken API Docs that is auto-generated as we go, so we don't end up with one big ticket at the end for documentation that can be tedious to complete