Get wallet address information

For a client to request a grant from an authorization server, the client must first verify the validity of the wallet address and get the URL of the wallet’s authorization server.

These code snippets enable an authenticated client to verify a wallet address, get the basic information required to construct a new transaction, and discover the auth server’s URL. Note that unauthenticated clients can also call the Wallet Address API to get wallet address information.

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 public information 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

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

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

Output

console.log("WALLET ADDRESS:", walletAddress);

Copied! Copy console.log("WALLET ADDRESS:", walletAddress);

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

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

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

Output

console.log("WALLET ADDRESS:", walletAddress);

Copied! Copy console.log("WALLET ADDRESS:", walletAddress);

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

View full source

References

• API specification
• Wallet addresses