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.

Sign up for GitHub

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

Update README.md #1224

Merged
merged 1 commit into from
Jan 2, 2024
Merged

Update README.md #1224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Tracker server is required by new peers who wish to join the AIN network. Each p

NOTE: Tracker Server must be started first before starting any blockchain node instances.

### Running without Docker
### Running Tracker without Docker

#### Local

Expand Down Expand Up @@ -58,7 +58,7 @@ bash start_tracker_genesis_gcp.sh <GCP Username> [--keep-code|--no-keep-code]
```

<!--
### Running with Docker
### Running Tracker with Docker

- Build Docker image
```
Expand All @@ -75,7 +75,7 @@ docker run --network="host" -d ainblockchain/tracker-server:latest
```
-->

### Client API for development and testing purposes
### Tracker Client API for development and testing purposes

#### Tracker protocol version check & health check

Expand All @@ -85,11 +85,11 @@ GET http://<ip_address>:8080/

GET http://<ip_address>:8080/network_status

## Node
## Blockchain Node

Operates a single peer node instance of the AIN blockchain. A single blockchain node instance processes incoming transaction requests and maintains a local copy of the entire blockchain. The blockchain node first queries the tracker-server for ip addresses of other peers, and then syncs its local blockchain to the network consensus blockchain. If a node is included in the whitelist and has staked appropriate amount of AIN, it will then take part in the consensus protocol.

### Running without Docker
### Running Blockchain Node without Docker

#### Local

Expand Down Expand Up @@ -139,7 +139,7 @@ bash setup_blockchain_ubuntu.sh
bash start_node_genesis_gcp.sh [dev|staging|sandbox|exp|spring|summer|mainnet] <GCP Username> <Shard Index> <Node Index> [--keystore|--mnemonic|--private-key] [--keep-code|--no-keep-code] [--keep-data|--no-keep-data] [--full-sync|--fast-sync] [--chown-data|--no-chown-data] [--json-rpc] [--update-front-db] [--rest-func] [--event-handler]
```

### Running with Docker
### Running Blockchain Node with Docker

- Pull Docker image from [Docker Hub](https://hub.docker.com/repository/docker/ainblockchain/ain-blockchain)
```
Expand Down Expand Up @@ -198,7 +198,7 @@ cat logger/logs/8080/<log_file>
```
-->

### How to run tests
### Testing How-Tos

How to run unit test and integration test all around.
```
Expand Down Expand Up @@ -244,7 +244,7 @@ The load test is also supported.
yarn run loadtest
```

### Client API for development and testing purposes
### Blockchain Node Client API for development and testing purposes

#### Node protocol version check

Expand Down
Loading