https://github.com/krystianity/blockchain
:muscle::link: PoW Blockchain implementation in Typescript :currency_exchange:
https://github.com/krystianity/blockchain
block blockchain nodejs proof proof-of-work scale transaction typescript
Last synced: about 1 month ago
JSON representation
:muscle::link: PoW Blockchain implementation in Typescript :currency_exchange:
- Host: GitHub
- URL: https://github.com/krystianity/blockchain
- Owner: krystianity
- License: apache-2.0
- Created: 2018-04-25T12:38:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:46:29.000Z (almost 3 years ago)
- Last Synced: 2025-08-02T20:06:18.513Z (2 months ago)
- Topics: block, blockchain, nodejs, proof, proof-of-work, scale, transaction, typescript
- Language: TypeScript
- Homepage:
- Size: 316 KB
- Stars: 32
- Watchers: 4
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# blockchain
Fully fledged PoW blockchain implementation in TypeScript.
## Features/Setup
* Proof of Work __(similar to Bitcoin's Hashcash)__
* Consensus __(similar to Bitcoin's longest chain)__
* Implemented Node P2P communication via HTTP/S (register, transaction, blocks)
* Addresses in RSA PEM 1024/2048 **easily swapable with e.g. elliptic curves**
* Transaction SHA256 signature validation
* SHA256 Block Hashes
* All node operations are call-able via HTTP API
* Chain backed to disk in nodes via SQLite3 **easily swapable with a different backend**
## Use
### Prepare
Requires [Node.js](https://nodejs.org/en/) > 8.x.x
and yarn (`npm i -g yarn`).
`yarn`
### Start
`yarn start`
### Test
3 Node Network E2E Tests
### P2P Protocol
`yarn test:p2p`
### Consensus Algorithm
`yarn test:consensus`
## HTTP Node API
### Client Facing
* `GET /api/address/new` **blocking operation**
* `POST /api/address/transactions/:address - {address}`
* `POST /api/address/balance/:address - {address}`
* `GET /api/blocks/last`
* `POST /api/transaction/sign - {transaction, address, privateKey}` **test endpoint**
* `POST /api/transactions/new - {sender, recipient, amount, payload, timestamp, signature}`
### Operations (trigger)
* `GET /api/mine` **blocking operation**
* `GET /api/nodes/resolve`
### P2P Node Protocol
* `POST /api/nodes/register - {nodes}`
* `GET /api/peer/chain` **p2p node endpoint**
* `POST /api/peer/transaction - {transaction}` **p2p node endpoint**
* `POST /api/peer/block - {block}` **p2p node endpoint**
## License
Apache License 2.0
## Further Scaling Oppertunities
* During conflict resolvation the servering node streams TransferInterface to the
fetching client node, but currently the client node does not stream insert the
blockchain.
* Currently the blockchain validation function is based on a full in memory process,
to scale further this needs to either be chunked/streamed or based on a db process.
* The balance of a sender should be checked when a transaction is made and when
such a transaction is received by another node via peer communcation (requires a single function call)
* Additional hardening might be needed in case of blocks that are mined at the exact same time
* Addresses should be switched to elliptic curves to generate and sign faster
* SQLite3 should be switched with a more scaleable database
* Nodes should constantly extend their known nodes, by asking for other registered nodes (easily implemented)