127 lines
4.0 KiB
Python
127 lines
4.0 KiB
Python
# (c) Copyright 2024 by Coinkite Inc. This file is covered by license found in COPYING-CC.
|
|
#
|
|
# wallet.py - A place you find UTXO, addresses and descriptors.
|
|
#
|
|
import chains
|
|
from descriptor import Descriptor
|
|
from stash import SensitiveValues
|
|
|
|
MAX_BIP32_IDX = (2 ** 31) - 1
|
|
|
|
class WalletABC:
|
|
# How to make this ABC useful without consuming memory/code space??
|
|
# - be more of an "interface" than a base class
|
|
|
|
# name
|
|
# addr_fmt
|
|
# chain
|
|
|
|
def yield_addresses(self, start_idx, count, change_idx=0):
|
|
# TODO: returns various tuples, with at least (idx, address, ...)
|
|
pass
|
|
|
|
def render_address(self, change_idx, idx):
|
|
# make one single address as text.
|
|
|
|
tmp = list(self.yield_addresses(idx, 1, change_idx=change_idx))
|
|
|
|
assert len(tmp) == 1
|
|
assert tmp[0][0] == idx
|
|
|
|
return tmp[0][1]
|
|
|
|
def to_descriptor(self):
|
|
pass
|
|
|
|
class MasterSingleSigWallet(WalletABC):
|
|
# Refers to current seed phrase, whichever is loaded master or temporary
|
|
def __init__(self, addr_fmt, path=None, account_idx=0, chain_name=None):
|
|
# Construct a wallet based on current master secret, and chain.
|
|
# - path is optional, and then we use standard path for addr_fmt
|
|
# - path can be overriden when we come here via address explorer
|
|
|
|
n = chains.addr_fmt_label(addr_fmt)
|
|
purpose = chains.af_to_bip44_purpose(addr_fmt)
|
|
prefix = path or 'm/%dh/{coin_type}h/{account}h' % purpose
|
|
|
|
if chain_name:
|
|
self.chain = chains.get_chain(chain_name)
|
|
else:
|
|
self.chain = chains.current_chain()
|
|
|
|
if account_idx != 0:
|
|
n += ' Account#%d' % account_idx
|
|
|
|
if self.chain.ctype == 'XTN':
|
|
n += ' (Testnet)'
|
|
if self.chain.ctype == 'XRT':
|
|
n += ' (Regtest)'
|
|
|
|
|
|
self.name = n
|
|
self.addr_fmt = addr_fmt
|
|
|
|
# Figure out the derivation path
|
|
# - we want to store path w/o change and index part
|
|
p = prefix.format(account=account_idx, coin_type=self.chain.b44_cointype,
|
|
change='C', idx='I')
|
|
if p.endswith('/C/I'):
|
|
p = p[:-4]
|
|
if p.endswith('/I'):
|
|
# custom path in addr explorer can get this
|
|
p = p[:-2]
|
|
|
|
self._path = p
|
|
|
|
|
|
def yield_addresses(self, start_idx, count, change_idx=None):
|
|
# Render a range of addresses. Slow to start, since accesses SE in general
|
|
# - if count==1, don't derive any subkey, just do path.
|
|
path = self._path
|
|
if change_idx is not None:
|
|
assert 0 <= change_idx <= 1
|
|
path += '/%d' % change_idx
|
|
|
|
with SensitiveValues() as sv:
|
|
node = sv.derive_path(path)
|
|
|
|
if count is None: # special case - showing single, ignoring start_idx
|
|
address = self.chain.address(node, self.addr_fmt)
|
|
yield 0, address, path
|
|
return
|
|
|
|
path += '/'
|
|
for idx in range(start_idx, start_idx+count):
|
|
if idx > MAX_BIP32_IDX:
|
|
break
|
|
try:
|
|
here = node.copy()
|
|
here.derive(idx, False) # works in-place
|
|
address = self.chain.address(here, self.addr_fmt)
|
|
finally:
|
|
here.blank()
|
|
del here
|
|
|
|
yield idx, address, path+str(idx)
|
|
|
|
def render_address(self, change_idx, idx):
|
|
# Optimized for a single address.
|
|
path = self._path + '/%d/%d' % (change_idx, idx)
|
|
with SensitiveValues() as sv:
|
|
node = sv.derive_path(path)
|
|
return self.chain.address(node, self.addr_fmt)
|
|
|
|
def render_path(self, change_idx, idx):
|
|
# show the derivation path for an address
|
|
return self._path + '/%d/%d' % (change_idx, idx)
|
|
|
|
def to_descriptor(self):
|
|
from glob import settings
|
|
xfp = settings.get('xfp')
|
|
xpub = settings.get('xpub')
|
|
keys = (xfp, self._path, xpub)
|
|
return Descriptor([keys], self.addr_fmt)
|
|
|
|
|
|
# EOF
|