Skip to content

Connectors

A connector is a signing backend: it determines how an operation runs and which custodian holds your account keys. Each is constructed and authenticated on its own, then passed to the client constructed by simpleXRPL in a signers array. simpleXRPL supports these connectors:

Every connector implements the Custodian interface. Once constructed, it exposes these fields and methods:

Fields

FieldTypeDescription
kindCustodianKindThe backend the connector adapts: local, ripple-custody, palisade-custody, or external.
primaryAccountRefThe connector's primary account reference. Used when a vertical operation runs without an explicit account.
primary.addressstringThe primary account's XRPL r-address.
primary.custodianRefCustodianRef(Optional) The connector's opaque native id for the account.

Methods

listAccounts()

List the accounts the connector holds.

Signature

connector.listAccounts(): Promise<Account[]>

Parameters

listAccounts takes no arguments.

Returns

Resolves to an array of Account records the connector discovered and can sign for.

Example

const accounts = await connector.listAccounts()

console.log(accounts.map((account) => account.address))