org.stellar.sdk

Class LiquidityPool

java.lang.Object

org.stellar.sdk.LiquidityPool

public final class LiquidityPool
extends java.lang.Object

Represents a LiquidityPoolParameters object on the Stellar network.

See: Liquidity Pool

Field Summary

Fields

Modifier and Type	Field and Description
static int	FEE

Constructor Summary

Constructors

Constructor and Description
LiquidityPool(Asset assetA, Asset assetB) Constructs a new LiquidityPool with specified assets and default fee.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static LiquidityPool	fromXdr(LiquidityPoolParameters xdr) Creates a LiquidityPool from its XDR representation.
@NonNull Asset	getAssetA() The first asset in the pool, it must respect the rule assetA < assetB.
@NonNull Asset	getAssetB() The second asset in the pool, it must respect the rule assetA < assetB.
int	getFee() The liquidity pool fee.
java.lang.String	getLiquidityPoolId() Generates the LiquidityPoolID for this LiquidityPool.
int	hashCode()
java.lang.String	toString()
LiquidityPoolParameters	toXdr() Converts this LiquidityPool to its XDR representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FEE

public static int FEE

Constructor Detail

LiquidityPool

public LiquidityPool(Asset assetA,
                     Asset assetB)

Constructs a new LiquidityPool with specified assets and default fee.

Parameters:

assetA - The first asset in the pool, it must respect the rule assetA < assetB.

assetB - The second asset in the pool, it must respect the rule assetA < assetB.

Throws:

java.lang.IllegalArgumentException - if assets are not in lexicographic order.

Method Detail

toXdr

public LiquidityPoolParameters toXdr()

Converts this LiquidityPool to its XDR representation.

Returns:

The XDR object representing this LiquidityPool.

fromXdr

public static LiquidityPool fromXdr(LiquidityPoolParameters xdr)

Creates a LiquidityPool from its XDR representation.

Parameters:

xdr - The XDR object to convert from.

Returns:

A new LiquidityPool object.

Throws:

java.lang.IllegalArgumentException - if the XDR object is not of type LIQUIDITY_POOL_CONSTANT_PRODUCT.

getLiquidityPoolId

public java.lang.String getLiquidityPoolId()

Generates the LiquidityPoolID for this LiquidityPool.

Returns:

The LiquidityPoolID object.

getAssetA

@NonNull
public @NonNull Asset getAssetA()

The first asset in the pool, it must respect the rule assetA < assetB. Check Asset.compareTo(Asset) for details.

getAssetB

@NonNull
public @NonNull Asset getAssetB()

The second asset in the pool, it must respect the rule assetA < assetB. Check Asset.compareTo(Asset) for details.

getFee

public int getFee()

The liquidity pool fee. For now the only fee supported is FEE.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object