breaking: Refactored wallet class and removed wallet sequence

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0]
+### Added:
+- Wallet support for regular key compatibility
+- Added new ways of wallet generation: `from_seed`, `from_secret`, `from_entropy`
+- Added address alias to `Wallet.classic_address `
+
+### Changed:
+- Updated params for Wallet class constructor
+- `Wallet.address` and `Wallet.classic_address` are now readonly
+- Removed Sequence from Wallet class
+- Core keypairs generate seed must take in hexstring instead of bytestring
+- Core keypairs formatting for ED25519 is now padded with zeros if length of keystring is less than 64
+
 ## [[Unreleased]]
 ### Added:
 - Created function alias to `safe_sign_transaction` called `sign` - safe originally used to indicate local offline signing (keys aren't exposed)

README.md

@@ -167,7 +167,6 @@ from xrpl.ledger import get_latest_validated_ledger_sequence
 from xrpl.account import get_next_valid_seq_number
 
 current_validated_ledger = get_latest_validated_ledger_sequence(client)
-test_wallet.sequence = get_next_valid_seq_number(test_wallet.classic_address, client)
 
 # prepare the transaction
 # the amount is expressed in drops, not XRP
@@ -177,7 +176,7 @@ my_tx_payment = Payment(
     amount="2200000",
     destination="rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
     last_ledger_sequence=current_validated_ledger + 20,
-    sequence=test_wallet.sequence,
+    sequence=get_next_valid_seq_number(test_wallet.classic_address, client),
     fee="10",
 )
 # sign the transaction
@@ -285,7 +284,6 @@ async_client = AsyncJsonRpcClient(JSON_RPC_URL)
 
 async def submit_sample_transaction():
     current_validated_ledger = await get_latest_validated_ledger_sequence(async_client)
-    test_wallet.sequence = await get_next_valid_seq_number(test_wallet.classic_address, async_client)
 
     # prepare the transaction
     # the amount is expressed in drops, not XRP
@@ -295,7 +293,7 @@ async def submit_sample_transaction():
         amount="2200000",
         destination="rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
         last_ledger_sequence=current_validated_ledger + 20,
-        sequence=test_wallet.sequence,
+        sequence=await get_next_valid_seq_number(test_wallet.classic_address, async_client),
         fee="10",
     )
     # sign the transaction

tests/integration/it_utils.py

@@ -6,15 +6,14 @@
 from time import sleep
 
 import xrpl  # noqa: F401 - needed for sync tests
-from xrpl.account import get_next_valid_seq_number
-from xrpl.asyncio.account import get_next_valid_seq_number as get_seq_num_async
 from xrpl.asyncio.clients import AsyncJsonRpcClient, AsyncWebsocketClient
 from xrpl.asyncio.clients.async_client import AsyncClient
 from xrpl.asyncio.transaction import (
     safe_sign_and_submit_transaction as sign_and_submit_async,
 )
 from xrpl.clients import Client, JsonRpcClient, WebsocketClient
 from xrpl.clients.sync_client import SyncClient
+from xrpl.constants import CryptoAlgorithm
 from xrpl.models import GenericRequest, Payment, Request, Response, Transaction
 from xrpl.transaction import (  # noqa: F401 - needed for sync tests
     autofill_and_sign,
@@ -56,8 +55,8 @@
 }
 
 MASTER_ACCOUNT = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"
-MASTER_SECRET = "snoPBrXtMeMyMHUVTgbuqAfg1SUTb"
-MASTER_WALLET = Wallet(MASTER_SECRET, 0)
+MASTER_SEED = "snoPBrXtMeMyMHUVTgbuqAfg1SUTb"
+MASTER_WALLET = Wallet.from_seed(MASTER_SEED, algorithm=CryptoAlgorithm.SECP256K1)
 FUNDING_AMOUNT = "1200000000"
 
 LEDGER_ACCEPT_REQUEST = GenericRequest(method="ledger_accept")
@@ -106,7 +105,6 @@ def fund_wallet_sync(wallet: Wallet) -> None:
     )
     safe_sign_and_submit_transaction(payment, MASTER_WALLET, client, check_fee=True)
     client.request(LEDGER_ACCEPT_REQUEST)
