Skip to content

Commit

Permalink
refactor!: rename liquidityPoolID to liquidityPoolId.
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Aug 8, 2024
1 parent 5cb3fe0 commit b6cd956
Show file tree
Hide file tree
Showing 12 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion src/main/java/org/stellar/sdk/Asset.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public static Asset create(String canonicalForm) {
}

/**
* <p>Creates Asset for Alpha4/Alpha12/Native
* Creates Asset for Alpha4/Alpha12/Native
*
* @param type the type of asset. 'native' will generate its respective asset sub-class, if null
* or any other value will attempt to derive the asset sub-class from code and issuer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
@SuperBuilder(toBuilder = true)
public class LiquidityPoolDepositOperation extends Operation {
/** The liquidity pool ID. */
@NonNull private final String liquidityPoolID;
@NonNull private final String liquidityPoolId;

/** Maximum amount of first asset to deposit (max of 7 decimal places). */
@NonNull private final BigDecimal maxAmountA;
Expand All @@ -49,7 +49,7 @@ public LiquidityPoolDepositOperation(
@NonNull BigDecimal maxAmountB,
@NonNull Price minPrice,
@NonNull Price maxPrice) {
this.liquidityPoolID = new LiquidityPool(assetA, assetB).getLiquidityPoolId();
this.liquidityPoolId = new LiquidityPool(assetA, assetB).getLiquidityPoolId();
this.maxAmountA = maxAmountA;
this.maxAmountB = maxAmountB;
this.minPrice = minPrice;
Expand All @@ -64,21 +64,21 @@ public LiquidityPoolDepositOperation(
* @return {@link LiquidityPoolDepositOperation} object
*/
public static LiquidityPoolDepositOperation fromXdr(LiquidityPoolDepositOp op) {
String liquidityPoolID =
String liquidityPoolId =
Util.bytesToHex(op.getLiquidityPoolID().getPoolID().getHash()).toLowerCase();
BigDecimal maxAmountA = Operation.fromXdrAmount(op.getMaxAmountA().getInt64());
BigDecimal maxAmountB = Operation.fromXdrAmount(op.getMaxAmountB().getInt64());
Price minPrice = Price.fromXdr(op.getMinPrice());
Price maxPrice = Price.fromXdr(op.getMaxPrice());
return new LiquidityPoolDepositOperation(
liquidityPoolID, maxAmountA, maxAmountB, minPrice, maxPrice);
liquidityPoolId, maxAmountA, maxAmountB, minPrice, maxPrice);
}

@Override
OperationBody toOperationBody() {
LiquidityPoolDepositOp op = new LiquidityPoolDepositOp();
op.setLiquidityPoolID(
new org.stellar.sdk.xdr.PoolID(new Hash(Util.hexToBytes(this.getLiquidityPoolID()))));
new org.stellar.sdk.xdr.PoolID(new Hash(Util.hexToBytes(this.getLiquidityPoolId()))));
op.setMaxAmountA(new org.stellar.sdk.xdr.Int64(Operation.toXdrAmount(this.getMaxAmountA())));
op.setMaxAmountB(new org.stellar.sdk.xdr.Int64(Operation.toXdrAmount(this.getMaxAmountB())));
op.setMinPrice(this.getMinPrice().toXdr());
Expand All @@ -94,8 +94,8 @@ public abstract static class LiquidityPoolDepositOperationBuilder<
C extends LiquidityPoolDepositOperation,
B extends LiquidityPoolDepositOperationBuilder<C, B>>
extends OperationBuilder<C, B> {
public B liquidityPoolID(@NonNull String liquidityPoolID) {
this.liquidityPoolID = liquidityPoolID.toLowerCase();
public B liquidityPoolId(@NonNull String liquidityPoolId) {
this.liquidityPoolId = liquidityPoolId.toLowerCase();
return self();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
@SuperBuilder(toBuilder = true)
public class LiquidityPoolWithdrawOperation extends Operation {
/** The liquidity pool ID. */
@NonNull private final String liquidityPoolID;
@NonNull private final String liquidityPoolId;

/** Amount of pool shares to withdraw (max of 7 decimal places). */
@NonNull private final BigDecimal amount;
Expand All @@ -44,7 +44,7 @@ public LiquidityPoolWithdrawOperation(
@NonNull Asset assetB,
@NonNull BigDecimal minAmountB,
@NonNull BigDecimal amount) {
this.liquidityPoolID = new LiquidityPool(assetA, assetB).getLiquidityPoolId();
this.liquidityPoolId = new LiquidityPool(assetA, assetB).getLiquidityPoolId();
this.amount = amount;
this.minAmountA = minAmountA;
this.minAmountB = minAmountB;
Expand All @@ -58,19 +58,19 @@ public LiquidityPoolWithdrawOperation(
* @return {@link LiquidityPoolWithdrawOperation} object
*/
public static LiquidityPoolWithdrawOperation fromXdr(LiquidityPoolWithdrawOp op) {
String liquidityPoolID =
String liquidityPoolId =
Util.bytesToHex(op.getLiquidityPoolID().getPoolID().getHash()).toLowerCase();
BigDecimal amount = Operation.fromXdrAmount(op.getAmount().getInt64());
BigDecimal minAmountA = Operation.fromXdrAmount(op.getMinAmountA().getInt64());
BigDecimal minAmountB = Operation.fromXdrAmount(op.getMinAmountB().getInt64());
return new LiquidityPoolWithdrawOperation(liquidityPoolID, amount, minAmountA, minAmountB);
return new LiquidityPoolWithdrawOperation(liquidityPoolId, amount, minAmountA, minAmountB);
}

@Override
OperationBody toOperationBody() {
LiquidityPoolWithdrawOp op = new LiquidityPoolWithdrawOp();
op.setLiquidityPoolID(
new org.stellar.sdk.xdr.PoolID(new Hash(Util.hexToBytes(this.getLiquidityPoolID()))));
new org.stellar.sdk.xdr.PoolID(new Hash(Util.hexToBytes(this.getLiquidityPoolId()))));
op.setAmount(new org.stellar.sdk.xdr.Int64(Operation.toXdrAmount(this.getAmount())));
op.setMinAmountA(new org.stellar.sdk.xdr.Int64(Operation.toXdrAmount(this.getMinAmountA())));
op.setMinAmountB(new org.stellar.sdk.xdr.Int64(Operation.toXdrAmount(this.getMinAmountB())));
Expand All @@ -85,8 +85,8 @@ public abstract static class LiquidityPoolWithdrawOperationBuilder<
C extends LiquidityPoolWithdrawOperation,
B extends LiquidityPoolWithdrawOperationBuilder<C, B>>
extends OperationBuilder<C, B> {
public B liquidityPoolID(@NonNull String liquidityPoolID) {
this.liquidityPoolID = liquidityPoolID.toLowerCase();
public B liquidityPoolId(@NonNull String liquidityPoolId) {
this.liquidityPoolId = liquidityPoolId.toLowerCase();
return self();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,11 @@ public AccountsRequestBuilder forAsset(AssetTypeCreditAlphaNum asset) {
/**
* Returns all accounts who have trustlines to the specified liquidity pool.
*
* @param liquidityPoolID Liquidity Pool ID
* @param liquidityPoolId Liquidity Pool ID
* @return current {@link AccountsRequestBuilder} instance
* @see <a href="https://developers.stellar.org/api/resources/accounts/list/">Accounts</a>
*/
public AccountsRequestBuilder forLiquidityPool(String liquidityPoolID) {
public AccountsRequestBuilder forLiquidityPool(String liquidityPoolId) {
if (uriBuilder.build().queryParameter(ASSET_PARAMETER_NAME) != null) {
throw new IllegalArgumentException("cannot set both asset and liquidity_pool");
}
Expand All @@ -130,7 +130,7 @@ public AccountsRequestBuilder forLiquidityPool(String liquidityPoolID) {
if (uriBuilder.build().queryParameter(SPONSOR_PARAMETER_NAME) != null) {
throw new IllegalArgumentException("cannot set both sponsor and liquidity_pool");
}
uriBuilder.setQueryParameter(LIQUIDITY_POOL_PARAMETER_NAME, liquidityPoolID);
uriBuilder.setQueryParameter(LIQUIDITY_POOL_PARAMETER_NAME, liquidityPoolId);
return this;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ public EffectsRequestBuilder forTransaction(@NonNull String transactionId) {
*
* @see <a href="https://developers.stellar.org/api/resources/liquiditypools/effects/">Effects for
* Liquidity Pool</a>
* @param liquidityPoolID Liquidity pool for which to get effects
* @param liquidityPoolId Liquidity pool for which to get effects
*/
public EffectsRequestBuilder forLiquidityPool(String liquidityPoolID) {
this.setSegments("liquidity_pools", liquidityPoolID, "effects");
public EffectsRequestBuilder forLiquidityPool(String liquidityPoolId) {
this.setSegments("liquidity_pools", liquidityPoolId, "effects");
return this;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public LiquidityPoolResponse liquidityPool(HttpUrl uri) {
/**
* Requests <code>GET /liquidity_pools/{liquidity_pool_id}</code>
*
* @param liquidityPoolID Liquidity Pool to fetch
* @param liquidityPoolId Liquidity Pool to fetch
* @return {@link LiquidityPoolResponse}
* @throws org.stellar.sdk.exception.BadRequestException if the request fails due to a bad request
* (4xx)
Expand All @@ -56,8 +56,8 @@ public LiquidityPoolResponse liquidityPool(HttpUrl uri) {
* @see <a href="https://developers.stellar.org/api/resources/liquiditypools/single/">Liquidity
* Pool Details</a>
*/
public LiquidityPoolResponse liquidityPool(String liquidityPoolID) {
this.setSegments("liquidity_pools", liquidityPoolID);
public LiquidityPoolResponse liquidityPool(String liquidityPoolId) {
this.setSegments("liquidity_pools", liquidityPoolId);
return this.liquidityPool(this.buildUri());
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,10 @@ public OperationsRequestBuilder forTransaction(@NonNull String transactionId) {
* @see <a
* href="https://developers.stellar.org/api/resources/liquiditypools/operations/">Operations
* for Liquidity Pool</a>
* @param liquidityPoolID Liquidity pool for which to get operations
* @param liquidityPoolId Liquidity pool for which to get operations
*/
public OperationsRequestBuilder forLiquidityPool(String liquidityPoolID) {
this.setSegments("liquidity_pools", liquidityPoolID, "operations");
public OperationsRequestBuilder forLiquidityPool(String liquidityPoolId) {
this.setSegments("liquidity_pools", liquidityPoolId, "operations");
return this;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ public TradesRequestBuilder forAccount(@NonNull String account) {
*
* @see <a href="https://developers.stellar.org/api/resources/liquiditypools/trades/">Trades for
* Liquidity Pool</a>
* @param liquidityPoolID Liquidity pool for which to get trades
* @param liquidityPoolId Liquidity pool for which to get trades
*/
public TradesRequestBuilder forLiquidityPool(String liquidityPoolID) {
this.setSegments("liquidity_pools", String.valueOf(liquidityPoolID), "trades");
public TradesRequestBuilder forLiquidityPool(String liquidityPoolId) {
this.setSegments("liquidity_pools", String.valueOf(liquidityPoolId), "trades");
return this;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,10 @@ public TransactionsRequestBuilder forLedger(long ledgerSeq) {
* @see <a
* href="https://developers.stellar.org/api/resources/liquiditypools/transactions/">Transactions
* for Liquidity Pool</a>
* @param liquidityPoolID Liquidity pool for which to get transactions
* @param liquidityPoolId Liquidity pool for which to get transactions
*/
public TransactionsRequestBuilder forLiquidityPool(String liquidityPoolID) {
this.setSegments("liquidity_pools", liquidityPoolID, "transactions");
public TransactionsRequestBuilder forLiquidityPool(String liquidityPoolId) {
this.setSegments("liquidity_pools", liquidityPoolId, "transactions");
return this;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public class LiquidityPoolDepositOperationTest {
Asset nativeAsset = create("native");
Asset creditAsset =
create(null, "ABC", "GCRA6COW27CY5MTKIA7POQ2326C5ABYCXODBN4TFF5VL4FMBRHOT3YHU");
String liquidityPoolID = new LiquidityPool(nativeAsset, creditAsset).getLiquidityPoolId();
String liquidityPoolId = new LiquidityPool(nativeAsset, creditAsset).getLiquidityPoolId();

@Test
public void testLiquidityPoolDepositOperationValid() {
Expand All @@ -28,7 +28,7 @@ public void testLiquidityPoolDepositOperationValid() {
Price maxPrice = Price.fromString("0.02");
LiquidityPoolDepositOperation operation =
LiquidityPoolDepositOperation.builder()
.liquidityPoolID(liquidityPoolID)
.liquidityPoolId(liquidityPoolId)
.maxAmountA(maxAmountA)
.maxAmountB(maxAmountB)
.minPrice(minPrice)
Expand All @@ -41,7 +41,7 @@ public void testLiquidityPoolDepositOperationValid() {
(LiquidityPoolDepositOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(new BigDecimal("1000.0000000"), parsedOperation.getMaxAmountA());
assertEquals(new BigDecimal("2000.0000000"), parsedOperation.getMaxAmountB());
assertEquals(minPrice, parsedOperation.getMinPrice());
Expand All @@ -60,7 +60,7 @@ public void testLiquidityPoolDepositOperation_UpperLiquidityPoolId() {
Price maxPrice = Price.fromString("0.02");
LiquidityPoolDepositOperation operation =
LiquidityPoolDepositOperation.builder()
.liquidityPoolID(liquidityPoolID.toUpperCase())
.liquidityPoolId(liquidityPoolId.toUpperCase())
.maxAmountA(maxAmountA)
.maxAmountB(maxAmountB)
.minPrice(minPrice)
Expand All @@ -73,7 +73,7 @@ public void testLiquidityPoolDepositOperation_UpperLiquidityPoolId() {
(LiquidityPoolDepositOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(new BigDecimal("1000.0000000"), parsedOperation.getMaxAmountA());
assertEquals(new BigDecimal("2000.0000000"), parsedOperation.getMaxAmountB());
assertEquals(minPrice, parsedOperation.getMinPrice());
Expand All @@ -100,7 +100,7 @@ public void testConstructorPairs() {
(LiquidityPoolDepositOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(new BigDecimal("1000.0000000"), parsedOperation.getMaxAmountA());
assertEquals(new BigDecimal("2000.0000000"), parsedOperation.getMaxAmountB());
assertEquals(minPrice, parsedOperation.getMinPrice());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class LiquidityPoolWithdrawOperationTest {
Asset nativeAsset = create("native");
Asset creditAsset =
create(null, "ABC", "GCRA6COW27CY5MTKIA7POQ2326C5ABYCXODBN4TFF5VL4FMBRHOT3YHU");
String liquidityPoolID = new LiquidityPool(nativeAsset, creditAsset).getLiquidityPoolId();
String liquidityPoolId = new LiquidityPool(nativeAsset, creditAsset).getLiquidityPoolId();

@Test
public void testLiquidityPoolWithdrawOperationValid() {
Expand All @@ -29,7 +29,7 @@ public void testLiquidityPoolWithdrawOperationValid() {
BigDecimal formattedMinAmountB = new BigDecimal("2000.0000000");
LiquidityPoolWithdrawOperation operation =
LiquidityPoolWithdrawOperation.builder()
.liquidityPoolID(liquidityPoolID)
.liquidityPoolId(liquidityPoolId)
.amount(amount)
.minAmountA(minAmountA)
.minAmountB(minAmountB)
Expand All @@ -41,7 +41,7 @@ public void testLiquidityPoolWithdrawOperationValid() {
(LiquidityPoolWithdrawOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(formattedAmount, parsedOperation.getAmount());
assertEquals(formattedMinAmountA, parsedOperation.getMinAmountA());
assertEquals(formattedMinAmountB, parsedOperation.getMinAmountB());
Expand All @@ -61,7 +61,7 @@ public void testLiquidityPoolWithdrawOperation_UpperLiquidityPoolId() {
BigDecimal formattedMinAmountB = new BigDecimal("2000.0000000");
LiquidityPoolWithdrawOperation operation =
LiquidityPoolWithdrawOperation.builder()
.liquidityPoolID(liquidityPoolID.toUpperCase())
.liquidityPoolId(liquidityPoolId.toUpperCase())
.amount(amount)
.minAmountA(minAmountA)
.minAmountB(minAmountB)
Expand All @@ -73,7 +73,7 @@ public void testLiquidityPoolWithdrawOperation_UpperLiquidityPoolId() {
(LiquidityPoolWithdrawOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(formattedAmount, parsedOperation.getAmount());
assertEquals(formattedMinAmountA, parsedOperation.getMinAmountA());
assertEquals(formattedMinAmountB, parsedOperation.getMinAmountB());
Expand Down Expand Up @@ -101,7 +101,7 @@ public void testConstructorPairs() {
(LiquidityPoolWithdrawOperation) Operation.fromXdr(xdr);

assertEquals(source.getAccountId(), parsedOperation.getSourceAccount());
assertEquals(liquidityPoolID, parsedOperation.getLiquidityPoolID());
assertEquals(liquidityPoolId, parsedOperation.getLiquidityPoolId());
assertEquals(formattedAmount, parsedOperation.getAmount());
assertEquals(formattedMinAmountA, parsedOperation.getMinAmountA());
assertEquals(formattedMinAmountB, parsedOperation.getMinAmountB());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ public void testForSignerAndSponsorInvalid() {
@Test
public void testForLiquidityPool() {
Server server = new Server("https://horizon-testnet.stellar.org");
String liquidityPoolID = "dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380faca";
HttpUrl uri = server.accounts().forLiquidityPool(liquidityPoolID).buildUri();
String liquidityPoolId = "dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380faca";
HttpUrl uri = server.accounts().forLiquidityPool(liquidityPoolId).buildUri();
assertEquals(
"https://horizon-testnet.stellar.org/accounts?liquidity_pool=dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380faca",
uri.toString());
Expand Down

0 comments on commit b6cd956

Please sign in to comment.