minor change to docs

This commit is contained in:
aaravm
2024-08-25 18:49:59 +05:30
parent f8490a6f2b
commit 860623bf0f

View File

@ -1,19 +1,19 @@
# RPC Node # Regtest Node
This folder contains the documentation for setting up and using the RPC Node in the TapTrade Core repository. This folder contains the documentation for setting up and using the Regtest Node in the TapTrade Core repository.
Any developer can use this to test this repository in an isolated Regtest node. Any developer can use this to test this repository in an isolated Regtest node.
## Prerequisites ## Prerequisites
Before using the RPC Node, make sure you have the following prerequisites installed: Before using the Regtest Node, make sure you have the following prerequisites installed:
- docker - docker
- docker compose - docker compose
## Installation ## Installation
To install the RPC Node, follow these steps: To install the Regtest Node, follow these steps:
1. Clone the TapTrade Core repository to your local machine. 1. Clone the TapTrade Core repository to your local machine.
@ -44,14 +44,6 @@ To install the RPC Node, follow these steps:
docker ps docker ps
``` ```
## Usage
The mine-blocks.sh script is designed to automatically create a wallet, generate initial blocks, and then continue generating blocks at intervals.
```
docker exec -it bitcoin ./mine-blocks.sh bcrt1pcc5nx64a9d6rpk5fkvr6v2lnk06cwxqmgpv3894ehgwkeeal2qusjgjrk3
```
## API Documentation ## API Documentation
For detailed information on the available API endpoints and how to use them, refer to the [API documentation](./api_docs.md) file in this folder. For detailed information on the available API endpoints and how to use them, refer to the [API documentation](./api_docs.md) file in this folder.