-    wallet.sequence = get_next_valid_seq_number(wallet.classic_address, client)
 
 
 async def fund_wallet(
@@ -119,7 +117,6 @@ async def fund_wallet(
     )
     await sign_and_submit_async(payment, MASTER_WALLET, client, check_fee=True)
     await client.request(LEDGER_ACCEPT_REQUEST)
-    wallet.sequence = await get_seq_num_async(wallet.classic_address, client)
 
 
 def submit_transaction(

tests/integration/reqs/test_submit_multisigned.py

@@ -5,6 +5,7 @@
     test_async_and_sync,
 )
 from tests.integration.reusable_values import WALLET
+from xrpl.asyncio.account import get_next_valid_seq_number
 from xrpl.core.binarycodec import encode_for_multisigning
 from xrpl.core.keypairs import sign
 from xrpl.ledger import get_fee
@@ -21,15 +22,12 @@
 
 FEE = get_fee(JSON_RPC_CLIENT)
 
-#
 # Set up signer list
 FIRST_SIGNER = Wallet.create()
 SECOND_SIGNER = Wallet.create()
 LIST_SET_TX = sign_and_reliable_submission(
     SignerListSet(
         account=WALLET.classic_address,
-        sequence=WALLET.sequence,
-        last_ledger_sequence=WALLET.sequence + 10,
         fee=FEE,
         signer_quorum=2,
         signer_entries=[
@@ -48,7 +46,7 @@
 
 
 class TestSubmitMultisigned(IntegrationTestCase):
-    @test_async_and_sync(globals())
+    @test_async_and_sync(globals(), ["xrpl.account.get_next_valid_seq_number"])
     async def test_basic_functionality(self, client):
         #
         # Perform multisign
@@ -59,7 +57,7 @@ async def test_basic_functionality(self, client):
         issuer = Wallet.create()
         tx = TrustSet(
             account=WALLET.classic_address,
-            sequence=WALLET.sequence,
+            sequence=await get_next_valid_seq_number(WALLET.classic_address, client),
             fee=FEE,
             flags=TrustSetFlag.TF_SET_NO_RIPPLE,
             limit_amount=IssuedCurrencyAmount(
@@ -89,7 +87,7 @@ async def test_basic_functionality(self, client):
         )
         multisigned_tx = TrustSet(
             account=WALLET.classic_address,
-            sequence=WALLET.sequence,
+            sequence=await get_next_valid_seq_number(WALLET.classic_address, client),
             fee=FEE,
             flags=TrustSetFlag.TF_SET_NO_RIPPLE,
             limit_amount=IssuedCurrencyAmount(

tests/integration/reqs/test_submit_only.py

@@ -9,8 +9,6 @@
 
 TX = OfferCreate(
     account=WALLET.classic_address,
-    sequence=WALLET.sequence,
-    last_ledger_sequence=WALLET.sequence + 10,
     taker_gets="13100000",
     taker_pays=IssuedCurrencyAmount(
         currency="USD",
@@ -24,6 +22,7 @@ class TestSubmitOnly(IntegrationTestCase):
     @test_async_and_sync(globals(), ["xrpl.transaction.autofill_and_sign"])
     async def test_basic_functionality(self, client):
         transaction = await autofill_and_sign(TX, WALLET, client)
+
         tx_json = transaction.to_xrpl()
         tx_blob = encode(tx_json)
         response = await client.request(

tests/integration/reusable_values.py

@@ -18,7 +18,6 @@ async def _set_up_reusable_values():
     OFFER = await sign_and_reliable_submission_async(
         OfferCreate(
             account=WALLET.classic_address,
-            sequence=WALLET.sequence,
             taker_gets="13100000",
             taker_pays=IssuedCurrencyAmount(
                 currency="USD",
@@ -28,20 +27,17 @@ async def _set_up_reusable_values():
         ),
         WALLET,
     )
-    WALLET.sequence += 1
 
     PAYMENT_CHANNEL = await sign_and_reliable_submission_async(
         PaymentChannelCreate(
             account=WALLET.classic_address,
-            sequence=WALLET.sequence,
             amount="1",
             destination=DESTINATION.classic_address,
             settle_delay=86400,
             public_key=WALLET.public_key,
         ),
         WALLET,
     )
-    WALLET.sequence += 1
 
     return (
         WALLET,

tests/integration/sugar/test_account.py

@@ -87,7 +87,6 @@ async def test_get_latest_transaction(self, client):
             amount=amount,
         )
         await sign_and_reliable_submission_async(payment, WALLET)
-        WALLET.sequence += 1
 
         response = await get_latest_transaction(WALLET.classic_address, client)
         self.assertEqual(len(response.result["transactions"]), 1)