Wallet related feature parity with Kaspa's WASM32 SDK

[smartgoo]

The current largest feature gap with WASM32 SDK is around wallet functionality.

Some components and primitives required for the higher level wallet abstractions are in place, while others need to be added.

Below is a (mostly complete but probably missing some things) list of components & features that need to be added to bring parity:

Classes:

• UtxoContext & UtxoProcessor (and required "sub" components Balance and and BalanceStrings) - Completed via PRs feat: add wallet UTXO processor/context bindings #10, feat: add generator support for UtxoContext #15, and feat: add UtxoProcessor event listeners #20
• PSKT & PSKB classes - blocked, draft PR is Add PSKT & PSKB functionality #3
• Wallet class and supporting/related components

There are likely other smaller or supporting classes that will need to be added as part of this work.

Functions:

• argon2sha256ivFromBinary
• argon2sha256ivFromText
• createAddress
• decryptXChaCha20Poly1305
• encryptXChaCha20Poly1305
• getNetworkParams
• getTransactionMaturityProgress
• setDefaultStorageFolder
• setDefaultWalletFile
• sha256FromBinary
• sha256FromText
• sha256dFromBinary
• sha256dFromText

The above exist in WASM32 SDK but do not currently exist in the Python SDK.

[smartgoo]

Wallet (and other supported components) added in #35 and refined over subsequent PRs. Will be in next release, which will likely be around the time of the rusty-kaspa tocatta hard fork release.

[s1ckoleg]

@smartgoo Hi there! Are there any plans on implementing support for Sweep operation to the Python SDK (seems like it's missing in the #35)? Should I create separate issue for it?

[smartgoo]

@s1ckoleg great question. As far as I'm aware, sweep is accomplished via accounts_send() in native rusty-kaspa. So, there is not a sweep specific Wallet method exposed to Python (nor WASM SDK). Let me know if I'm missing something!

There is an example of how to sweep funds using Python Wallet included in the repo, here is link:

kaspa-python-sdk/examples/wallet/transactions.py

Lines 244 to 264 in b188831

	print("\tSweep account_1 into a fresh receive address")
	print("-" * 100)
	sweep_address = await wallet.accounts_create_new_address(
	account_1.account_id, NewAddressKind.Receive
	)
	print(f"sweep destination: {sweep_address}\n")
	account_1_utxos = await wallet.accounts_get_utxos(account_id=account_1.account_id)
	sweep_total = sum(u["amount"] for u in account_1_utxos)
	print(f"account_1 total: {sweep_total} sompi across {len(account_1_utxos)} UTXO(s)\n")
	sweep_send = await wallet.accounts_send(
	wallet_secret=WALLET_SECRET,
	account_id=account_1.account_id,
	priority_fee_sompi=Fees(0, FeeSource.ReceiverPays),
	payment_secret=None,
	fee_rate=None,
	payload=None,
	destination=[PaymentOutput(sweep_address, sweep_total)],
	)

[s1ckoleg]

@smartgoo Oh, I guess it's even simpler:

kaspa-python-sdk/src/wallet/core/wallet.rs

Lines 1381 to 1383 in b188831

	/// destination: Optional list of PaymentOutputs. If None, the entire
	/// sweepable balance is routed to the account's change address
	/// (useful for compounding/sweeping UTXOs).

Seems like the sweep operation via Python SDK just comes to this simple send operation:

result = await wallet.accounts_send(
    wallet_secret=WALLET_SECRET,                                                                                                              
    account_id=account_id,                                
    priority_fee_sompi=Fees(0, source=None),
    destination=None,
)

It will send all UTXOs to the change address, exactly what rusty node wallet does.
Thank you for helping me to resolve my concern!

[smartgoo]

@s1ckoleg You're right, I already forgot about that :) I will update the example shortly.

Happy to help (with any further questions too). Glad to hear this is being considered for use.

Edit: I will update account_id param note since technically it can be passed as valid hex string or AccountId instance.