mirror of
https://github.com/urbit/shrub.git
synced 2024-12-24 11:24:21 +03:00
555 lines
15 KiB
Plaintext
555 lines
15 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:
|
|
:: /sign-me
|
|
::
|
|
/- *btc, *btc-wallet-hook, bws=btc-wallet-store
|
|
/+ dbug, default-agent, bp=btc-provider
|
|
|%
|
|
++ defaults
|
|
|%
|
|
++ fam-limit 10
|
|
++ piym-limit 3
|
|
--
|
|
+$ versioned-state
|
|
$% state-0
|
|
==
|
|
:: provider: 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
|
|
provider=(unit [host=ship connected=?])
|
|
=btc-state
|
|
def-wallet=(unit xpub)
|
|
fam-limit=@ud
|
|
piym-limit=@ud
|
|
feybs=(map ship sats)
|
|
=reqs
|
|
=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 provider {<src.bowl>}"
|
|
?~ provider `this
|
|
?: ?& ?=(%set-provider -.wire)
|
|
=(host.u.provider src.bowl)
|
|
==
|
|
`this(provider ~)
|
|
`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(provider [~ provider.act %.n])
|
|
?~ provider ~[sub-card]
|
|
:~ [%pass /set-provider %agent [host.u.provider %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 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
|
|
::
|
|
~| "Can't pay ourselves; no comets"
|
|
?< =(src.bowl payee.act)
|
|
?< ?=(%pawn (clan:title payee.act))
|
|
=+ feyb=?~(feyb.act fee.btc-state u.feyb.act)
|
|
=> .(poym ~, feybs (~(put by feybs) payee.act feyb))
|
|
:_ state
|
|
~[(poke-wallet-hook payee.act [%gen-pay-address value.act])]
|
|
:: 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-wallet-store
|
|
[%generate-address u.def-wallet %0 `[src.bowl value.act]]
|
|
==
|
|
::
|
|
%ret-pay-address
|
|
?: =(src.bowl our.bowl) ~|("Can't pay ourselves" !!)
|
|
?~ def-wallet ~|("btc-wallet-hook: no def-wallet set" !!)
|
|
=+ feyb=(~(gut by feybs) src.bowl fee.btc-state)
|
|
?> =(payer.act our.bowl)
|
|
:_ state
|
|
:~ %- poke-wallet-store
|
|
[%generate-txbu u.def-wallet `src.bowl feyb ~[[address.act value.act ~]]]
|
|
==
|
|
::
|
|
%broadcast-tx
|
|
:: TODO:
|
|
:: calc txid from poym's txbu
|
|
:: calc txid
|
|
:: make sure both are the same
|
|
:: remove from poym
|
|
:: broadcast to provider
|
|
:: add to wallet-store history
|
|
:: send message to peer
|
|
`state
|
|
::
|
|
:: - check that src.bowl isn't past piym-limit in pend-piym
|
|
:: - check that payment is in piym
|
|
:: - add payment to pend-piym
|
|
:: - send tx-info to provider (poke)
|
|
::
|
|
%expect-payment
|
|
~| "Too many %expect-payment sent, or payer+value not found in incoming payments"
|
|
=+ num-pend=(~(gut by num.pend-piym) payer.act 0)
|
|
?> (gte piym-limit num-pend)
|
|
=+ pay=(~(get by ps.piym) payer.act)
|
|
?~ pay !!
|
|
?> ?& =(payer.u.pay payer.act)
|
|
=(value.u.pay value.act)
|
|
==
|
|
:- ?~ provider ~
|
|
~[(get-tx-info host.u.provider txid.act)]
|
|
%= state
|
|
ps.pend-piym (~(put by ps.pend-piym) txid.act [u.pay vout-n.act])
|
|
num.pend-piym (~(put by num.pend-piym) payer.act +(num-pend))
|
|
==
|
|
::
|
|
%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)
|
|
?~ provider `state
|
|
?. =(host.u.provider src.bowl) `state
|
|
?- -.s
|
|
%connected
|
|
:_ %= state
|
|
provider `[host.u.provider %.y]
|
|
btc-state [block.s fee.s now.bowl]
|
|
==
|
|
?: ?!(connected.u.provider)
|
|
%- zing
|
|
:~ (retry-reqs block.s)
|
|
retry-txbu
|
|
retry-pend-piym
|
|
==
|
|
?. (lth block.btc-state block.s)
|
|
retry-pend-piym
|
|
~& > "got new block, retrying {<(lent (retry-reqs block.s))>} reqs "
|
|
(weld retry-pend-piym (retry-reqs block.s))
|
|
::
|
|
%disconnected
|
|
`state(provider `[host.u.provider %.n])
|
|
==
|
|
::
|
|
++ handle-provider-update
|
|
|= upd=update:bp
|
|
^- (quip card _state)
|
|
?. ?=(%.y -.upd) `state
|
|
?- -.body.p.upd
|
|
%address-info
|
|
=/ req=(unit request:bws)
|
|
(~(get by reqs) req-id.p.upd)
|
|
?~ req `state
|
|
?> ?=([%address-info *] u.req)
|
|
:_ state(reqs (~(del by reqs) req-id.p.upd))
|
|
:~ %- poke-wallet-store
|
|
:* %address-info xpub.u.req chyg.u.req idx.u.req
|
|
utxos.body.p.upd used.body.p.upd block.body.p.upd
|
|
==
|
|
==
|
|
::
|
|
%tx-info
|
|
:: %txinfo
|
|
:: - forward tx to wallet-store
|
|
:: - delete txid from pend-piym and decrement num.pend-piym
|
|
:: - check whether payment in pend-piym matches this tx's output values
|
|
:: if yes add to wallet-store-history
|
|
::
|
|
=/ ti=info:tx +.body.p.upd
|
|
=/ mh=(unit [=xpub =hest:bws])
|
|
(mk-hest ti (~(get by ps.pend-piym) txid.ti))
|
|
:_ state(pend-piym (del-txid txid.ti))
|
|
%+ weld ~[(poke-wallet-store [%tx-info ti])]
|
|
?~ mh ~
|
|
~[(poke-wallet-store [%add-history-entry xpub.u.mh hest.u.mh])]
|
|
:: %raw-tx
|
|
:: - if the req-id is for current poym, add txid/rawtx to the poym
|
|
:: - if the raw tx matches one of poym's inputs, add it
|
|
::
|
|
%raw-tx
|
|
=* rt body.p.upd
|
|
=. poym (update-poym-tx req-id.p.upd txid.rt rawtx.rt)
|
|
?~ poym `state
|
|
=. txis.u.poym (update-poym-txis txis.u.poym txid.rt rawtx.rt)
|
|
:_ state
|
|
?:(poym-ready ~[(send-sign-tx u.poym)] ~)
|
|
==
|
|
:: get address-info for the request if block in request is old
|
|
::
|
|
++ handle-wallet-store-request
|
|
|= req=request:bws
|
|
^- (quip card _state)
|
|
?~ provider `state
|
|
=/ should-send=?
|
|
?& provider-connected
|
|
(lth last-block.req block.btc-state)
|
|
==
|
|
?- -.req
|
|
%address-info
|
|
=+ ri=(gen-req-id:bp eny.bowl)
|
|
:_ state(reqs (~(put by reqs) ri req))
|
|
?: should-send
|
|
~[(get-address-info ri host.u.provider a.req)]
|
|
~
|
|
::
|
|
%tx-info
|
|
:: TODO: push the request out
|
|
:: put it in reqs
|
|
:: check whether last-block has passed
|
|
`state
|
|
==
|
|
::
|
|
++ handle-wallet-store-update
|
|
|= [=wire upd=update:bws]
|
|
^- (quip card _state)
|
|
?- -.upd
|
|
:: %generate-address
|
|
:: if no peta (payer/value), just prints address
|
|
::
|
|
%generate-address
|
|
?~ peta.upd ~&(> address.upd `state)
|
|
=/ [payer=ship value=sats] u.peta.upd
|
|
:_ state(ps.piym (~(put by ps.piym) payer [xpub.upd address.upd payer value]))
|
|
~[(poke-wallet-hook payer [%ret-pay-address address.upd payer value])]
|
|
:: %generate-txbu
|
|
:: - replace current txbu (otherwise can have UTXO overlap)
|
|
:: - request provider to create-raw-tx from txbu
|
|
::
|
|
%generate-txbu
|
|
:_ state(poym `txbu.upd)
|
|
?~ provider ~&(>>> "provider not set" ~)
|
|
%+ weld ~[(create-raw-tx host.u.provider txbu.upd)]
|
|
%+ turn txis.txbu.upd
|
|
|=(=txi:bws (get-raw-tx host.u.provider txid.utxo.txi))
|
|
::
|
|
%saw-piym
|
|
`state
|
|
::
|
|
%scan-done
|
|
?~ def-wallet
|
|
`state(def-wallet `xpub.upd)
|
|
`state
|
|
==
|
|
:: +reuse-address: if piym already has address for payer,
|
|
:: replace address and return to payer
|
|
::
|
|
++ reuse-address
|
|
|= [payer=ship value=sats]
|
|
^- (quip card _state)
|
|
=+ p=(~(get by ps.piym) payer)
|
|
?~ p `state
|
|
=+ newp=u.p(value value)
|
|
:_ state(ps.piym (~(put by ps.piym) payer newp))
|
|
:~ %+ poke-wallet-hook payer
|
|
[%ret-pay-address address.newp payer value]
|
|
==
|
|
:: +del-txid: delete txid from pend-piym
|
|
::
|
|
++ del-txid
|
|
|= =txid
|
|
^- ^pend-piym
|
|
=+ p=(~(get by ps.pend-piym) txid)
|
|
=. ps.pend-piym (~(del by ps.pend-piym) txid)
|
|
?~ p pend-piym
|
|
=* payer payer.pay.u.p
|
|
=+ n=(~(get by num.pend-piym) payer)
|
|
?~ n pend-piym
|
|
?: =(0 u.n) pend-piym
|
|
pend-piym(num (~(put by num.pend-piym) payer (dec u.n)))
|
|
:: +mk-hest: make a hest to add to wallet-store's history
|
|
:: - one of the outputs' value must match the payment from pend-piym
|
|
::
|
|
++ mk-hest
|
|
|= [=info:tx p=(unit [pay=payment vout-n=@ud])]
|
|
^- (unit [=xpub =hest:bws])
|
|
?~ p ~
|
|
?. ?& (gth (lent outputs.info) vout-n.u.p)
|
|
=(value.pay.u.p value:(snag vout-n.u.p outputs.info))
|
|
==
|
|
~
|
|
:- ~
|
|
:- xpub.pay.u.p
|
|
:* txid.info
|
|
confs.info
|
|
recvd.info
|
|
%+ turn inputs.info
|
|
|=(i=val:tx [i `payer.pay.u.p])
|
|
%+ turn outputs.info
|
|
|= o=val:tx
|
|
?: =(pos.o vout-n.u.p)
|
|
[o `our.bowl]
|
|
[o `payer.pay.u.p]
|
|
==
|
|
:: +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-poym-tx
|
|
:: - check whether poym txbu's req-id matches this one
|
|
:: - if it does, add the txid and rawtx
|
|
::
|
|
++ update-poym-tx
|
|
|= [ri=req-id:bp =txid rt=rawtx]
|
|
^- ^poym
|
|
?~ poym ~
|
|
?~ txinfo.u.poym poym
|
|
?. =(ri req-id.u.poym) poym
|
|
`u.poym(txinfo `[txid rt])
|
|
:: check poym txbu
|
|
:: +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))
|
|
:: +poym-ready: whether poym txbu is ready to sign
|
|
:: - is the txinfo filled in?
|
|
:: - do all txis in poym have rawtxs?
|
|
::
|
|
++ poym-ready
|
|
^- ?
|
|
?~ poym %.n
|
|
?& ?=(^ txinfo.u.poym)
|
|
%+ levy txis.u.poym
|
|
|=(t=txi:bws ?=(^ ur.t))
|
|
==
|
|
:: +retry-reqs: get-address-info for any reqs with old last-block
|
|
::
|
|
++ retry-reqs
|
|
|= [latest-block=@ud]
|
|
^- (list card)
|
|
?~ provider ~|("provider not set" !!)
|
|
%+ murn ~(tap by reqs)
|
|
|= [ri=req-id:bp req=request:bws]
|
|
?: (gte last-block.req latest-block) ~
|
|
?- -.req
|
|
%address-info
|
|
`(get-address-info ri host.u.provider a.req)
|
|
::
|
|
%tx-info
|
|
`(get-tx-info host.u.provider txid.req)
|
|
==
|
|
::
|
|
++ retry-txbu
|
|
^- (list card)
|
|
?~ poym ~
|
|
?~ provider ~|("provider not set" !!)
|
|
%+ turn txis.u.poym
|
|
|= =txi:bws
|
|
(get-raw-tx host.u.provider txid.utxo.txi)
|
|
:: +retry-pend-piym: check whether txids in pend-piym are in mempool
|
|
::
|
|
++ retry-pend-piym
|
|
^- (list card)
|
|
?~ provider ~|("provider not set" !!)
|
|
%+ turn ~(tap in ~(key by ps.pend-piym))
|
|
|=(=txid (get-tx-info host.u.provider txid))
|
|
::
|
|
++ get-address-info
|
|
|= [ri=req-id:bp host=ship a=address]
|
|
^- card
|
|
(poke-provider host `ri [%address-info a])
|
|
::
|
|
++ get-raw-tx
|
|
|= [host=ship =txid]
|
|
^- card
|
|
(poke-provider host ~ [%raw-tx txid])
|
|
::
|
|
++ create-raw-tx
|
|
|= [host=ship t=txbu:bws]
|
|
^- card
|
|
=/ ins=(list [txid @ud])
|
|
%+ turn txis.t
|
|
|=(=txi:bws [txid.utxo.txi pos.utxo.txi])
|
|
=/ outs=(list [address sats])
|
|
%+ turn txos.t
|
|
|=(=txo:bws [address.txo value.txo])
|
|
(poke-provider host `req-id.t [%create-raw-tx ins outs])
|
|
::
|
|
++ get-tx-info
|
|
|= [host=ship =txid]
|
|
^- card
|
|
(poke-provider host ~ [%tx-info txid])
|
|
::
|
|
++ poke-provider
|
|
|= [host=ship uri=(unit req-id:bp) actb=action-body:bp]
|
|
^- card
|
|
=+ ri=?^(uri u.uri (gen-req-id:bp eny.bowl))
|
|
:* %pass /[(scot %da now.bowl)] %agent [host %btc-provider]
|
|
%poke %btc-provider-action !>([ri actb])
|
|
==
|
|
::
|
|
++ provider-connected
|
|
^- ?
|
|
?~ provider %.n
|
|
connected.u.provider
|
|
::
|
|
++ poke-wallet-hook
|
|
|= [target=ship act=action]
|
|
^- card
|
|
:* %pass /[(scot %da now.bowl)] %agent
|
|
[target %btc-wallet-hook] %poke
|
|
%btc-wallet-hook-action !>(act)
|
|
==
|
|
::
|
|
++ send-sign-tx
|
|
|= =txbu:bws
|
|
^- card
|
|
[%give %fact ~[/sign-me] %btc-wallet-hook-request !>([%sign-tx txbu])]
|
|
::
|
|
++ poke-wallet-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
|
|
==
|
|
--
|