ipfs-proof-builder
v0.0.9
Published
An IPFS query client for reporting merkle proofs to a verifier
Downloads
4
Readme
This package implements a Merkle Proof Builder over IPFS.
Given a description of a File Stored on IPFS, it:
- Queries for a Challenge Block
- Builds a proof for that block from an
obao
file- Returns the built proof to the caller
obao
files must be provided by the caller, and accessed through a custom callback
Install
npm install
Building
npm run build
Run tests
Populate spec/testCases/testFiles/pinned
with files that you know are pinned or available over IPFS. These can be gathered through an IPFS gateway.
Populate spec/testCases/testFiles/unpinned
with files that you know are not pinned or available over IPFS. Try using personal data you know isn't public, or random generated text files.
Given these files, our test script pre-processes them into obao
files that can be used to test our proof builder.
npm test
Author
👤 Alex Miller and Jonah Kaye
- Github: @amiller68
Show your support
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator