bob icon indicating copy to clipboard operation
bob copied to clipboard

SDK: Documentation and Extensions

Open nud3l opened this issue 9 months ago • 0 comments

Is your feature request related to a problem? Please describe. The SDK has little documentation and we hadn't had time yet to bring it to a state where others can easily use it or contribute to it.

ToDos

For Bitcoin Asia

  • https://github.com/bob-collective/bob/issues/178
  • Extend the Hello Bitcoin example (https://docs.gobob.xyz/docs/build/getting-started/helloworld) to show how to use the BOB SDK from a node.js script to (1) submit Bitcoin block headers to the deployed relay, (2) fetch the transaction inclusion proofs from electrs, and (3) submit the transaction inclusion proof to the BTC Relay.

Others

  • Add an overview to the docs of the SDK what the different components do, e.g., electrs, ordinals, helpers
  • Replace bitcoinjs-lib dependency with https://github.com/paulmillr/scure-btc-signer everywhere

nud3l avatar May 06 '24 00:05 nud3l