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

readme update #371

Merged
merged 5 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<a href="https://crates.io/crates/coinswap"><img alt="Crate Info" src="https://img.shields.io/crates/v/coinswap.svg"/></a>
<a href="https://docs.rs/coinswap"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-coinswap-green"/></a>
-->
<a href="https://github.com/citadel-tech/coinswap/blob/master/LICENSE.md"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
<a href="https://github.com/citadel-tech/coinswap/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
<a href="https://github.com/citadel-tech/coinswap/actions/workflows/build.yaml"><img alt="CI Status" src="https://github.com/citadel-tech/coinswap/actions/workflows/build.yaml/badge.svg"></a>
<a href="https://github.com/citadel-tech/coinswap/actions/workflows/lint.yaml"><img alt="CI Status" src="https://github.com/citadel-tech/coinswap/actions/workflows/lint.yaml/badge.svg"></a>
<a href="https://github.com/citadel-tech/coinswap/actions/workflows/test.yaml"><img alt="CI Status" src="https://github.com/citadel-tech/coinswap/actions/workflows/test.yaml/badge.svg"></a>
Expand Down Expand Up @@ -92,7 +92,7 @@ taker --help

mojoX911 marked this conversation as resolved.
Show resolved Hide resolved
`maker-cli`: The RPC controler of the server deamon. This can be used to manage the server, access internal wallet, see swap statistics, etc. App demo [here](https://github.com/citadel-tech/coinswap/blob/master/docs/app%20demos/maker-cli.md)

`taker`: The swap client app. This acts as a regular bitcoin wallet with swap capability. App demo [here](https://github.com/citadel-tech/coinswap/blob/master/docs/app%20demos/taker-tutorial.md)
`taker`: The swap client app. This acts as a regular bitcoin wallet with swap capability. App demo [here](https://github.com/citadel-tech/coinswap/blob/master/docs/app%20demos/taker.md)

All the apps will require a Bitcoin Core RPC connection running on testnet4. For running bitcoin instrcutions, see [here](https://github.com/citadel-tech/coinswap/blob/master/docs/app%20demos/bitcoind.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/app demos/bitcoind.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ After setting up the configuration file, our node will be ready to run in `regte


> **NOTE**: `Regtest` is a toy network that allows for creating custom blocks and generating coins, making it ideal for easy integration testing of applications.
> For actual swap markets, use `Signet`. Switch to `Signet` by setting `signet=1` in the configuration.
> For actual swap markets, use `testnet4`. Switch to `testnet4` by setting `testnet4=1` in the configuration.
---

### **3. Basic Operations**
Expand Down
8 changes: 2 additions & 6 deletions docs/app demos/maker-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,14 +356,10 @@ $ ./maker-cli get-new-address
### Spending `10,000 sats` from the Maker's Wallet:
Next, let's send `10,000 sats` from the maker's wallet to an external address.

#### **Step 1**: Derive an External Address Using `bitcoin-cli`'s `deriveaddresses` Command
#### **Step 1**: Derive an External Address Using `bitcoin-cli`'s `getnewaddress` Command

```bash
$ bitcoin-cli deriveaddresses <descriptor in signet> "[0,0]"

[
<derived address>
]
$ bitcoin-cli getnewaddress
```

#### **Step 2**: Use `maker-cli`'s `send-to-address` Command to Send the Amount to the Derived Address
Expand Down
8 changes: 4 additions & 4 deletions docs/app demos/makerd.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ This section focuses on `Makerd`, walking you through the process of starting an

### 1. Start Bitcoin Core (Pre-requisite)

`Makerd` requires a **Bitcoin Core** RPC connection running on **Signet** for its operation. To get started, you need to start `bitcoind`:
`Makerd` requires a **Bitcoin Core** RPC connection running on **testnet4** for its operation. To get started, you need to start `bitcoind`:

> **Important:**
> All apps are designed to run on **Signet** for testing purposes. The DNS server that Maker connects to will also be on Signet. While you can run these apps on other networks, there won't be any DNS available, so Maker won’t be able to connect to the DNS server or other Coinswap networks.
> All apps are designed to run on **testnet4** for testing purposes. The DNS server that Maker connects to will also be on testnet4. While you can run these apps on other networks, there won't be any DNS available, so Maker won’t be able to connect to the DNS server or other Coinswap networks.

To start `bitcoind`:

Expand All @@ -101,7 +101,7 @@ coinswap 0.1.0
Developers at Citadel-Tech
Coinswap Maker Server

The server requires a Bitcoin Core RPC connection running in Signet. It requires some starting balance (0.05 BTC Fidelity + Swap Liquidity). After the successful creation of a Fidelity Bond, the server will start listening for incoming swap requests and earn swap fees.
The server requires a Bitcoin Core RPC connection running in testnet4. It requires some starting balance (0.05 BTC Fidelity + Swap Liquidity). After the successful creation of a Fidelity Bond, the server will start listening for incoming swap requests and earn swap fees.

The server is operated with the maker-cli app, for all basic wallet-related operations.

Expand Down Expand Up @@ -191,7 +191,7 @@ This will launch `makerd` and connect it to the Bitcoin RPC core running on it's

> **Note**: Currently The transaction fee for the fidelity bond is hardcoded at `1000 sats`. This approach of directly considering `fee` not `fee rate` will be improved in v0.1.1 milestones.

- Since the maker wallet is empty, we'll need to fund it with at least `0.00051000 BTC` to cover the fidelity amount and transaction fee. To fund the wallet, we can use a Signet faucet from [Signet Faucets](https://signetfaucet.com/).
- Since the maker wallet is empty, we'll need to fund it with at least `0.00051000 BTC` to cover the fidelity amount and transaction fee. To fund the wallet, we can use a testnet4 faucet from [testnet4 Faucets](https://mempool.space/testnet4/faucet).
Let's just take `0.01 BTC`testcoins as extra amount will be used in doing wallet related operations in [maker-cli demo](./maker-cli.md)

- The server will regularly sync the wallet every 10 seconds, increasing the interval in the pattern 10,20,30,40..., to detect any incoming funds.
Expand Down
6 changes: 3 additions & 3 deletions docs/app demos/taker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The taker CLI is an application that allows you to perform coinswaps as a taker.

### Start Bitcoin Core (Pre-requisite)

`Taker` requires a **Bitcoin Core** RPC connection running on **Signet** for its operation. To get started, you need to start `bitcoind`:
`Taker` requires a **Bitcoin Core** RPC connection running on **testnet4** for its operation. To get started, you need to start `bitcoind`:

> **Important:**
> All apps are designed to run on **Signet** for testing purposes. The DNS server that Taker connects to will also be on Signet. While you can run these apps on other networks, there won't be any DNS available, so Taker won’t be able to connect to the DNS server fir getting maker's offers and can't do coinswap with makers.
> All apps are designed to run on **testnet4** for testing purposes. The DNS server that Taker connects to will also be on testnet4. While you can run these apps on other networks, there won't be any DNS available, so Taker won’t be able to connect to the DNS server fir getting maker's offers and can't do coinswap with makers.

To start `bitcoind`:

Expand Down Expand Up @@ -87,7 +87,7 @@ $ taker -r 127.0.0.1:38332 -a user:pass get-new-address
bcrt1qyywgd4we5y7u05lnrgs8runc3j7sspwqhekrdd
```

Now we can use a Signet faucet to send some coins to this address. You can find a Signet faucet [here](https://signetfaucet.com/).
Now we can use a testnet4 faucet to send some coins to this address. You can find a testnet4 faucet [here](https://mempool.space/testnet4/faucet).

Once you have some coins in your wallet, you can check your balance by running the following command:

Expand Down
Loading
Loading