Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/services/PoolService"

Index

Type aliases

FormattedMetadata

FormattedMetadata: object

Type declaration

  • metadataType: MetadataType
  • metadataValue: string
  • scopedMetadataKey: string
  • senderAddress: Address
  • targetAddress: Address
  • targetId: string | undefined

KeyValueDictionary

KeyValueDictionary: object

Type declaration

  • [k: string]: string

PoolInfo

PoolInfo: object
type

PoolInfo

package

Swapable

subpackage

Services

since

v1.2.1

description

Class that describes a specific pool implementation.

Type declaration

  • pMosaic: MosaicId

    The provider mosaic refers to the liquidity provider share mosaics which are attributed on a pro-rata basis. This mosaic is modified on the network using metadata that holds information about paired tokens (x & y).

    var

    {MosaicId}

  • target: PublicAccount

    The target public account that owns the liquidity pool's tradeable token pairs and the liquidity provider share mosaics.

    var

    {PublicAccount}

  • xMosaic: MosaicId

    The x mosaic refers to the liquidity pool's left-side token in a liquidity pool with a pair of tokens.

    var

    {MosaicId}

  • yMosaic: MosaicId

    The y mosaic refers to the liquidity pool' right-side token in a liquidity pool with a pair of tokens.

    var

    {MosaicId}

Generated using TypeDoc