Contact Operations – Registry – GrantInstallation

[jac18281828]

Initial discussion is here

Device installation is supported by GrantInstallation.

JSON-RPC Endpoint Documentation

Endpoint: grantInstallation

Description

The grantInstallation endpoint is responsible for storing the contact bundle for the XMTP device installation. The request must be made to a valid did with an XMTP profile.

Request

The request for this endpoint should contain the necessary information to authenticate and validate the installation request including the wallet signed payload

Parameters:

• DID (string): Unique XMTP identifier for the user requesting the installation.
• name (bytes32): Unique identifier naming bundled contents. NOTE 32 byte maximum
• value (bytes): Installation bundle bytes payload.
• V (int): signature V
• R (bytes): signature R
• S (bytes): signature S

Example Request:

{
  "jsonrpc": "2.0",
  "method": "grantInstallation",
  "params": {
    "did": "12345",
    "name": "xmtp/contact_installation",
    "value": "#######",
    "signature": {
      "V": "12345",
      "R": "valueR",
      "S": "valueS"
    }
  },
  "id": 1
}

Response

The response will indicate whether the installation is granted and may include additional information or instructions.

Result Fields:

• status (string): The status of the request, e.g., 'completed'.
• message (string, optional): Additional information or reason for the decision.
• tx (string, optional): transaction receipt

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "status": "completed",
    "message": "Installation request complete.",
    "tx": "<receipt>"
  },
  "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 grantInstallation 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.