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

Change hello world example to be Bitcoin specific #111

Closed
nud3l opened this issue Dec 11, 2023 · 2 comments · Fixed by #142
Closed

Change hello world example to be Bitcoin specific #111

nud3l opened this issue Dec 11, 2023 · 2 comments · Fixed by #142
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers prio:high Important due to deadlines and/or clear customer needs/benefits.

Comments

@nud3l
Copy link
Contributor

nud3l commented Dec 11, 2023

Is your feature request related to a problem? Please describe.
The current hello world example is taken from the Solidity guides. This works but doesn't show the capabilities of BOB.

Describe the solution you'd like
Change the hello world example to showcase the possibilities of BOB:

  • Step 1: Create a smart contract that allows swapping BTC for USDT using the BTC relay
  • Step 2: Add account abstraction to the mix so that a user can pay for the EVM-side fees in tBTC/wBTC
  • Step 3: Extend the smart contract so that a user can buy an ordinal with USDT.

Additional context
See current example: https://docs.gobob.xyz/docs/build/getting-started/helloworld

@nud3l nud3l added the enhancement New feature or request label Dec 11, 2023
@nud3l nud3l added this to Backlog Dec 11, 2023
@github-project-automation github-project-automation bot moved this to New 🆕 in Backlog Dec 11, 2023
@nud3l nud3l added documentation Improvements or additions to documentation prio:high Important due to deadlines and/or clear customer needs/benefits. labels Dec 11, 2023
@nud3l nud3l added the good first issue Good for newcomers label Jan 2, 2024
@nud3l nud3l moved this from New 🆕 to Todo ⏳ in Backlog Jan 2, 2024
@nakul1010
Copy link
Contributor

nakul1010 commented Jan 3, 2024

@nud3l

  • In steps 1 & 3 do u want to use btc_marketplace and ord_marketplace contracts under the hood? So the new HelloBitcoin contract will call the above-mentioned contract with the USDT address as a parameter.
  • But this doesn't expose the BtcRelay functionality in the HelloBitcoin contract directly.

OR

  • A new HelloBitcoin contract can be created which only uses BtcRelay and doesn't have any dependency on the btc_marketplace and ord_marketplace contracts but will be similar to them.

I am also assuming the HelloBitcoin contract to have its repo and not to be in the current repo.

@nud3l
Copy link
Contributor Author

nud3l commented Jan 3, 2024

Create a new HelloBitcoin contract that only has a dependency on the relay (your option 2). The idea is for the code to be as instructive and simple as possible and self-contained.

I think it would be OK to use this repo and put the example in https://github.com/bob-collective/bob/tree/master/src to make sure we keep it up to date with the other code.

@nakul1010 nakul1010 self-assigned this Jan 3, 2024
@github-project-automation github-project-automation bot moved this from Todo ⏳ to Done ✅ in Backlog Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers prio:high Important due to deadlines and/or clear customer needs/benefits.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants