Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix more AccountSet fields #566

Merged
merged 2 commits into from
Oct 29, 2024
Merged

Fix more AccountSet fields #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
308c69a
add WalletLocator.
nkramer44 Oct 29, 2024
7690e6f
PR comments
nkramer44 Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/AccountRootObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,14 @@ default LedgerEntryType ledgerEntryType() {
@JsonProperty("AMMID")
Optional<Hash256> ammId();

/**
* An arbitrary 256-bit value that users can set.
*
* @return An {@link Optional} {@link String}.
*/
@JsonProperty("WalletLocator")
Optional<String> walletLocator();

/**
* The unique ID of this {@link AccountRootObject} ledger object.
*
Expand Down
18 changes: 18 additions & 0 deletions xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/AccountSet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ default AccountSet normalizeSetFlag() {
* @return An {@link Optional} of type {@link String} containing the messaging public key.
*/
@JsonProperty("MessageKey")
@JsonInclude(Include.NON_ABSENT)
Optional<String> messageKey();

/**
Expand Down Expand Up @@ -310,6 +311,23 @@ default AccountSet normalizeSetFlag() {
@JsonProperty("NFTokenMinter")
Optional<Address> mintAccount();

/**
* An arbitrary 256-bit value. If specified, the value is stored as part of the account but has no inherent meaning
* or requirements.
*
* @return The 256-bit value as a hex encoded {@link String}.
*/
@JsonProperty("WalletLocator")
Optional<String> walletLocator();

/**
* Not used. This field is valid in AccountSet transactions but does nothing.
*
* @return An optionally present {@link UnsignedInteger}.
*/
@JsonProperty("WalletSize")
Optional<UnsignedInteger> walletSize();

/**
* Check email hash length.
*/
Expand Down
18 changes: 12 additions & 6 deletions xrpl4j-core/src/test/java/org/xrpl/xrpl4j/codec/binary/BinarySerializationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,32 +137,38 @@ public void serializeAccountSetTransactionWithNetworkId() throws JsonProcessingE
}

