Address book

The public network directory and your private address book, and how names appear on transactions

On io.network you work with two address books:

  • The public address book is the network directory: your principal member's shared list of members and their addresses, recorded on io.chain.
  • Your private address book is your organisation's own list of counterparties and their addresses, kept by io.vault and seen only by you.

io.vault uses both to show names instead of raw addresses on your transactions.

Compare them

Public address bookPrivate address book
HoldsMembers of your principal member's network and their io.chain addressesAny counterparties you choose, on any supported network
Who adds entriesYour principal memberYour organisation
Who can see itMembers of the same network, subject to each address's visibilityOnly your organisation
Where it is keptOn io.chain, shared only within your principal member's networkIn io.vault, off chain
Available toio.network membersEvery Treasury organisation

Public address book

Visibility

Each address in the public address book has a visibility level, set by the principal member:

VisibilityWhat other members can do
PUBLICSee it when they browse the address book.
KNOWN_ONLYFind it only by looking up the exact address. It isn't listed.
HIDDENNothing. It is never shown.

New addresses start as HIDDEN. A member appears in the address book once at least one of its addresses is PUBLIC.

Only the principal member can publish members and change an address's visibility. A change applies to that address on every network. Clients can't change their own visibility.

Browse and look up members

You can browse the public address book, or look up an exact address on a network:

  • Browsing lists other members that have at least one PUBLIC address, showing only their PUBLIC addresses.
  • Looking up an exact address and network also finds a KNOWN_ONLY address, and returns only that address.

Each member shows its company name and registration number, its principal member, when it joined, and its addresses with their labels and visibility. You don't see your own organisation in the list.

Only active members of the network can read the public address book.

Private address book

Your private address book is your organisation's identities: the people and companies you transact with, and their addresses on any supported network. See Identities to add and manage them.

Save a member to your private address book

When you find another member's address, through a lookup or on a transaction you're building, you can save it to your private address book. Create an identity with the address.

Your saved copy isn't linked to the public entry. If the principal member later changes the member's visibility, your private entry and its name stay as they are.

Names on your transactions

io.vault resolves each address on your requests and transactions to a name, in this order:

  1. One of your own vaults.
  2. An identity in your private address book.
  3. Your principal member.
  4. A member in the public address book.

If nothing matches, the raw address is shown.

When you build a transaction or view your transaction requests, a public address book match can be PUBLIC or KNOWN_ONLY. In transaction history, only PUBLIC names are shown, apart from the counterparty of your own vault. This stops KNOWN_ONLY addresses being discovered by browsing transaction history. HIDDEN addresses and your own entry never resolve.

Privacy

  • Your private address book is never written to io.chain or shared with other organisations.
  • Public address book entries are shared only within your principal member's network. Entries for individual clients don't include their names.

Did this page help you?