Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example and remove old docs #156

Closed
wants to merge 2 commits into from
Closed

Conversation

jbesraa
Copy link
Contributor

@jbesraa jbesraa commented Dec 29, 2023

#137

  • remove logs from receive module
  • remove logs from send module
  • add full example to examples folder

example is implemented with axum and bitcoincore_rpc

@jbesraa jbesraa force-pushed the cleanup/docs branch 2 times, most recently from f492bbc to e3e3df3 Compare December 29, 2023 13:36
@jbesraa jbesraa changed the title Cleanup/docs Add example and remove old docs Dec 29, 2023
@jbesraa jbesraa force-pushed the cleanup/docs branch 2 times, most recently from 7ebcad5 to 11ea8e9 Compare January 2, 2024 16:56
@jbesraa
Copy link
Contributor Author

jbesraa commented Jan 12, 2024

Hello @DanGould

In the tutorial, we have several options the user can setup the wallet and I think it will be a challenge for new comers. maybe we can make it somehow easier so we can demonstrate mainly payjoin functionality and not let the user get distracted setting up wallets.

best options I though about:

  1. use regtest in the test and link to regtest setup in bitcoin-core. choosing regtest over testnet here because it would take time for blockchain to download..
  2. use testnet and setup the wallet in the tutorial(ie share xpriv or mnemonic) then the user basically doesnt need to create any wallet.(this is the easiest from user perspective)

one argument for using testnet over regtest is that we could point the user to see the tx in mempool.space

very initial document is here ed2c2f0

@DanGould
Copy link
Contributor

we could also take the mutiny route where we load a bdk wallet with in-memory database and point them to a faucet

@jbesraa
Copy link
Contributor Author

jbesraa commented Jan 12, 2024

we could also take the mutiny route where we load a bdk wallet with in-memory database and point them to a faucet

Do you have a link please?

@DanGould
Copy link
Contributor

if you run this it'll connect to their signet electrum server https://github.com/mutinywallet/mutiny-node and anyone can use their faucet https://faucet.mutinynet.com/

@DanGould
Copy link
Contributor

This pr should not depend on PjUriBuilder. That should keep us from being blocked on that issue and allow us to triage this independently

@jbesraa jbesraa force-pushed the cleanup/docs branch 3 times, most recently from a2e3d0d to bd7433c Compare January 25, 2024 16:46
@DanGould
Copy link
Contributor

DanGould commented Jan 25, 2024

Is it possible to split the docs removal? It's easier to review PRs in isolation, and I'm not sure if this is doing two things (as the title implies) or many, as the commit log seems to imply. Ideally it's doing one main thing

@jbesraa
Copy link
Contributor Author

jbesraa commented Jan 26, 2024

closing in favor of #179 and #180

@jbesraa jbesraa closed this Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants