Skip to content

Commit

Permalink
Use sBTC terms, improve sBTC get started on devnet page (#92)
Browse files Browse the repository at this point in the history
* chore: use sBTC names

* chore: update diagram

* chore: remove simple flow of sbtc-mini

* chore: update bitocin node url, add Alice's addresses

* chore: add FAQ page for sbtc-dev

* chore: add more faqs
  • Loading branch information
friedger authored Oct 5, 2023
1 parent 2ec206d commit aef1fa5
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 22 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
- [Reference implementation plan](./sbtc-releases/sbtc-dev/sbtc-dev-reference.md)
- [Get Started](./sbtc-releases/sbtc-dev/get-started.md)
- [Get Started On Devnet](./sbtc-releases/sbtc-dev/get-started-on-devnet.md)
- [FAQ](./sbtc-releases/sbtc-dev/faq.md)
- [sBTC 0.2](./sbtc-releases/sbtc-dev-v2.md)
- [sBTC 1.0](./sbtc-releases/sbtc-nakamoto.md)
- [sBTC 1.1](./sbtc-releases/sbtc-nakamoto-v2.md)
Expand Down
11 changes: 11 additions & 0 deletions src/sbtc-releases/sbtc-dev/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# FAQ for sBTC DR 0.1

## Devenv

* What is the meaning of the warning in stacks logs `Relayer: Failed to submit Bitcoin transaction`?
It is a warning related to stacks mining and not relevant to sBTC transactions.

* When I run utils/deploy_contracts.sh, I seen an error `x Error publishing transactions: RecvError
`. What does it mean?
The stacks node is not yet started. Wait for a while and try again.

9 changes: 6 additions & 3 deletions src/sbtc-releases/sbtc-dev/get-started-on-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ The default values are set as follows using the same seed phase defined in `rome

|field|value|explanation|
|----|----|---|
| seed phrase | twice kind fence tip hidden tilt action fragile skin nothing glory cousin green tomorrow spring wrist shed math olympic multiply hip blue scout claw | main/deployer wallet |
| seed phrase | twice kind fence tip hidden tilt action fragile skin nothing glory cousin green tomorrow spring wrist shed math olympic multiply hip blue scout claw | main/deployer wallet, same as in get_credentials script |
| peg wallet | bcrt1pte5zmd7qzj4hdu45lh9mmdm0nwq3z35pwnxmzkwld6y0a8g83nnqhj6vc0| taproot address from seed phrase |
| stx deployer | ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM | |
| stx deployer | ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM | aka wallet.deployer, uses account index 0 |
| btc deployer | tb1q3tj2fr9scwmcw3rq5m6jslva65f2rqjxt2t0zh | p2wpkh using account index 0 |
| stx Alice | ST2ST2H80NP5C9SPR4ENJ1Z9CDM9PKAJVPYWPQZ50 | uses account index 1 |
| btc Alice | tb1q3zl64vadtuh3vnsuhdgv6pm93n82ye8qc36c07 | p2wkh address using account index 1|

Create configuration file `config.json` in a new folder `romeo/testing` with the following content:

Expand All @@ -33,8 +36,8 @@ Create configuration file `config.json` in a new folder `romeo/testing` with the
"bitcoin_network": "regtest",
"state_directory": "./state",
"mnemonic": "twice kind fence tip hidden tilt action fragile skin nothing glory cousin green tomorrow spring wrist shed math olympic multiply hip blue scout claw",
"bitcoin_node_url": "http://devnet:devnet@localhost:8001/api",
"stacks_node_url": "http://localhost:3999",
"bitcoin_node_url": "http://devnet:devnet@localhost:18443",
"electrum_node_url": "tcp://localhost:60401",
"contract_name": "asset"
}
Expand Down
11 changes: 6 additions & 5 deletions src/sbtc-releases/sbtc-dev/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,29 @@ sequenceDiagram
CS ->> AS: mints sBTC
end
loop
AB ->> CB: sends dust (withdrawal)
AB ->> CB: sends dust (withdrawal request)
CB ->> CS: processes BTC tx
CS ->> AS: burns sBTC
CB ->> AB: sends BTC (fullfilment)
CB ->> CB: wait for confirmation of Stacks tx
CB ->> AB: sends BTC (withdrawal fullfilment)
end
```


## Web app
A web interface for the sBTC contract is available at https://bridge.stx.eco/?net=testnet
A web interface for the sBTC contract is available at [https://bridge.stx.eco/?net=testnet](https://bridge.stx.eco/?net=testnet)

The web app allows to deposit and withdraw btc from the peg wallet. It also provides a list of recent deposit and withdrawal transactions.

## sBTC cli

See (README of the sbtc repo)[https://github.com/stacks-network/sbtc/blob/main/sbtc-cli/README.md] for commands to create and broadcast deposit and withdrawal bitcoin transactions.
See [README of the sbtc repo](https://github.com/stacks-network/sbtc/blob/main/sbtc-cli/README.md) for commands to create and broadcast deposit and withdrawal bitcoin transactions.

## sBTC API

There is a public API server for the most common tasks in the context of sBTC. Developers can use this API create deposit and withdrawal request, get information about btc transactions, etc.

Documention is available at (bridge.sbtc.tech)[https://bridge.sbtc.tech/bridge-api/docs/].
Documention is available at [bridge.sbtc.tech](https://bridge.sbtc.tech/bridge-api/docs/).

## sBTC SDK

Expand Down
6 changes: 3 additions & 3 deletions src/sbtc-releases/sbtc-dev/sbtc-dev-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Every piece of functionality that is being worked on is formulated as [issues](h

For anyone interested in tracking the high-level progress of the Alpha Romeo work, these key issues should provide a good view in how things are progressing.

1. Implement the deposit flow [#67](https://github.com/stacks-network/sbtc/issues/67)
2. Implement the withdrawal flow [#68](https://github.com/stacks-network/sbtc/issues/68)
3. Containerize and deploy the release [#85](https://github.com/stacks-network/sbtc/issues/85)
1. Implement the deposit flow [#67](https://github.com/stacks-network/sbtc/issues/67) (completed)
2. Implement the withdrawal flow [#68](https://github.com/stacks-network/sbtc/issues/68) (completed)
3. Containerize and deploy the release [#85](https://github.com/stacks-network/sbtc/issues/85) (completed)
4. Ensure the bridge is compatible with the latest release [#86](https://github.com/stacks-network/sbtc/issues/86)
5. Write developer docs for the release [#77](https://github.com/stacks-network/sbtc-docs/issues/77)
11 changes: 0 additions & 11 deletions src/sbtc-releases/sbtc-dev/simple-flow.md

This file was deleted.

0 comments on commit aef1fa5

Please sign in to comment.