mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 03:35:51 +00:00
Build a wallet tutorial: draft steps 1-3
1. wxPython app that shows XRPL data (once) 2. threaded app monitoring XRPL in background 3. Decode address & watch for balance
This commit is contained in:
mDuo13
46
content/_code-samples/build-a-wallet/py/1_hello.py
Normal file
46
content/_code-samples/build-a-wallet/py/1_hello.py
Normal file
@@ -0,0 +1,46 @@
|
||||
# "Build a Wallet" tutorial, step 1: slightly more than "Hello World"
|
||||
|
||||
import xrpl
|
||||
import wx
|
||||
|
||||
class TWaXLFrame(wx.Frame):
|
||||
"""
|
||||
Tutorial Wallet for the XRP Ledger (TWaXL)
|
||||
user interface, main frame.
|
||||
"""
|
||||
def __init__(self, url):
|
||||
super(TWaXLFrame, self).__init__(None, title="TWaXL")
|
||||
|
||||
self.client = xrpl.clients.JsonRpcClient(url)
|
||||
|
||||
main_panel = wx.Panel(self)
|
||||
main_sizer = wx.BoxSizer(wx.VERTICAL)
|
||||
main_panel.SetSizer(main_sizer)
|
||||
|
||||
st = wx.StaticText(main_panel, label=self.get_validated_ledger())
|
||||
main_sizer.Add(st, wx.SizerFlags().Border(wx.TOP|wx.LEFT, 25))
|
||||
|
||||
def get_validated_ledger(self):
|
||||
try:
|
||||
response = self.client.request(xrpl.models.requests.Ledger(
|
||||
ledger_index="validated"
|
||||
))
|
||||
except Exception as e:
|
||||
return f"Failed to get validated ledger from server. ({e})"
|
||||
|
||||
if response.is_successful():
|
||||
return f"Latest validated ledger: {response.result['ledger_index']}"
|
||||
else:
|
||||
# Connected to the server, but the request failed. This can
|
||||
# happen if, for example, the server isn't synced to the network
|
||||
# so it doesn't have the latest validated ledger.
|
||||
return f"Server returned an error: {response.result['error_message']}"
|
||||
|
||||
if __name__ == "__main__":
|
||||
JSON_RPC_URL = "https://s.altnet.rippletest.net:51234/"
|
||||
#JSON_RPC_URL = "http://localhost:5005/"
|
||||
|
||||
app = wx.App()
|
||||
frame = TWaXLFrame(JSON_RPC_URL)
|
||||
frame.Show()
|
||||
app.MainLoop()
|
||||
72
content/_code-samples/build-a-wallet/py/2_threaded.py
Normal file
72
content/_code-samples/build-a-wallet/py/2_threaded.py
Normal file
@@ -0,0 +1,72 @@
|
||||
# "Build a Wallet" tutorial, step 2: Watch ledger closes from a worker thread.
|
||||
|
||||
import xrpl
|
||||
import wx
|
||||
# New dependencies
|
||||
from threading import Thread
|
||||
import wx.lib.newevent
|
||||
|
||||
# Set up an event type to pass info from the worker thread to the main thread
|
||||
GotNewLedger, EVT_NEW_LEDGER = wx.lib.newevent.NewEvent()
|
||||
class XRPLMonitorThread(Thread):
|
||||
"""
|
||||
A worker thread to watch for new ledger events and pass the info back to
|
||||
the main frame to be shown in the UI. Using a thread lets us maintain the
|
||||
responsiveness of the UI while doing work in the background.
|
||||
"""
|
||||
def __init__(self, ws_url, notify_window):
|
||||
Thread.__init__(self, daemon=True)
|
||||
self.notify_window = notify_window
|
||||
self.ws_url = ws_url
|
||||
|
||||
def run(self):
|
||||
with xrpl.clients.WebsocketClient(self.ws_url) as client:
|
||||
# Subscribe to ledger updates
|
||||
client.send(xrpl.models.requests.Subscribe(
|
||||
id="ledger_sub",
|
||||
streams=[xrpl.models.requests.StreamParameter.LEDGER]
|
||||
))
|
||||
# Watch for messages in the client
|
||||
for message in client:
|
||||
if message.get("id") == "ledger_sub":
|
||||
# Immediate response to our subscribe command.
|
||||
wx.QueueEvent(self.notify_window, GotNewLedger(data=message["result"]))
|
||||
elif message.get("type") == "ledgerClosed":
|
||||
# Ongoing notifications that new ledgers have been validated.
|
||||
wx.QueueEvent(self.notify_window, GotNewLedger(data=message))
|
||||
else:
|
||||
print("Unhandled message:", message)
|
||||
|
||||
class TWaXLFrame(wx.Frame):
|
||||
"""
|
||||
Tutorial Wallet for the XRP Ledger (TWaXL)
|
||||
user interface, main frame.
|
||||
"""
|
||||
def __init__(self, url):
|
||||
wx.Frame.__init__(self, None, title="TWaXL", size=wx.Size(800,400))
|
||||
|
||||
main_panel = wx.Panel(self)
|
||||
main_sizer = wx.BoxSizer(wx.VERTICAL)
|
||||
main_panel.SetSizer(main_sizer)
|
||||
|
||||
self.st = wx.StaticText(main_panel, label="Not connected")
|
||||
main_sizer.Add(self.st, wx.SizerFlags().Border(wx.TOP|wx.LEFT, 25))
|
||||
|
||||
self.Bind(EVT_NEW_LEDGER, self.update_ledger)
|
||||
XRPLMonitorThread(url, self).start()
|
||||
|
||||
def update_ledger(self, event):
|
||||
message = event.data
|
||||
self.st.SetLabel(f"Latest validated ledger:\n"
|
||||
f"Ledger Index: {message['ledger_index']}\n"
|
||||
f"Ledger Hash: {message['ledger_hash']}")
|
||||
|
||||
if __name__ == "__main__":
|
||||
#JSON_RPC_URL = "https://s.altnet.rippletest.net:51234/"
|
||||
#JSON_RPC_URL = "http://localhost:5005/"
|
||||
WS_URL = "wss://s.altnet.rippletest.net:51233"
|
||||
|
||||
app = wx.App()
|
||||
frame = TWaXLFrame(WS_URL)
|
||||
frame.Show()
|
||||
app.MainLoop()
|
||||
166
content/_code-samples/build-a-wallet/py/3_account.py
Normal file
166
content/_code-samples/build-a-wallet/py/3_account.py
Normal file
@@ -0,0 +1,166 @@
|
||||
# "Build a Wallet" tutorial, step 2: Watch ledger closes from a worker thread.
|
||||
|
||||
import xrpl
|
||||
import wx
|
||||
from threading import Thread
|
||||
import wx.lib.newevent
|
||||
|
||||
# Set up an event type to pass info from the worker thread to the main thread
|
||||
GotNewLedger, EVT_NEW_LEDGER = wx.lib.newevent.NewEvent()
|
||||
GotAccountInfo, EVT_ACCT_INFO = wx.lib.newevent.NewEvent()
|
||||
class XRPLMonitorThread(Thread):
|
||||
"""
|
||||
A worker thread to watch for new ledger events and pass the info back to
|
||||
the main frame to be shown in the UI. Using a thread lets us maintain the
|
||||
responsiveness of the UI while doing work in the background.
|
||||
"""
|
||||
def __init__(self, ws_url, notify_window, classic_address):
|
||||
Thread.__init__(self, daemon=True)
|
||||
self.notify_window = notify_window
|
||||
self.ws_url = ws_url
|
||||
self.account = classic_address
|
||||
|
||||
def run(self):
|
||||
with xrpl.clients.WebsocketClient(self.ws_url) as client:
|
||||
# Subscribe to ledger updates
|
||||
client.send(xrpl.models.requests.Subscribe(
|
||||
id="ledger_sub",
|
||||
streams=[xrpl.models.requests.StreamParameter.LEDGER],
|
||||
accounts=[self.account]
|
||||
))
|
||||
client.send(xrpl.models.requests.AccountInfo(
|
||||
id="acct_info",
|
||||
account=self.account,
|
||||
ledger_index="validated"
|
||||
))
|
||||
# Watch for messages in the client
|
||||
i = 0 # nonce so we don't reuse request IDs
|
||||
for message in client:
|
||||
#print(message)
|
||||
if message.get("id") == "ledger_sub":
|
||||
# Immediate response to our subscribe command.)
|
||||
wx.QueueEvent(self.notify_window, GotNewLedger(data=message["result"]))
|
||||
elif message.get("id") and "acct_info" in message.get("id"):
|
||||
wx.QueueEvent(self.notify_window, GotAccountInfo(data=message["result"]))
|
||||
elif message.get("type") == "ledgerClosed":
|
||||
# Ongoing notifications that new ledgers have been validated.
|
||||
wx.QueueEvent(self.notify_window, GotNewLedger(data=message))
|
||||
elif message.get("type") == "transaction":
|
||||
# Got a new transaction. Check for updated balances
|
||||
i+=1
|
||||
client.send(xrpl.models.requests.AccountInfo(
|
||||
id=f"acct_info{i}",
|
||||
account=self.account,
|
||||
ledger_index=message["ledger_index"]
|
||||
))
|
||||
else:
|
||||
print("Unhandled message:", message)
|
||||
|
||||
class TWaXLFrame(wx.Frame):
|
||||
"""
|
||||
Tutorial Wallet for the XRP Ledger (TWaXL)
|
||||
user interface, main frame.
|
||||
"""
|
||||
def __init__(self, url, test_network=True):
|
||||
wx.Frame.__init__(self, None, title="TWaXL", size=wx.Size(800,400))
|
||||
|
||||
self.test_network = test_network
|
||||
|
||||
main_panel = wx.Panel(self)
|
||||
main_sizer = wx.BoxSizer(wx.VERTICAL)
|
||||
|
||||
self.acct_info_area = wx.StaticBox(main_panel, label="Account Info")
|
||||
aia_sizer = wx.GridBagSizer(vgap=5, hgap=5)
|
||||
self.acct_info_area.SetSizer(aia_sizer)
|
||||
aia_sizer.Add(wx.StaticText(self.acct_info_area, label="Classic Address:"), (0,0))
|
||||
self.st_classic_address = wx.StaticText(self.acct_info_area, label="TBD")
|
||||
aia_sizer.Add(self.st_classic_address, (0,1))
|
||||
aia_sizer.Add(wx.StaticText(self.acct_info_area, label="X-Address:"), (1,0))
|
||||
self.st_x_address = wx.StaticText(self.acct_info_area, label="TBD")
|
||||
aia_sizer.Add(self.st_x_address, (1,1), flag=wx.EXPAND)
|
||||
aia_sizer.Add(wx.StaticText(self.acct_info_area, label="XRP Balance:"), (2,0))
|
||||
self.st_xrp_balance = wx.StaticText(self.acct_info_area, label="TBD")
|
||||
aia_sizer.Add(self.st_xrp_balance, (2,1), flag=wx.EXPAND)
|
||||
|
||||
main_sizer.Add(self.acct_info_area, 1, wx.EXPAND|wx.ALL, 25)
|
||||
|
||||
self.ledger_info = wx.StaticText(main_panel, label="Not connected")
|
||||
main_sizer.Add(self.ledger_info, 1, wx.EXPAND|wx.ALL, 25)
|
||||
|
||||
main_panel.SetSizer(main_sizer)
|
||||
|
||||
account_dialog = wx.TextEntryDialog(self,
|
||||
"Please enter an account address (for read-only)"
|
||||
" or your secret (for read-write access)",
|
||||
caption="Enter account",
|
||||
value="rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe")
|
||||
|
||||
if account_dialog.ShowModal() == wx.ID_OK:
|
||||
self.set_up_account(account_dialog.GetValue())
|
||||
account_dialog.Destroy()
|
||||
else:
|
||||
# If the user presses Cancel, exit the app.
|
||||
exit(1)
|
||||
|
||||
self.Bind(EVT_NEW_LEDGER, self.update_ledger)
|
||||
self.Bind(EVT_ACCT_INFO, self.update_account)
|
||||
XRPLMonitorThread(url, self, self.classic_address).start()
|
||||
|
||||
def set_up_account(self, value):
|
||||
value = value.strip()
|
||||
|
||||
if xrpl.core.addresscodec.is_valid_xaddress(value):
|
||||
classic_address, dest_tag, test_network = xrpl.core.addresscodec.xaddress_to_classic_address(value)
|
||||
if test_network != self.test_network:
|
||||
# TODO: handle network mismatch error better
|
||||
print(f"X-address {value} is meant for a different network type"
|
||||
f"than this client is connected to."
|
||||
f"(Client is on: {'a test network' if self.test_network else 'Mainnet'})")
|
||||
exit(1)
|
||||
self.xaddress = value
|
||||
self.classic_address = classic_address
|
||||
self.wallet = None
|
||||
|
||||
elif xrpl.core.addresscodec.is_valid_classic_address(value):
|
||||
self.xaddress = xrpl.core.addresscodec.classic_address_to_xaddress(
|
||||
value, tag=None, is_test_network=self.test_network)
|
||||
self.classic_address = value
|
||||
self.wallet = None
|
||||
|
||||
else:
|
||||
try:
|
||||
# Check if it's a valid seed
|
||||
seed_bytes, alg = xrpl.core.addresscodec.decode_seed(value)
|
||||
self.wallet = xrpl.wallet.Wallet(seed=value, sequence=0)
|
||||
# We'll fill in the actual sequence later.
|
||||
self.xaddress = self.wallet.get_xaddress(is_test=self.test_network)
|
||||
self.classic_address = self.wallet.classic_address
|
||||
except Exception as e:
|
||||
# TODO: handle invalid value better
|
||||
print(e)
|
||||
exit(1)
|
||||
self.st_classic_address.SetLabel(self.classic_address)
|
||||
self.st_x_address.SetLabel(self.xaddress)
|
||||
|
||||
def update_ledger(self, event):
|
||||
message = event.data
|
||||
close_time_iso = xrpl.utils.ripple_time_to_datetime(message["ledger_time"]).isoformat()
|
||||
self.ledger_info.SetLabel(f"Latest validated ledger:\n"
|
||||
f"Ledger Index: {message['ledger_index']}\n"
|
||||
f"Ledger Hash: {message['ledger_hash']}\n"
|
||||
f"Close time: {close_time_iso}")
|
||||
|
||||
def update_account(self, event):
|
||||
acct = event.data["account_data"]
|
||||
xrp_balance = str(xrpl.utils.drops_to_xrp(acct["Balance"]))
|
||||
self.st_xrp_balance.SetLabel(xrp_balance)
|
||||
|
||||
if __name__ == "__main__":
|
||||
#JSON_RPC_URL = "https://s.altnet.rippletest.net:51234/"
|
||||
#JSON_RPC_URL = "http://localhost:5005/"
|
||||
WS_URL = "wss://s.altnet.rippletest.net:51233"
|
||||
|
||||
app = wx.App()
|
||||
frame = TWaXLFrame(WS_URL)
|
||||
frame.Show()
|
||||
app.MainLoop()
|
||||
3
content/_code-samples/build-a-wallet/py/README.md
Normal file
3
content/_code-samples/build-a-wallet/py/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Build a Wallet Sample Code (Python)
|
||||
|
||||
This folder contains sample code for a non-custodial XRP Ledger wallet application in Python.
|
||||
2
content/_code-samples/build-a-wallet/py/requirements.txt
Normal file
2
content/_code-samples/build-a-wallet/py/requirements.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
xrpl-py==1.1.1
|
||||
wxPython=4.1.1
|
||||
Reference in New Issue
Block a user