Skip to main content
GET
Returns the whitelists your instance keeps and the whitelists of other instances that one of its verified wallets owns, manages or is named to take over. A whitelist is a list contract that admits exactly the wallets its owner and its managers listed. It examines no identity. Installed as a market’s borrower or provider register, or as a vault’s depositor register, it is the gate. A whitelist is a lighter gate than a verification profile: nothing records why a wallet is on it. It cannot be the borrower gate of a MARKET market, and it gates liquidity providers or vault depositors only on the attestation of the instance that curates it. See Whitelists as Gates.

How whitelists work

The wallet that creates a whitelist owns it, and your instance keeps its record: the name, the purpose and the members it has seen confirmed. The owner adds and removes managers. The owner and every manager list and remove wallets, in batches of at most 200 per transaction. Ownership moves in two steps, proposed by the owner and accepted by the new owner, and a list can never be left without an owner. Every change is a transaction a wallet you control signs, built and confirmed through these routes: Get Whitelist reads one list with its members, Rescan Whitelist catches the record up with changes signed elsewhere, and Update Whitelist renames, re-purposes or archives the record.
A change to a whitelist applies at once to every gate it serves: every market and vault that installed it, also those of other instances. A gate admits the list’s members at the moment of each check. Removing a wallet from a list that gates a market’s borrowers stops that wallet’s next draw there, and listing one admits it everywhere the list is installed.

Lists another instance keeps

A whitelist is recorded by the instance that created it. When a verified wallet of your instance manages a list another instance keeps, that list appears under managed. Your instance can list and remove wallets on it, confirm those changes and rescan it. Only the instance that keeps the list adds managers and transfers it. A list whose pending transfer names one of your wallets appears under managed too, so the transfer can be accepted. Suppose the list’s owner on chain is a verified wallet of your instance, and the instance that kept the record does not hold that wallet. The record then moves to your instance with its name. That happens the first time your instance reads the list with Get Whitelist, or builds, confirms or rescans a change to it. The move is written to the audit log as LENDING_ACCESS_LIST_REHOMED.

Query Parameters

boolean
default:"false"
true or 1 also returns the lists your instance archived. Any other value leaves them out.

Response Fields

object
managers, ownerWallet and memberCount are the record, written by the confirm calls and by Rescan Whitelist. A change signed and never confirmed reaches the record only through a rescan. Get Whitelist with wallets reads the live state from the chain.

Error Codes