Get keys bound to a wallet address

While most Open Payments code snippets are intended for clients, getting the keys bound to a wallet address is primarily a function of account servicing entities.

When an authorization server receives a signed grant request, the server can make a call to acquire the public keys bound to the wallet address. Then, when a client makes a request to a resource server, the resource server calls the auth server to ensure the signature of the request corresponds to the public JWK of the wallet address. This enables the server to ensure the client is who it says it is.

These code snippets get the keys associated with the specified wallet address.

Before you begin

We recommend creating a wallet account on the test wallet. Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money.

Retrieve the public keys for a wallet address

TypeScript

Prerequisites

• Node 18
• A package manager such as NPM or PNPM

• Open Payments SDK

• TSX

Additional configuration

Add "type": "module" to package.json

Add the following to tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ES2022"
  }
}

Get started

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";

Copied! Copy import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});

Copied! Copy const client = await createAuthenticatedClient({ walletAddressUrl: WALLET_ADDRESS, privateKey: PRIVATE_KEY_PATH, keyId: KEY_ID, });

Get wallet address keys

const walletAddressKeys = await client.walletAddress.getKeys({
  url: WALLET_ADDRESS,
});

Copied! Copy const walletAddressKeys = await client.walletAddress.getKeys({ url: WALLET_ADDRESS, });

Output

console.log("WALLET ADDRESS KEYS:", JSON.stringify(walletAddressKeys, null, 2));

Copied! Copy console.log("WALLET ADDRESS KEYS:", JSON.stringify(walletAddressKeys, null, 2));

Run tsx path/to/directory/index.ts.

View full source

JavaScript

Prerequisites

• Node 18 or higher
• A package manager such as NPM or PNPM

• Open Payments SDK

Additional configuration

Add "type": "module" to package.json

Get started

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";

Copied! Copy import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});

Copied! Copy const client = await createAuthenticatedClient({ walletAddressUrl: WALLET_ADDRESS, privateKey: PRIVATE_KEY_PATH, keyId: KEY_ID, });

Get wallet address keys

const walletAddressKeys = await client.walletAddress.getKeys({
  url: WALLET_ADDRESS,
});

Copied! Copy const walletAddressKeys = await client.walletAddress.getKeys({ url: WALLET_ADDRESS, });

Output

console.log("WALLET ADDRESS KEYS:", JSON.stringify(walletAddressKeys, null, 2));

Copied! Copy console.log("WALLET ADDRESS KEYS:", JSON.stringify(walletAddressKeys, null, 2));

Run node path/to/directory/index.js.

View full source

References

• API specification
• Wallet addresses