shrub/sur/btc-wallet-hook.hoon

/-  *btc, bws=btc-wallet-store, bp=btc-provider
|%
::  btc-state: state from the provider; t is last update time
::  req-id: hash of [xpub chyg idx]
::  reqs: lookup of req-id -> requests from wallet-store+blockcount
::    blockcount included so that we only request address info when
::    there's a newer block, in the case of addresses we are cooking
::
::  payment: a payment expected from another ship
::    - address: address generated for this payment
::  piym: incoming payments. Stores all ship moons under their planet.
::    - num-fam: total payments (addresses) outstanding for ship and its moons
::  pend-piym: incoming payment txs that peer says they have broadcast
::  poym: outgoing payments. One at a time: new replaces old
::
+$  btc-state  [block=@ud fee=sats t=@da]
+$  reqs  (map req-id:bp req=request:bws)
::
+$  payment  [pend=(unit txid) =xpub =address payer=ship value=sats]
+$  piym  [ps=(map ship payment) num-fam=(map ship @ud)]
+$  pend-piym  (map txid payment)
+$  poym  (unit txbu:bws)
::  req-pay-address: request a payment address from another ship
::   - target of action is local ship
::  gen-pay-address: generate a payment address from our ship to another
::  ret-pay-address: give an address to a payer who requested it
::  broadcast-tx: broadcast a signed-psbt, must be current poym
::  expect-payment: tell another ship that we're paying a previously requested address
::    - vout-n is the index of the output that has value
::
+$  action
  $%  settings
      local
      peer
  ==
+$  settings
  $%  [%set-provider provider=ship]
      [%set-default-wallet ~]
      [%clear-poym ~]
      [%force-retry ~]
  ==
+$  local
  $%  [%req-pay-address payee=ship value=sats feyb=(unit sats)]
      [%broadcast-tx signed=rawtx]
      :: from wallet-store %generate-address
      [%add-piym =xpub =address payer=ship value=sats]
      :: wallet-store %generate-txbu
      [%add-poym =txbu:bws]
      ::  from %raw-tx
      [%add-poym-txi =rawtx]
      :: from %tx-info
      [%finish-piym =info:tx]
      [%finish-poym =info:tx]
      :: from %broadcast-tx
      [%fail-broadcast-tx =txid]  ::  clear poym; remove from wallet-history?
      [%succeed-broadcast-tx =txid]  :: p
  ==
+$  peer
  $%  [%gen-pay-address value=sats]
      [%ret-pay-address =address payer=ship value=sats]
      [%expect-payment =txid value=sats]
  ==
::
::
+$  update
  $%  request
      error
  ==
::
+$  request
  $%  [%sign-tx txbu:bws]
  ==
::
+$  error
  $%  [%broadcast-tx-mismatch-poym signed=rawtx]
      [%broadcast-tx-spent-utxos =txid]
  ==
--