Contact Operations – Registry – FetchKeyPackages

[jac18281828]

Discussed in #15

^{Originally posted by jac18281828 December 22, 2023}
Initial discussion is here

Device installation is supported by GrantInstallation.
Device removal is supported by RevokeInstallation.

Retrieval of device current valid installations is supported by FetchKeyPackages.

JSON-RPC Endpoint Documentation

Request:

• Method: POST
• URL: /rpc/v1/fetchKeyPackages
• Headers:
  • Content-Type: application/json
• Body:
  • JSON Object:
    • jsonrpc: "2.0"
    • method: "fetchKeyPackages"
    • params: Array (optional parameters as required)
    • id: Request identifier (integer or string)

Endpoint: fetchKeyPackages

Description

The fetchKeyPackages endpoint is responsible for retrieving the contact bundle for the XMTP device installations. The request must be made to a valid did with an XMTP profile.

Request

The request for this endpoint should contain a valid DID. All returned information is public.

Parameters:

• DID (string): Unique XMTP identifier for the user requesting the installation.

Example Request:

{
    "jsonrpc": "2.0",
    "method": "fetchKeyPackages",
    "params": {
        "did": "12345"
    },
    "id": 1
}

Response

The response will provide an optionally empty list of installation bundles.

Result Fields:

• status (string): The status of the request, e.g., 'success'.
• installation (array): Array of installation bundles.

Example Response:

{
    "jsonrpc": "2.0",
    "result": {
        "status": "success",
        "installation": ["bundle1...", "bundle2..."]
    },
    "id": 1
}

Error Handling

In case of an error, the response will include an error object with details.

Error Object Fields:

• code (integer): Numeric code representing the error type.
• message (string): Description of the error.

Example Error Response:

{
    "jsonrpc": "2.0",
    "error": {
        "code": 403,
        "message": "User not authorized for installation."
    },
    "id": 1
}

Security Considerations

All requests to fetchKeyPackages must be made over a secure channel. Ensure that user and application IDs are validated, and proper authentication mechanisms are in place to prevent unauthorized requests.