Options
All
  • Public
  • Public/Protected
  • All
Menu
type

Swapable.Registry

package

standards

since

v1.2.1

description

Class that describes a registry for pools.

Registries may list one or more than one liquidity pool(s). Each target account hosts one or more than one market pair.

Registries do not own any cryptocurrency. They serve a role of public ledger that contains liquidity pools metadata.

Hierarchy

  • Registry

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Registry(reader: ReaderImpl, publicAccount: PublicAccount): Registry
  • Constructs a pool registry object.

    Parameters

    • reader: ReaderImpl
    • publicAccount: PublicAccount

    Returns Registry

Properties

context

context: Context

The reader execution context

var

{Context}

publicAccount

publicAccount: PublicAccount

reader

reader: ReaderImpl
readonly
access

public

description

The blockchain network reader configuration.

Our first implementation uses a Symbol blockchain network adapter as ReaderImpl. It is possible that other networks are implemented in the future.

Methods

getPools

  • getPools(revision?: undefined | number): Promise<PoolInfo[]>
  • List a registry's liquidity pools. Registries should be used for publicly listing liquidity pools. So-called market pairs are hosted by the Liquidity Pool target account.

    static

    Parameters

    • Optional revision: undefined | number

    Returns Promise<PoolInfo[]>

Generated using TypeDoc