Skip to content
Open Index Protocol Software Development Kit
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
captured value stack.png

Protocol Introduction

Watch protocol explanation video

The Open Index Protocol is a decentralized application (DApp) which unites a peer-to-peer distribution network (IPFS), a micropayments blockchain (Bitcoin), and a blockchain designed specifically to store messages.

It’s primary purpose is to establish a fully decentralized Index of publish messages describing and facilitating the distribution of original content(artifacts). Publishers retain full control of their artifacts, but because it is stored in a blockchain the index is not centrally controled by anyone and is transparent to the community at-large. The individual publish messages describe (1)commerce & tipping preferences, (2)how media files can be found and distributed to end users, (3)cataloguing and descriptive information, (4)meta tags and more. Thru the use of a standardized schema for JSON messages and a simple set of mutually agreed-upon rules for core functions, the following permission-less jobs result:

Retailers of artifacts published in the index

Promoters of artifacts published to the index

AutoMiners contributing proofs-of-work to the mutual protection of the Index of artifacts

AutoDistributor provide storage and distribution services for the media files published to the index

Publishers of original content to the index

Protocol Software

Reference "browser" node.js application

Alexandria Browser - Index browser reference client | Github

Decentralized Full Node

Index Blockchain Wallet Daemon - Florincoin official site | Github | (note:Enable RPC access)
IPFS Daemon - IPFS official site | Github | Prebuilt Installer
Payment Blockchain Wallet Daemon - Bitcoin | Github
Decentralized Digital Rights Locker - Pockets | Github
OIP Daemon - a GoLang daemon for the OIP protocol. Closed repo currently, pending security audit | Request access

Retailer node

a web-hosted front end of some or all of the original content published to the Index
Decentralized Full Node
OIP-NPM - a node.js module built to enable publishing and submitting changes to the OIP index. Github
OIP Daemon - a GoLang daemon for the OIP protocol. Closed repo currently, pending security audit | Request access
hosted OIP API - for reading and searching the OIP index. all artifacts endpoint | search artifacts [endpoint] ( & usage
Web Interfaces - Browser, Publisher, Paywall & TradeBot
(paid directly by end users when they pay for a piece of media the retailer put in front of them, mostly using suggestion algorithms within a given front end/marketplace, percent of total sale they get is limited by preferences determined by publishers)


To run a mining pool

Pool Interface - Node.js pool portal Github
Pool Server - Node.js stratum pool server Github

To check the average pool_margin for the past 24 hours of protocol compliant mining pools
  1. Lookup the current block height and store the result as block (hosted API endpoint | Github source
  2. Use the historian summary API POST endpoint using:
  3. The averages array will include a field labeled pool_margin. If this amount is in the ballpark of your target margin on top of mining costs, you may wish to become an autominer
  1. Create an account on
  2. Make a new “pool profile”
    algo: Scrypt
    port: 3032
    worker: yourflorincoinaddress
    password: anythingyouwant
  3. Create a miningrigrentals API key
  4. Install and start the autominer_api application. Github
  5. Fund your wallet with some bitcoin, and the autominer-api will automatically start renting rigs if market conditions allow your minimum margin to be met
    (autominers are paid by publishers for their actual costs plus their requested margin, governed by data-driven market feedback mechanisms, limited by demand for publishing)


(paid by publishers or patrons of content, governed by free floating market prices per MB stored per unit of time and per MB transmitted, limited by caps set per piece of content, since in most cases, a file having any more than ~20 seeders starts to see diminishing returns quickly)


(paid directly by end users when they pay for a piece of media the promoter put in front of them, mostly over social media platforms, percent of total sale they get is limited by preferences determined by publishers)


•How to register as a Publisher
•How to format publish messages properly
•Calculating the required Publish Fee
•Calculating the trade value of tokens from AutoMiner nodes
•Using TradeBot to exchange Bitcoin for Florincoin tokens to use for publishing - Hosted API endpoints for checking tradable balance & starting a trade
(Publishers are paid by end users when they connect with an audience that finds their content valuable, at whatever price they and their market agree upon)

JSON standards:


Publishing fee formulae:

The OIP formula for calculating the publish fee is closed-loop and based on inputs found either in the Florincoin blockchain or in the publish message. It is calculated as a function of either (1) commercial value to the Publisher or (2) if it is being offered for free, as a function of its size in the blockchain.

Publish Fee, Free Artifact
Publish Fee, Commercial Artifact

Captured Value

alt text

You can’t perform that action at this time.