rpc-methods.md

RPC Methods

This doc should be used as a source-of-truth and reflect the latest decisions and changes applied to the WalletConnect collection of client-to-client JSON-RPC methods for all platforms SDKs.

Definitions

• Nullables: Fields flagged as Optional can be ommited from the payload.
• Unless explicitly mentioned that a response requires associated data, all methods response's follow a default JSON-RPC pattern for the success and failure cases:

// Success
result: true

// Failure
error: {
  "code": number,
  "message": string
}

wc_authRequest

Used to request authentication signature to a peer through topic P. Response is expected on topic R with shared symKey.

Parameters for request and response are compliant with CAIP-74 (aka CACAO)

• Success response is equivalent to authentication acceptance.
• Error response is equivalent to authentication rejection.

Request

// wc_authRequest params
{
  "requester": {
    "publicKey": string,
    "metadata": {
      "name": string,
      "description": string,
      "url": string,
      "icons": [string]
    },
  },
  "payloadParams": PayloadParams
}

| Iridium |          |
| ------- | -------- |
| TTL     | 86400    |
| Prompt  | true     |
| Tag     | 3000     |

Response

// Success result
{
  "header": {
    "t": string,
  },
  "payload": {
    "iss": string,
    "domain": string,
    "aud": string,
    "version": string,
    "nonce": string,
    "iat": string,
    "nbf": string, // Optional
    "exp": string, // Optional
    "statement": string, // Optional
    "requestId": string, // Optional
    "resources": [string] // Optional
  },
  "signature": {
    "t": string,
    "s": string,
    "m": string //optional
  }
}

| Iridium |          |
| ------- | -------- |
| TTL     | 86400    |
| Prompt  | false    |
| Tag     | 3001     |