https://github.com/cryptape/ckbguardian
ckb public node health monitoring
https://github.com/cryptape/ckbguardian
Last synced: 11 months ago
JSON representation
ckb public node health monitoring
- Host: GitHub
- URL: https://github.com/cryptape/ckbguardian
- Owner: cryptape
- Created: 2022-12-14T01:19:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T02:19:52.000Z (over 1 year ago)
- Last Synced: 2024-10-24T18:55:49.886Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://cryptape.github.io/CkbGuardian
- Size: 21.5 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CkbGuardian
CkbGuardian is a tool designed to monitor the RPC status of well-known CKB public nodes. Its main function is to check the connectivity of RPC, not the validity of results.
Visit the link: https://cryptape.github.io/CkbGuardian/index.html
# How to Add a New Node
If you want to add a new node, you can edit this file: https://github.com/cryptape/CkbGuardian/blob/main/ckb/resource/ckb.json, and then submit a pull request.
Here's an example: https://github.com/cryptape/CkbGuardian/pull/2/commits/a2dcefed7a61fbfa40d89564a9e8520dd7bc2cd2
The node configuration should follow this format:
```javascript
export class CkbNodeConfig {
name: string. // Server name
url: string. // Server URL
network: string. // Currently support the main and test network
rpc: string. // RPC URL
apiKeyName: string. // If an API key is needed
excludeMethods: string[]. // Methods not supported by the service
}
```
### apiKeyName
If connecting to the CKB service requires an API key, you need to:
1. Add apiKeyName : apiKeyName:SERVICE_API_KEY
2. Add to .env file: SERVICE_API_KEY="xxxxxx", file location: https://github.com/gpBlockchain/CkbGuardian/blob/main/ckb/.env
3. Modify gitflow, see: https://github.com/cryptape/CkbGuardian/blob/main/.github/workflows/check-node.yml#L45-L46
### Limiting Dangerous RPCs
You can use https://github.com/jiangxianliang007/ckb-nginx-proxy to run the CKB proxy to limit dangerous RPCs.