Python/single account

Cargo.toml

@@ -3,8 +3,7 @@ resolver = "2"
 members = [
 	"bindings/core",
 	"bindings/nodejs",
-	# TODO: issue #1423
-	#"bindings/python",
+	"bindings/python",
 	"bindings/wasm",
 	"cli",
 	"sdk",

bindings/python/.pylintrc

@@ -9,7 +9,7 @@ disable=missing-module-docstring,
 	fixme, # TODOS 
 	too-many-instance-attributes,
 	too-many-arguments,
-	too-few-public-methods
+	too-few-public-methods,
 	too-many-public-methods,
 	too-many-locals
 

bindings/python/README.md

@@ -96,7 +96,7 @@ The following example creates a Client instance connected to the Shimmer Testnet
 
 ## Wallet Usage
 
-The following example will create a new Wallet Account  using a StrongholdSecretManager, and then print the account's information.
+The following example will create a new Wallet using a StrongholdSecretManager, and then print the wallet's information.
 
 [examples/wallet/getting_started.py](examples/wallet/getting_started.py)
 

bindings/python/examples/client/04_get_output.py

@@ -14,5 +14,5 @@
 
 # Get an outputs by its id
 output_with_metadata = client.get_output(
-    '0x022aefa73dff09b35b21ab5493412b0d354ad07a970a12b71e8087c6f3a7b8660000')
+    '0x022aefa73dff09b35b21ab5493412b0d354ad07a970a12b71e8087c6f3a7b866000000000000')
 print(json.dumps(output_with_metadata.to_dict(), indent=4))

bindings/python/examples/exchange/1_create_account.py → bindings/python/examples/exchange/1_create_wallet.py

@@ -8,7 +8,7 @@
 from dotenv import load_dotenv
 
 from iota_sdk import (ClientOptions, CoinType, StrongholdSecretManager,
-                      SyncOptions, Wallet)
+                      SecretManager, SyncOptions, Wallet, WalletOptions, Bip44)
 
 # This example uses secrets in environment variables for simplicity which
 # should not be done in production.
@@ -24,19 +24,21 @@
 secret_manager = StrongholdSecretManager(
     os.environ.get('STRONGHOLD_SNAPSHOT_PATH'), os.environ['STRONGHOLD_PASSWORD'])
 
-wallet = Wallet(os.environ.get('WALLET_DB_PATH'),
-                client_options, CoinType.IOTA, secret_manager)
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once.
-wallet.store_mnemonic(
-    os.environ['MNEMONIC'])
+SecretManager(secret_manager).store_mnemonic(os.environ['MNEMONIC'])
 
-account = wallet.create_account('Alice')
+bip_path = Bip44(
+    coin_type=CoinType.SHIMMER
+)
+wallet_options = WalletOptions(None, None, bip_path, client_options, secret_manager, os.environ.get('WALLET_DB_PATH'))
+wallet = Wallet(wallet_options)
 
 # Set sync_only_most_basic_outputs to True if not interested in outputs that are timelocked,
 # have a storage deposit return, expiration or are nft/account/foundry outputs.
-account.set_default_sync_options(
+wallet.set_default_sync_options(
     SyncOptions(sync_only_most_basic_outputs=True))
 
-print(account.get_metadata())
+# Update the wallet to the latest state
+balance = wallet.sync()
+print('Generated new wallet')

bindings/python/examples/exchange/2_generate_address.py

@@ -1,27 +1,24 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
-# This example generates an address for an account.
+# This example generates an address for a wallet.
 
 import os
 
 from dotenv import load_dotenv
 
-from iota_sdk import Wallet
+from iota_sdk import StrongholdSecretManager, SecretManager
 
 # This example uses secrets in environment variables for simplicity which
 # should not be done in production.
 load_dotenv()
 
-for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD']:
+for env_var in ['STRONGHOLD_SNAPSHOT_PATH', 'STRONGHOLD_PASSWORD']:
     if env_var not in os.environ:
         raise Exception(f'.env {env_var} is undefined, see .env.example')
 
-wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
+secret_manager = SecretManager(StrongholdSecretManager(
+    os.environ.get('STRONGHOLD_SNAPSHOT_PATH'), os.environ['STRONGHOLD_PASSWORD']))
 
-wallet.set_stronghold_password(os.environ["STRONGHOLD_PASSWORD"])
-
-account = wallet.get_account('Alice')
-
-address = account.generate_ed25519_addresses(1)[0]
-print('Address:', address.address)
+address = secret_manager.generate_ed25519_addresses(1)[0]
+print('Address:', address)

bindings/python/examples/exchange/3_check_balance.py

@@ -1,32 +1,31 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
-# This example gets the balance of an account.
+# This example gets the balance of a wallet.
 
 import os
 
 from dotenv import load_dotenv
 
-from iota_sdk import SyncOptions, Wallet
+from iota_sdk import SyncOptions, Wallet, WalletOptions
 
 # This example uses secrets in environment variables for simplicity which
 # should not be done in production.
 load_dotenv()
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'FAUCET_URL']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
-wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
 
