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

write tutorial for taker-cli #283

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KnowWhoami
Copy link
Collaborator

No description provided.

Generate 101 blocks and send the funds to the address generated in Step 1.

```bash
bitcoin-cli generatetoaddress 101 <address>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will only work in regtest. Just mention about running bitcoind in regtest mode.

Copy link

@mojoX911 mojoX911 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good first attempt. But needs more work.

A tutorial is not developer doc. We don't need to show/explain each command. Devs can figure it out from the help texts.

Tutorials are for regular users. And it should have a flow. The user should be able to follow through the text and get a specific task done. It should read like a story. Each such task is one tutorial itself.

The taker-cli story can be broken into following parts:

  • Setting up Bitcoind: Where you go through the step by step process of downloading and installing bitcoind and bitcoin-cli. A sample biitcoin.conf file for regtest nodes. And showing the basic operation of create a wallet -> generate address -> mine some blocks -> display balance.

The bitcoind part can be taken out as a new doc. As it will be needed in maker tutorrial also and can be referenced to that doc.

  • Setting up Taker-Cli for fresh run. Explain how to find the rpc config values. Explaiin the datadiir files after iinit. start a new wallet. get the balance, show its 0. get a new address from the taker. send coiins from bitcoind to taker address. get balance. show updated balance and utxo list.

  • Loading up taker-cli: In this section load up the same wallet as above with taker-cli. explaiin the relation between datadiir wallet fiile and bitcoin core taker wallet file.

  • Execute a swap: Mark this as TODO. we will add this when Maker and DNS tutorials are done.

@KnowWhoami
Copy link
Collaborator Author

Setting up Bitcoind: Where you go through the step by step process of downloading and installing bitcoind and bitcoin-cli. A sample biitcoin.conf file for regtest nodes. And showing the basic operation of create a wallet -> generate address -> mine some blocks -> display balance.

IMO, we don't require this because:

  • If anyone is truly intrested in running these cli-apps -> then they already have bitcoind set up in their local system -> as It's really a basic utility for someone working in Bitcoin space :)
  • There already exists good tutorial outside for setting up the Bitcoind -> thus it would be reductant to create another one.

@mojoX911
Copy link

IMO, we don't require this because:

As discussed, we do need this. This is very helpful reference for devs to start playing with the apps quickly. It doesn't need to be any more elaborate than this https://bitcoindevkit.org/blog/bitcoin-core-rpc-demo/#prerequisite

But we do need to add a doc for running bitcoind.

@mojoX911 mojoX911 linked an issue Nov 12, 2024 that may be closed by this pull request
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.

[DOC] Taker-Cli Demo doc
3 participants