https://github.com/zachalam/bitfact
π‘οΈ Robust data integrity tool. Prove data, text, & files using the Ethereum blockchain.
https://github.com/zachalam/bitfact
blockchain crypto data-integrity ethereum ethereum-blockchain fingerprint fingerprint-data hashing javascript-library
Last synced: 6 months ago
JSON representation
π‘οΈ Robust data integrity tool. Prove data, text, & files using the Ethereum blockchain.
- Host: GitHub
- URL: https://github.com/zachalam/bitfact
- Owner: zachalam
- License: apache-2.0
- Created: 2020-11-22T06:35:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T16:26:12.000Z (almost 3 years ago)
- Last Synced: 2025-07-01T00:07:11.570Z (6 months ago)
- Topics: blockchain, crypto, data-integrity, ethereum, ethereum-blockchain, fingerprint, fingerprint-data, hashing, javascript-library
- Language: JavaScript
- Homepage: https://docs.bitfact.io
- Size: 2 MB
- Stars: 51
- Watchers: 3
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Prove data with this complete toolkit.
BitFact fingerprints information and then etches it on the Ethereum Blockchain.
___
---
## Install
Available in **[ποΈ npm](https://www.npmjs.com/package/bitfact)** and **[π§Ά yarn](https://yarnpkg.com/package/bitfact)** flavours.
```java
npm install -g bitfact
```
```java
yarn global add bitfact
```
## Features
- ποΈ Fingerprint data with one easy command. [What's a fingerprint?](https://en.wikipedia.org/wiki/Fingerprint_(computing))
- βΎοΈ Permanent hash etched on the Ethereum blockchain.
- β½ Tiny gas fees (~21,000) - the same as sending ether.
- π Use with: mainnet (live), ropsten (testnet), & beaconchain (eth2).
## Quickstart
π The only thing you need to drive is an Ethereum `provider` and `privateKey`.
```java
$ bitfact setup
```
### Stamp
πͺ§ After setup, use `bitfact stamp` with `-f` to stamp a file or `-t` to stamp text.
```java
$ bitfact stamp -f hello_world.txt
```
```
β Confirming..
π‘οΈ Success! Stamped on Blockchain:
Txid: 0xbae00000000000000005
```
### Verify
```java
$ bitfact verify -f hello_world.txt -tx 0xbae00000000000000005
```
```
β Confirming..
π‘οΈ Response received from Blockchain.
Stamped: YES
```
## Documentation
The code is well tested and fully documented. Pull requests to docs are welcome.
- π **Documentation Site: https://docs.bitfact.io/**
- Project Repo: The documentation can also be viewed in the `docs/guides` folder on the repository.
## Use Programatically
π You can also import `bitfact` as a module in your own project.
```javascript
const BitFact = require("bitfact"); // load from npm or yarn
const bitfact = new BitFact({
provider: "https://mainnet.infura.io/v3/37a0db22401bbe211112",
privateKey: "321d3fa232e55dedee2bd914273f78897f69053b61437c5",
options: {chain: 'mainnet'}
});
const receipt = await bitfact.stampText("Hello World!", "this is my memo");
console.log(receipt);
```
BitFact | Crafted in Las Vegas (don't gamble with your data) π°