-account = wallet.get_account('Alice')
-
-addresses = account.addresses()
-print('Addresses:', addresses)
+address = wallet.address()
+print('Address:', address)
 
 # Set sync_only_most_basic_outputs to True if not interested in outputs that are timelocked,
 # have a storage deposit return, expiration or are nft/account/foundry outputs.
-balance = account.sync(SyncOptions(sync_only_most_basic_outputs=True))
+balance = wallet.sync(SyncOptions(sync_only_most_basic_outputs=True))
 print('Balance', balance)
 
 # Use the faucet to send tokens to your address.
-print('Fill your address with the Faucet: https://faucet.testnet.shimmer.network/')
+print(f'Fill your address with the Faucet: {os.environ["FAUCET_URL"]}')

bindings/python/examples/exchange/4_listen_events.py

@@ -10,18 +10,17 @@
 
 from dotenv import load_dotenv
 
-from iota_sdk import SyncOptions, Wallet, WalletEventType
+from iota_sdk import SyncOptions, Wallet, WalletOptions, WalletEventType
 
 # This example uses secrets in environment variables for simplicity which
 # should not be done in production.
 load_dotenv()
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'FAUCET_URL']:
+    if env_var not in os.environ:
+        raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
 
-wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
-
-account = wallet.get_account('Alice')
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
 
 received_event = False
 
@@ -41,13 +40,11 @@ def callback(event):
 # Only interested in new outputs here.
 wallet.listen(callback, [WalletEventType.NewOutput])
 
-account = wallet.get_account('Alice')
-
 # Use the faucet to send testnet tokens to your address.
-print('Fill your address with the faucet: https://faucet.testnet.shimmer.network/')
+print(f'Fill your address with the Faucet: {os.environ["FAUCET_URL"]}')
 
-addresses = account.addresses()
-print('Send funds to:', addresses[0].address)
+address = wallet.address()
+print('Send funds to:', address)
 
 # Sync every 5 seconds until the faucet transaction gets confirmed.
 for _ in range(100):
@@ -59,4 +56,4 @@ def callback(event):
     # Set sync_only_most_basic_outputs to True if not interested in outputs that are timelocked,
     # have a storage deposit return , expiration or are nft/account/foundry
     # outputs.
-    account.sync(SyncOptions(sync_only_most_basic_outputs=True))
+    wallet.sync(SyncOptions(sync_only_most_basic_outputs=True))

bindings/python/examples/exchange/5_send_amount.py

@@ -7,7 +7,7 @@
 
 from dotenv import load_dotenv
 
-from iota_sdk import SyncOptions, Wallet
+from iota_sdk import SyncOptions, Wallet, WalletOptions
 
 # This example uses secrets in environment variables for simplicity which
 # should not be done in production.
@@ -17,18 +17,16 @@
     if env_var not in os.environ:
         raise Exception(f'.env {env_var} is undefined, see .env.example')
 
-wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
-
-account = wallet.get_account('Alice')
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
 
 wallet.set_stronghold_password(os.environ["STRONGHOLD_PASSWORD"])
 
 # Set sync_only_most_basic_outputs to True if not interested in outputs that are timelocked,
 # have a storage deposit return, expiration or are nft/account/foundry outputs.
-balance = account.sync(SyncOptions(sync_only_most_basic_outputs=True))
+balance = wallet.sync(SyncOptions(sync_only_most_basic_outputs=True))
 print('Balance', balance)
 
