Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.96 KB

README.md

File metadata and controls

50 lines (40 loc) · 1.96 KB

ipfs-ark-stamp

📝 Add files to IPFS and stamp its IPFS CID hash permanently on the ARK Blockchain

Uses an OrbitDB log instance on the IPFS node to store the ARK Blockchain IPFS stamps transaction IDs associated with the IPFS files CIDs.

Features

  • List/Add/Delete and Pin/Unpin files on the IPFS node
  • Stamp the IPFS file CID hash on the ARK Blockchain
  • Open the IPFS stamp transaction on the ARK Blockchain Explorer
  • Store the ARK Blockchain IPFS stamp transaction ID on the IPFS node using OrbitDB
  • Synchronize the local OrbitDB store with the already-broadcasted ARK Blockchain IPFS CIDs

Install

yarn

Build

yarn build

Configure

You need to set environment variables to configure the project. Copy .env.example to .env and edit this file.

This is required.

Configuration option Description Default value
SERVER_PORT Server port 5000
FILE_UPLOAD_MAX_SIZE Max accepted file size when uploading a file to the IPFS node 20971520 (i.e. 20 MB)
IPFS_NODE_MULTIADDR IPFS node multiaddr '/ip4/127.0.0.1/tcp/5001'
IPFS_NODE_STAMPED_DIR Directory to target on the IPFS node '/stamped'
ORBIT_DB_STORE OrbitDB log store 'stamped_db'
ARK_API_URI ARK node API URI 'https://dexplorer.ark.io/api/v2'
ARK_EXPLORER_URI ARK explorer URI 'https://dexplorer.ark.io'
ARK_NETWORK ARK Blockchain network 'devnet'
ARK_TRANSACTION_FEE ARK IPFS transaction stamp fees '10000000' (i.e. 0.1 ARK)
ARK_WALLET_PASSPHRASE ARK wallet passphrase 'wallet ark blockchain passphrase'

Run

yarn start

Screenshot

Screenshot

License

The MIT license