@Test
public void serializeAccountSetTransactionWithDomain() throws JsonProcessingException {
public void serializeAccountSetTransactionWithPresentOptionalStringFields() throws JsonProcessingException {
AccountSet accountSet = AccountSet.builder()
.account(Address.of("rpP2GdsQwenNnFPefbXFgiTvEgJWQpq8Rw"))
.fee(XrpCurrencyAmount.ofDrops(10))
.sequence(UnsignedInteger.valueOf(10598))
.networkId(NetworkId.of(UnsignedInteger.MAX_VALUE))
.domain("ABCD")
.messageKey("03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB")
.emailHash("F9879D71855B5FF21E4963273A886BFC")
.walletLocator("F9879D71855B5FF21E4963273A886BFCF9879D71855B5FF21E4963273A886BFC")
.build();

String expectedBinary = "12000321FFFFFFFF240000296668400000000000000A73007702ABCD81140F3D0C7D2CFAB2EC8" +
"295451F0B3CA038E8E9CDCD";
String expectedBinary = "12000321FFFFFFFF240000296641F9879D71855B5FF21E4963273A886BFC57F98" +
"79D71855B5FF21E4963273A886BFCF9879D71855B5FF21E4963273A886BFC68400000000000000A722103AB" +
"40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB73007702ABCD81140F3D0C7D2" +
"CFAB2EC8295451F0B3CA038E8E9CDCD";
assertSerializesAndDeserializes(accountSet, expectedBinary);
}

@Test
public void serializeAccountSetTransactionWithEmptyStringDomain() throws JsonProcessingException {
public void serializeAccountSetTransactionWithEmptyStrings() throws JsonProcessingException {
AccountSet accountSet = AccountSet.builder()
.account(Address.of("rpP2GdsQwenNnFPefbXFgiTvEgJWQpq8Rw"))
.fee(XrpCurrencyAmount.ofDrops(10))
.sequence(UnsignedInteger.valueOf(10598))
.networkId(NetworkId.of(UnsignedInteger.MAX_VALUE))
.domain("")
.messageKey("")
.build();

String expectedBinary = "12000321FFFFFFFF240000296668400000000000000A7300770081140F3D0C7D2CFAB2EC829545" +
"1F0B3CA038E8E9CDCD";
String expectedBinary = "12000321FFFFFFFF240000296668400000000000000A72007300" +
"770081140F3D0C7D2CFAB2EC8295451F0B3CA038E8E9CDCD";
assertSerializesAndDeserializes(accountSet, expectedBinary);
}

Expand Down
31 changes: 17 additions & 14 deletions xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/json/AccountSetJsonTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
*/

import com.fasterxml.jackson.core.JsonProcessingException;
import com.google.common.base.Strings;
import com.google.common.primitives.UnsignedInteger;
import org.json.JSONException;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -57,6 +58,8 @@ public void fullyPopulatedAccountSet() throws JSONException, JsonProcessingExcep
.flags(AccountSetTransactionFlags.of(TransactionFlags.FULLY_CANONICAL_SIG.getValue()))
.mintAccount(Address.of("rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"))
.networkId(NetworkId.of(1024))
.walletLocator("ABCD")
.walletSize(UnsignedInteger.ONE)
.build();

String json = "{\n" +
Expand All @@ -74,24 +77,24 @@ public void fullyPopulatedAccountSet() throws JSONException, JsonProcessingExcep
" \"SigningPubKey\" : \"02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC\",\n" +
" \"NFTokenMinter\" : \"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn\",\n" +
" \"NetworkID\": 1024,\n" +
" \"WalletSize\": 1,\n" +
" \"WalletLocator\": \"ABCD\",\n" +
" \"EmailHash\":\"f9879d71855b5ff21e4963273a886bfc\"\n" +
"}";

assertCanSerializeAndDeserialize(accountSet, json);
}

@Test
public void accountSetWithEmptyDomain() throws JSONException, JsonProcessingException {
public void accountSetWithEmptyOptionalStringFields() throws JSONException, JsonProcessingException {
AccountSet accountSet = AccountSet.builder()
.account(Address.of("rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"))
.fee(XrpCurrencyAmount.ofDrops(12))
.sequence(UnsignedInteger.valueOf(5))
.setFlag(AccountSetFlag.ACCOUNT_TXN_ID)
.messageKey("03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB")
.transferRate(UnsignedInteger.valueOf(1000000001))
.tickSize(UnsignedInteger.valueOf(15))
.clearFlag(AccountSetFlag.DEFAULT_RIPPLE)
.emailHash("f9879d71855b5ff21e4963273a886bfc")
.signingPublicKey(
PublicKey.fromBase16EncodedPublicKey("02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC")
)
Expand All @@ -107,32 +110,31 @@ public void accountSetWithEmptyDomain() throws JSONException, JsonProcessingExce
" \"Sequence\":5,\n" +
" \"Flags\":2147483648,\n" +
" \"SetFlag\":5,\n" +
" \"MessageKey\":\"03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB\",\n" +
" \"TransferRate\":1000000001,\n" +
" \"TickSize\":15,\n" +
" \"ClearFlag\":8,\n" +
" \"SigningPubKey\" : \"02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC\",\n" +
" \"NFTokenMinter\" : \"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn\",\n" +
" \"NetworkID\": 1024,\n" +
" \"EmailHash\":\"f9879d71855b5ff21e4963273a886bfc\"\n" +
" \"NetworkID\": 1024\n" +
"}";

assertCanSerializeAndDeserialize(accountSet, json);
}

@Test
public void accountSetWithEmptyStringDomain() throws JSONException, JsonProcessingException {
public void accountSetWithEmptyStringFields() throws JSONException, JsonProcessingException {
AccountSet accountSet = AccountSet.builder()
.account(Address.of("rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"))
.fee(XrpCurrencyAmount.ofDrops(12))
.domain("")
.messageKey("")
.emailHash(Strings.repeat("0", 32))
.walletLocator(Strings.repeat("0", 64))
.sequence(UnsignedInteger.valueOf(5))
.setFlag(AccountSetFlag.ACCOUNT_TXN_ID)
.messageKey("03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB")
.transferRate(UnsignedInteger.valueOf(1000000001))
.tickSize(UnsignedInteger.valueOf(15))
.clearFlag(AccountSetFlag.DEFAULT_RIPPLE)
sappenin marked this conversation as resolved.
Show resolved Hide resolved
.emailHash("f9879d71855b5ff21e4963273a886bfc")
sappenin marked this conversation as resolved.
Show resolved Hide resolved
.signingPublicKey(
PublicKey.fromBase16EncodedPublicKey("02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC")
)
Expand All @@ -149,14 +151,15 @@ public void accountSetWithEmptyStringDomain() throws JSONException, JsonProcessi
" \"Flags\":2147483648,\n" +
" \"Domain\":\"\",\n" +
" \"SetFlag\":5,\n" +
" \"MessageKey\":\"03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB\",\n" +
" \"MessageKey\":\"\",\n" +
" \"TransferRate\":1000000001,\n" +
" \"TickSize\":15,\n" +
" \"ClearFlag\":8,\n" +
" \"SigningPubKey\" : \"02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC\",\n" +
" \"NFTokenMinter\" : \"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn\",\n" +
" \"NetworkID\": 1024,\n" +
" \"EmailHash\":\"f9879d71855b5ff21e4963273a886bfc\"\n" +
" \"WalletLocator\" : \"" + Strings.repeat("0", 64) + "\",\n" +
" \"EmailHash\" : \"" + Strings.repeat("0", 32) + "\",\n" +
" \"NetworkID\": 1024\n" +
"}";

assertCanSerializeAndDeserialize(accountSet, json);
Expand All @@ -174,7 +177,7 @@ public void testJsonWithUnsetFlags() throws JsonProcessingException, JSONExcepti
.transferRate(UnsignedInteger.valueOf(1000000001))
.tickSize(UnsignedInteger.valueOf(15))
.clearFlag(AccountSetFlag.DEFAULT_RIPPLE)
.emailHash("f9879d71855b5ff21e4963273a886bfc")
.emailHash(Strings.repeat("0", 32))
.signingPublicKey(
PublicKey.fromBase16EncodedPublicKey("02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC")
)
Expand All @@ -196,7 +199,7 @@ public void testJsonWithUnsetFlags() throws JsonProcessingException, JSONExcepti
" \"ClearFlag\":8,\n" +
" \"SigningPubKey\" : \"02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC\",\n" +
" \"NFTokenMinter\" : \"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn\",\n" +
" \"EmailHash\":\"f9879d71855b5ff21e4963273a886bfc\"\n" +
" \"EmailHash\":\"" + Strings.repeat("0", 32) + "\"\n" +
"}";

assertCanSerializeAndDeserialize(accountSet, json);
Expand Down
15 changes: 14 additions & 1 deletion xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AccountSetIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static org.assertj.core.api.Assertions.assertThat;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.google.common.base.Strings;
import com.google.common.primitives.UnsignedInteger;
import org.junit.jupiter.api.Test;
import org.xrpl.xrpl4j.client.JsonRpcClientErrorException;
Expand Down Expand Up @@ -393,7 +394,7 @@ void submitAndRetrieveAccountSetWithZeroClearFlagAndSetFlag()
}

@Test
void setAndUnsetDomain() throws JsonRpcClientErrorException, JsonProcessingException {
void setAndUnsetDomainAndMessageKey() throws JsonRpcClientErrorException, JsonProcessingException {
KeyPair keyPair = constructRandomAccount();

///////////////////////
Expand All @@ -409,6 +410,9 @@ void setAndUnsetDomain() throws JsonRpcClientErrorException, JsonProcessingExcep
.sequence(accountInfo.accountData().sequence())
.signingPublicKey(keyPair.publicKey())
.domain("ABCD")
.messageKey("03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB")
.emailHash("F9879D71855B5FF21E4963273A886BFC")
.walletLocator("F9879D71855B5FF21E4963273A886BFCF9879D71855B5FF21E4963273A886BFC")
.build();

SingleSignedTransaction<AccountSet> signedSetDomain = signatureService.sign(
Expand All @@ -429,13 +433,19 @@ void setAndUnsetDomain() throws JsonRpcClientErrorException, JsonProcessingExcep
() -> this.getValidatedAccountInfo(keyPair.publicKey().deriveAddress())
);
assertThat(accountInfo.accountData().domain()).isNotEmpty().isEqualTo(setDomain.domain());
assertThat(accountInfo.accountData().messageKey()).isNotEmpty().isEqualTo(setDomain.messageKey());
assertThat(accountInfo.accountData().emailHash()).isNotEmpty().isEqualTo(setDomain.emailHash());
assertThat(accountInfo.accountData().walletLocator()).isNotEmpty().isEqualTo(setDomain.walletLocator());

AccountSet clearDomain = AccountSet.builder()
.account(keyPair.publicKey().deriveAddress())
.fee(FeeUtils.computeNetworkFees(feeResult).recommendedFee())
.sequence(accountInfo.accountData().sequence())
.signingPublicKey(keyPair.publicKey())
.domain("")
.messageKey("")
.emailHash(Strings.repeat("0", 32))
.walletLocator(Strings.repeat("0", 64))
.build();

SingleSignedTransaction<AccountSet> signedClearDomain = signatureService.sign(
Expand All @@ -457,6 +467,9 @@ void setAndUnsetDomain() throws JsonRpcClientErrorException, JsonProcessingExcep
() -> this.getValidatedAccountInfo(keyPair.publicKey().deriveAddress())
);
assertThat(accountInfo.accountData().domain()).isEmpty();
assertThat(accountInfo.accountData().messageKey()).isEmpty();
assertThat(accountInfo.accountData().emailHash()).isEmpty();
assertThat(accountInfo.accountData().walletLocator()).isEmpty();
}

//////////////////////
Expand Down
Loading