-transaction = account.send(
+transaction = wallet.send(
     1000000,
     "rms1qpszqzadsym6wpppd6z037dvlejmjuke7s24hm95s9fg9vpua7vluaw60xu",
 )

bindings/python/examples/how_tos/account_output/create.py

@@ -1,25 +1,33 @@
 import os
+import time
 
 from dotenv import load_dotenv
 
-from iota_sdk import Wallet
-
-load_dotenv()
+from iota_sdk import Wallet, WalletOptions
 
 # In this example we will create an account output
 
-wallet = Wallet(os.environ['WALLET_DB_PATH'])
+load_dotenv()
 
-account = wallet.get_account('Alice')
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
 
-# Sync account with the node
-account.sync()
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+# Sync wallet with the node
+balance = wallet.sync()
+print(f'Accounts BEFORE: {balance.accounts}')
 
 wallet.set_stronghold_password(os.environ["STRONGHOLD_PASSWORD"])
 
+print("Sending the create-account transaction...")
+
 # Send transaction.
-transaction = account.create_account_output(None, None)
+transaction = wallet.create_account_output(None, None)
 print(f'Block sent: {os.environ["EXPLORER_URL"]}/block/{transaction.block_id}')
+
+time.sleep(10)
+
+balance = wallet.sync()
+print(f'Accounts AFTER: {balance.accounts}')

bindings/python/examples/how_tos/account_output/destroy.py

@@ -2,27 +2,26 @@
 
 from dotenv import load_dotenv
 
-from iota_sdk import Wallet
-
-load_dotenv()
+from iota_sdk import Wallet, WalletOptions
 
 # In this example we will destroy an account output
 
-wallet = Wallet(os.environ['WALLET_DB_PATH'])
+load_dotenv()
 
-account = wallet.get_account('Alice')
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
 
-# Sync account with the node
-balance = account.sync()
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
+
+# Sync wallet with the node
+balance = wallet.sync()
 
 # We try to destroy the first account in the account
 account_id = balance.accounts[0]
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
-
 wallet.set_stronghold_password(os.environ["STRONGHOLD_PASSWORD"])
 
 # Send transaction.
-transaction = account.prepare_destroy_account(account_id).send()
+transaction = wallet.prepare_destroy_account(account_id).send()
 print(f'Block sent: {os.environ["EXPLORER_URL"]}/block/{transaction.block_id}')

bindings/python/examples/how_tos/account_output/implicit_account_creation.py

@@ -0,0 +1,18 @@
+import os
+
+from dotenv import load_dotenv
+
+from iota_sdk import Wallet, WalletOptions
+
+# In this example, we create an implicit account creation address.
+
+load_dotenv()
+
+if 'WALLET_DB_PATH' not in os.environ:
+    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
+
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
+
+# Get the implicit account address
+address = wallet.implicit_account_creation_address()
+print(f'Fund the following address: {address}')

bindings/python/examples/how_tos/account_wallet/request_funds.py

@@ -3,19 +3,22 @@
 
 from dotenv import load_dotenv
 
-from iota_sdk import Wallet, Utils, SyncOptions, AccountSyncOptions
+from iota_sdk import Wallet, WalletOptions, Utils, SyncOptions, WalletSyncOptions
 
 # In this example we request funds to an account wallet.
 
 load_dotenv()
 
+for env_var in ['FAUCET_URL', 'WALLET_DB_PATH', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
+
 FAUCET_URL = os.environ.get(
     'FAUCET_URL', 'https://faucet.testnet.shimmer.network/api/enqueue')
 
-wallet = Wallet(os.environ['WALLET_DB_PATH'])
-
-account = wallet.get_account('Alice')
-balance = account.sync(None)
+wallet = Wallet(WalletOptions(storage_path=os.environ.get('WALLET_DB_PATH')))
+balance = wallet.sync(None)
+print(f'{balance}')
 
 total_base_token_balance = balance.base_coin.total
 print(
@@ -33,8 +36,8 @@
 
 time.sleep(10)
 
-sync_options = SyncOptions(alias=AccountSyncOptions(basic_outputs=True))
+sync_options = SyncOptions(wallet=WalletSyncOptions(basic_outputs=True))
 
-total_base_token_balance = account.sync(sync_options).base_coin.total
+total_base_token_balance = wallet.sync(sync_options).base_coin.total
 print(
     f'Balance after requesting funds on account address: {total_base_token_balance}')