urbit/app/btc-wallet-hook.hoon
2021-05-26 18:30:15 -07:00

641 lines
17 KiB
Plaintext

:: btc-wallet-hook.hoon
::
:: Subscribes to:
:: btc-provider:
:: - connection status
:: - RPC call results/errors
::
:: btc-wallet-store
:: - requests for address info
:: - updates to existing address info
::
:: Sends updates to:
:: /updates
::
/- *btc-wallet-hook, bws=btc-wallet-store
/+ dbug, default-agent, bp=btc-provider, bwsl=btc-wallet-store, *btc
|%
++ defaults
|%
++ fam-limit 10
++ piym-limit 3
--
+$ versioned-state
$% state-0
==
:: prov: maybe ship if provider is set
:: fam-limit: how many addresses a ship and its moons can request in piym
:: piym-limit: how many entries a given ship can have in pend-piym
:: A ship can only broadcast X payments to us until we see one of them in the mempool
:: feybs: fee/byte in sats used for a given ship payee
::
+$ state-0
$: %0
prov=(unit [host=ship connected=?])
=reqs
=btc-state
def-wallet=(unit xpub)
fam-limit=@ud
piym-limit=@ud
feybs=(map ship sats)
=piym
=poym
=pend-piym
==
::
+$ card card:agent:gall
--
=| state-0
=* state -
%- agent:dbug
^- agent:gall
=<
|_ =bowl:gall
+* this .
def ~(. (default-agent this %|) bowl)
hc ~(. +> bowl)
::
++ on-init
^- (quip card _this)
~& > '%btc-wallet-hook initialized'
:_ this(fam-limit.state fam-limit:defaults)
:~ [%pass /r/[(scot %da now.bowl)] %agent [our.bowl %btc-wallet-store] %watch /requests]
[%pass /u/[(scot %da now.bowl)] %agent [our.bowl %btc-wallet-store] %watch /updates]
==
++ on-save
^- vase
!>(state)
++ on-load
|= old-state=vase
^- (quip card _this)
~& > '%btc-wallet-hook recompiled'
`this(state !<(versioned-state old-state))
++ on-poke
|= [=mark =vase]
^- (quip card _this)
=^ cards state
?+ mark (on-poke:def mark vase)
%btc-wallet-hook-action
(handle-action:hc !<(action vase))
==
[cards this]
::
++ on-watch
|= pax=path
^- (quip card _this)
?+ pax (on-watch:def pax)
[%sign-me ~]
`this
==
++ on-leave on-leave:def
++ on-peek on-peek:def
++ on-agent
|= [=wire =sign:agent:gall]
^- (quip card _this)
?+ -.sign (on-agent:def wire sign)
%kick
~& >>> "kicked from prov {<src.bowl>}"
?~ prov `this
?: ?& ?=(%set-provider -.wire)
=(host.u.prov src.bowl)
==
`this(prov ~)
`this
::
%fact
=^ cards state
?+ p.cage.sign `state
%btc-provider-status
(handle-provider-status:hc !<(status:bp q.cage.sign))
::
%btc-provider-update
(handle-provider-update:hc !<(update:bp q.cage.sign))
::
%btc-wallet-store-request
(handle-wallet-store-request:hc !<(request:bws q.cage.sign))
::
%btc-wallet-store-update
(handle-wallet-store-update:hc wire !<(update:bws q.cage.sign))
==
[cards this]
==
++ on-arvo on-arvo:def
++ on-fail on-fail:def
--
|_ =bowl:gall
++ handle-action
|= act=action
^- (quip card _state)
?- -.act
%set-provider
=* sub-card
[%pass /set-provider %agent [provider.act %btc-provider] %watch /clients]
:_ state(prov [~ provider.act %.n])
?~ prov ~[sub-card]
:~ [%pass /set-provider %agent [host.u.prov %btc-provider] %leave ~]
sub-card
==
::
%set-default-wallet
=/ xs=(list xpub) scry-scanned
?. (gth (lent xs) 0) `state
`state(def-wallet `(snag 0 xs))
::
:: %req-pay-address
:: overwrites any payment being built currently
:: can't pay if there's an outstanding payment being broadcast
:: can't pay yourself; comets can't pay (could spam requests)
:: forwards poke to payee if payee isn't us
:: deletes poym since we'll be making a new outgoing payment
:: lets us set fee per byte and recall it once we get a payment address back
:: wire is /payer/value/timestamp
::
%req-pay-address
?: broadcasting ~|("Broadcasting a transaction" !!)
~| "Can't pay ourselves; no comets; can't do while tx is being signed"
?< =(src.bowl payee.act)
?< ?=(%pawn (clan:title payee.act))
?< broadcasting
=+ feyb=?~(feyb.act fee.btc-state u.feyb.act)
=> .(poym ~, feybs (~(put by feybs) payee.act feyb))
:_ state
~[(poke-hook payee.act [%gen-pay-address value.act])]
::
:: %broadcast-tx
:: - poym txid must match incoming txid
:: - update sitx in poym
:: - send to provider
::
%broadcast-tx
?> =(src.bowl our.bowl)
?~ prov ~|("Provider not connected" !!)
=+ signed=(to-rawtx:bp txhex.act)
=/ tx-match=?
?~ poym %.n
=((get-id:txu (decode:txu signed)) ~(get-txid txb:bwsl u.poym))
:_ ?. tx-match state
?~ poym state
state(sitx.u.poym `signed)
?. tx-match
~[(send-update [%broadcast-tx-mismatch-poym signed])]
~[(poke-provider host.u.prov [%broadcast-tx signed])]
::
%add-piym
?> =(src.bowl our.bowl)
:_ state(ps.piym (~(put by ps.piym) payer.act [~ +.act]))
~[(poke-hook payer.act [%ret-pay-address +>.act])]
::
%add-poym
?> =(src.bowl our.bowl)
:_ state(poym `txbu.act)
?~ prov ~&(>>> "provider not set" ~)
%+ turn txis.txbu.act
|=(=txi:bws (get-raw-tx host.u.prov txid.utxo.txi))
::
%add-poym-txi
?> =(src.bowl our.bowl)
?~ poym `state
=. txis.u.poym
(update-poym-txis txis.u.poym +.act)
:_ state
=+ pb=~(to-psbt txb:bwsl u.poym)
?~ pb ~
~& >> "PSBT: {<u.pb>}"
~[(send-update [%sign-tx u.poym])]
::
%close-pym
?> =(src.bowl our.bowl)
=^ cards state
?. included.ti.act
`state
?: (~(has by pend-piym) txid.ti.act)
(piym-to-history ti.act)
?: (poym-has-txid txid.ti.act)
(poym-to-history ti.act)
`state
:_ state
[(poke-store [%tx-info ti.act block.btc-state]) cards]
::
%fail-broadcast-tx
?> =(src.bowl our.bowl)
~& > "%fail-broadcast-tx"
:_ state(poym ~)
~[(send-update [%broadcast-tx-spent-utxos txid.act])]
::
%succeed-broadcast-tx
?> =(src.bowl our.bowl)
~& > "%succeed-broadcast-tx"
:_ %_ state
reqs (~(put by reqs) txid.act [%tx-info 0 txid.act])
==
?~ prov ~
:- (poke-provider host.u.prov [%tx-info txid.act])
?~ poym ~
?~ payee.u.poym ~
:_ ~
%- poke-hook
:* u.payee.u.poym
%expect-payment
txid.act
value:(snag 0 txos.u.poym)
==
:: can't pay yourself; comets can't pay (could spam requests)
:: must have default wallet set
:: reuses payment address for ship if exists in piym
::
%gen-pay-address
~| "Can't pay ourselves; no comets"
?< =(src.bowl our.bowl)
?< ?=(%pawn (clan:title src.bowl))
=^ cards state
(reuse-address src.bowl value.act)
?^ cards [cards state]
:: if no reuseable address, call store to generate
::
=+ f=(fam src.bowl)
=+ n=(~(gut by num-fam.piym) f 0)
?~ def-wallet ~|("btc-wallet-hook: no def-wallet set" !!)
?: (gte n fam-limit)
~|("More than {<fam-limit>} addresses for moons + planet" !!)
:_ state(num-fam.piym (~(put by num-fam.piym) f +(n)))
:~ %- poke-store
[%generate-address u.def-wallet %0 `[src.bowl value.act]]
==
::
%ret-pay-address
?: =(src.bowl our.bowl) ~|("Can't pay ourselves" !!)
?: broadcasting ~|("Broadcasting a transaction" !!)
?~ def-wallet ~|("btc-wallet-hook: no def(ault)-wallet set" !!)
=+ feyb=(~(gut by feybs) src.bowl fee.btc-state)
?> =(payer.act our.bowl)
:_ state
:~ %- poke-store
[%generate-txbu u.def-wallet `src.bowl feyb ~[[address.act value.act ~]]]
==
:: %expect-payment
:: - check that payment is in piym
:: - replace pend.payment with incoming txid (lock)
:: - add txid to pend-piym
:: - request tx-info from provider
::
%expect-payment
|^
=+ pay=(~(get by ps.piym) src.bowl)
~| "%expect-payment: matching payment not in piym"
?~ pay !!
?> (piym-matches u.pay)
:_ (update-pend-piym txid.act u.pay(pend `txid.act))
?~ prov ~
~[(poke-provider host.u.prov [%tx-info txid.act])]
::
++ piym-matches
|= p=payment
?& =(payer.p src.bowl)
=(value.p value.act)
==
--
::
%clear-poym
`state(poym ~)
::
%force-retry
[(retry-reqs block.btc-state) state]
==
:: +handle-provider-status: handle connectivity updates from provider
:: - retry pend-piym on any %connected event, since we're checking mempool
:: - if status is %connected, retry all pending address lookups
:: - only retry all if previously disconnected
:: - if block is updated, retry all address reqs
::
++ handle-provider-status
|= s=status:bp
^- (quip card _state)
?~ prov `state
?. =(host.u.prov src.bowl) `state
?- -.s
%connected
:_ %= state
prov `[host.u.prov %.y]
btc-state [block.s fee.s now.bowl]
==
?: ?!(connected.u.prov)
%- zing
:~ (retry-reqs block.s)
retry-poym
retry-pend-piym
==
?. (lth block.btc-state block.s)
retry-pend-piym
(weld retry-pend-piym (retry-reqs block.s))
::
%disconnected
`state(prov `[host.u.prov %.n])
==
::
++ handle-provider-update
|= upd=update:bp
^- (quip card _state)
?. ?=(%.y -.upd) `state
?- -.p.upd
%address-info
=+ r=(~(get by reqs) address.p.upd)
:_ state(reqs (~(del by reqs) address.p.upd))
?~ r ~
?> ?=(%address-info -.u.r)
~[(poke-store [%address-info xpub.u.r chyg.u.r idx.u.r +>.p.upd])]
::
%tx-info
:_ state(reqs (~(del by reqs) txid.info.p.upd))
~[(poke-hook our.bowl [%close-pym info.p.upd])]
::
%raw-tx
:_ state
~[(poke-hook our.bowl [%add-poym-txi +.p.upd])]
::
%broadcast-tx
?~ poym `state
?. =(~(get-txid txb:bwsl u.poym) txid.p.upd)
`state
:_ state
?: ?|(broadcast.p.upd included.p.upd)
~[(poke-hook our.bowl [%succeed-broadcast-tx txid.p.upd])]
~[(poke-hook our.bowl [%fail-broadcast-tx txid.p.upd])]
==
::
++ handle-wallet-store-request
|= req=request:bws
^- (quip card _state)
?~ prov `state
=/ should-send=?
?& provider-connected
(lth last-block.req block.btc-state)
==
?- -.req
%address-info
:_ state(reqs (~(put by reqs) a.req req))
?. should-send ~
~[(poke-provider host.u.prov [%address-info a.req])]
::
%tx-info
:_ state(reqs (~(put by reqs) txid.req req))
?. should-send ~
~[(poke-provider host.u.prov [%tx-info txid.req])]
==
::
++ handle-wallet-store-update
|= [=wire upd=update:bws]
^- (quip card _state)
?- -.upd
%generate-address
?~ pmet.upd ~&(> "%generate-address: {<address.upd>}" `state)
:_ state
:~ %+ poke-hook our.bowl
[%add-piym xpub.upd address.upd payer.u.pmet.upd value.u.pmet.upd]
==
::
%generate-txbu
:_ state
~[(poke-hook our.bowl [%add-poym txbu.upd])]
::
%saw-piym
`state
::
%scan-done
~& > "scanned wallet: {<xpub.upd>}"
?~ def-wallet
`state(def-wallet `xpub.upd)
`state
==
:: +reuse-address: if piym already has address for payer,
:: replace address and return to payer
:: - if payment is pending, crash. Shouldn't be getting an address request
::
++ reuse-address
|= [payer=ship value=sats]
^- (quip card _state)
=+ p=(~(get by ps.piym) payer)
?~ p `state
?^ pend.u.p ~|("%gen-address: {<payer>} already has pending payment to us" !!)
=+ newp=u.p(value value)
:_ state(ps.piym (~(put by ps.piym) payer newp))
:~ %+ poke-hook payer
[%ret-pay-address address.newp payer value]
==
::
++ poym-has-txid
|= =txid ^- ?
?~ poym %.n
?~ sitx.u.poym %.n
=(txid (get-id:txu (decode:txu u.sitx.u.poym)))
:: +poym-to-history:
:: - checks whether poym has a signed tx
:: - checks whether the txid matches that signed tx
:: - if not, skip
:: - clears poym
:: - returns card that adds hest to wallet-store history
::
++ poym-to-history
|= ti=info:tx
|^ ^- (quip card _state)
?~ poym `state
?~ sitx.u.poym `state
?. (poym-has-txid txid.ti)
`state
=+ vout=(get-vout txos.u.poym)
?~ vout ~|("poym-to-history: poym should always have an output" !!)
:_ state(poym ~)
~[(add-history-entry ti xpub.u.poym our.bowl payee.u.poym u.vout)]
::
++ get-vout
|= txos=(list txo:bws)
^- (unit @ud)
=| idx=@ud
|- ?~ txos ~
?~ hk.i.txos `idx
$(idx +(idx), txos t.txos)
--
:: +piym-to-history
:: - checks whether txid in pend-piym
:: - checks whether ti has a matching value output to piym
:: - if no match found, just deletes pend-piym with this tx
:: stops peer from spamming txids
:: - returns card that adds hest to wallet-store history
::
++ piym-to-history
:: TODO: delete prints
|= ti=info:tx
|^ ^- (quip card _state)
=+ pay=(~(get by pend-piym) txid.ti)
?~ pay `state
:: if no matching output in piym, delete from pend-piym to stop DDOS of txids
::
=+ vout=(get-vout value.u.pay)
?~ vout
`(del-pend-piym txid.ti)
:_ (del-all-piym txid.ti payer.u.pay)
:~ %- add-history-entry
[ti xpub.u.pay payer.u.pay `our.bowl u.vout]
==
::
++ get-vout
|= value=sats
^- (unit @ud)
=| idx=@ud
=+ os=outputs.ti
|- ?~ os ~
?: =(value.i.os value)
`idx
$(os t.os, idx +(idx))
::
::
++ del-pend-piym
|= =txid
^- _state
state(pend-piym (~(del by pend-piym) txid.ti))
::
++ del-all-piym
|= [=txid payer=ship]
^- _state
=+ nf=(~(gut by num-fam.piym) payer 1)
%= state
pend-piym (~(del by pend-piym) txid)
ps.piym (~(del by ps.piym) payer)
num-fam.piym (~(put by num-fam.piym) payer (dec nf))
==
--
::
++ add-history-entry
|= [ti=info:tx =xpub payer=ship payee=(unit ship) vout=@ud]
^- card
%- poke-store
:* %add-history-entry
xpub txid.ti confs.ti recvd.ti
(turn inputs.ti |=(i=val:tx [i `payer]))
%+ turn outputs.ti
|= o=val:tx
?: =(pos.o vout)
[o payee]
[o `payer]
==
:: +fam: planet parent if s is a moon
::
++ fam
|= s=ship
^- ship
?. =(%earl (clan:title s)) s
(sein:title our.bowl now.bowl s)
:: +update-pend-piym
:: - set pend.payment to txid (lock)
:: - add txid to pend-piym
::
++ update-pend-piym
|= [=txid p=payment]
^- _state
?~ pend.p ~|("update-pend-piym: empty pend.payment" !!)
%= state
ps.piym (~(put by ps.piym) payer.p p)
pend-piym (~(put by pend-piym) txid p)
==
::
:: +update-poym-txis:
:: update outgoing payment with a rawtx, if the txid is in poym's txis
::
++ update-poym-txis
|= [txis=(list txi:bws) =txid rt=rawtx]
^- (list txi:bws)
=| i=@
|- ?: (gte i (lent txis)) txis
=/ ith=txi:bws (snag i txis)
=? txis =(txid txid.utxo.ith)
(snap txis i `txi:bws`ith(ur `rt))
$(i +(i))
:: +retry-reqs: get-address-info for any reqs with old last-block
::
++ retry-reqs
|= [latest-block=@ud]
^- (list card)
?~ prov ~|("provider not set" !!)
%+ murn ~(val by reqs)
|= [req=request:bws]
?: (gte last-block.req latest-block) ~
:- ~
%+ poke-provider host.u.prov
?- -.req
%address-info [%address-info a.req]
%tx-info [%tx-info txid.req]
==
::
++ retry-poym
^- (list card)
?~ poym ~
?~ prov ~|("prov not set" !!)
=* host host.u.prov
%+ weld
?~ sitx.u.poym ~
~[(poke-provider host [%broadcast-tx u.sitx.u.poym])]
%+ turn txis.u.poym
|= =txi:bws
(get-raw-tx host txid.utxo.txi)
:: +retry-pend-piym: check whether txids in pend-piym are in mempool
::
++ retry-pend-piym
^- (list card)
?~ prov ~|("provider not set" !!)
%+ turn ~(tap in ~(key by pend-piym))
|=(=txid (poke-provider host.u.prov [%tx-info txid]))
::
++ get-raw-tx
|= [host=ship =txid]
^- card
(poke-provider host [%raw-tx txid])
::
++ poke-provider
|= [host=ship act=action:bp]
^- card
:* %pass /[(scot %da now.bowl)] %agent [host %btc-provider]
%poke %btc-provider-action !>([act])
==
::
++ broadcasting
^- ?
?~ poym %.n
?~ sitx.u.poym %.n
%.y
::
++ provider-connected
^- ?
?~ prov %.n
connected.u.prov
::
++ poke-hook
|= [target=ship act=action]
^- card
:* %pass /[(scot %da now.bowl)] %agent
[target %btc-wallet-hook] %poke
%btc-wallet-hook-action !>(act)
==
::
++ send-update
|= =update
^- card
[%give %fact ~[/updates] %btc-wallet-hook-update !>(update)]
::
++ poke-store
|= act=action:bws
^- card
:* %pass /[(scot %da now.bowl)]
%agent [our.bowl %btc-wallet-store] %poke
%btc-wallet-store-action !>(act)
==
::
++ scry-scanned
.^ (list xpub)
%gx
(scot %p our.bowl)
%btc-wallet-store
(scot %da now.bowl)
%scanned
%noun
==
--