Difference between revisions of "Blockchain Messages Format and Schemae"

From OIP Wiki
Jump to: navigation, search
(Artifact Messages)
Line 7: Line 7:
  
 
=== Register Publisher ===
 
=== Register Publisher ===
You can view information about the Register Publish Schema [[Publisher Registration Message Format|here]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Register Publisher''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "oip-041": {
 +
        "pub": {
 +
            "alias": "$PublisherAlias",
 +
            "address": "$PublisherAddress",
 +
            "timestamp": $UnixTime,
 +
            "info": {
 +
                "emailmd5": "$md5HashOfEmail",
 +
                "avatarNetwork": "$IPFSorBittorrentorHTTP"
 +
                "avatar": "$NetworkAddressOfAvatarImage
 +
                "bitmessage": "$bitmessageAddress",
 +
                },
 +
            "verification": {
 +
                "IMDB": "$IMDBArtistUrl",
 +
                "MusicBrainz": "$MusicBrainzArtistURL",
 +
                "Twitter": "$TwitterVerificationURL",
 +
                "Facebook": $FacebookVerificationURL"
 +
                }
 +
            },
 +
        "signature": "$RegisterPublisherSignature"
 +
    }
 +
}
 +
[[deprecated register publisher|deprecated '''''Register Publisher''''' schema]]
 +
</div>
 +
</div>
 
=== Edit Publisher ===
 
=== Edit Publisher ===
You can view information about the Edit Publish Schema [[Edit Registration Message Format|here]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Register Publisher''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "[[Variable Definitions#oip-041|oip-041]]": {
 +
        "[[Variable Definitions#editPub|editPub]]": {
 +
            "[[Variable Definitions#txid|txid]]": "string",
 +
            "[[Variable Definitions#timestamp|timestamp]]": int,
 +
            "[[Variable Definitions#patch|patch]]": {
 +
                // [[Squash Edit|Squashed Edit]] of JSON Patch Schema https://tools.ietf.org/html/rfc6902
 +
            }
 +
        }
 +
    },
 +
    "[[Variable Definitions#signature|signature]]": "string"
 +
}
 +
</div>
 +
</div>
 
=== Register Promoter ===
 
=== Register Promoter ===
You can view information about the Register Promoter Schema [[Promoter Registration Message Format|here]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Register Promoter''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
 +
    "oip-041":{ 
 +
        "promoter":{ 
 +
            "BTCaddress":"string",
 +
            "LTCaddress":"string",
 +
            "FLOaddress":"string",
 +
            "version":1,
 +
            "social":{ 
 +
                "facebook":"string",
 +
                "twitter":"string",
 +
                "instagram":"string"
 +
            }
 +
        },
 +
        "signature":"string"
 +
    }
 +
}
 +
[[deprecated register promoter|deprecated '''''Register Promoter''''' schema]]
 +
</div>
 +
</div>
 
=== Register Autominer ===
 
=== Register Autominer ===
You can view information about the Register Autominer Schema [[Autominer Registration Message Format|here]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Register Autominer''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "oip-041": {
 +
        "autominer": {
 +
            "FLOaddress": "string",
 +
            "BTCaddress": "string",
 +
            "endpointURL": "string",
 +
            "version": 2
 +
        },
 +
        "signature": "string"
 +
    }
 +
}
 +
[[deprecated register autominer|deprecated '''''Register Autominer''''' schema]]
 +
</div>
 +
</div>
 
=== Register Autominer Pool ===
 
=== Register Autominer Pool ===
 
You can view information about the Register Autominer Pool Schema [[Autominer Pool Registration Message Format|here]]
 
You can view information about the Register Autominer Pool Schema [[Autominer Pool Registration Message Format|here]]
  
 
=== Register Retailer ===
 
=== Register Retailer ===
You can view information about the Register Retailer Schema [[Retailer Registration Message Format|here]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Register Retailer''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "oip-041": {
 +
        "retailer": {
 +
            "FLOaddress": "string",
 +
            "FLOaddress": "string",
 +
            "http-url": "string",
 +
            "version": 1,
 +
            "opt": {
 +
                "name": "string",
 +
                "minimum-share": int
 +
            }
 +
        },
 +
        "signature": "string"
 +
    }
 +
}
 +
[[deprecated register retailer|deprecated '''''Register Retailer''''' schema]]
 +
</div>
 +
</div>
 
== Artifact Messages ==
 
== Artifact Messages ==
  
Line 152: Line 247:
  
 
=== Historian Datapoint ===
 
=== Historian Datapoint ===
 
+
Plaintext data, stored in the block reward (coinbase) transaction comment.
Plaintext data, stored in the block reward (coinbase) transaction comment. [[Historian Datapoint Message Format]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Historian Datapoints''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
oip-historian-2:
 +
[[pool_flo_address]]:
 +
[[results.mrr.last_10]]:
 +
[[results.mrr.last_24hr]]:
 +
[[results.pool.hashrate]]:
 +
[[results.fbd.networkhashps]]:
 +
[[results.fmd.weighted]]:
 +
[[results.ltc.price_usd]]:
 +
[[results.fmd.usd]]:
 +
[[historian-datapoint-signature]]
 +
}
 +
</div>
 +
</div>
 
=== Historian Block Reward ===
 
=== Historian Block Reward ===
  

Revision as of 23:26, 2 January 2018

Multipart Messages

If any of the messages created below are larger than the 528 byte tx-comments currently supported by Florincoin, then the message will be split up into a Multipart message.

You can find information on how Multipart messages are formed here.

Registration Messages

Register Publisher

To view the JSON schema for Register Publisher, click Expand ->

{
    "oip-041": {
        "pub": {
            "alias": "$PublisherAlias",
            "address": "$PublisherAddress",
            "timestamp": $UnixTime,
            "info": {
                "emailmd5": "$md5HashOfEmail",
                "avatarNetwork": "$IPFSorBittorrentorHTTP"
                "avatar": "$NetworkAddressOfAvatarImage
                "bitmessage": "$bitmessageAddress",
                },
            "verification": {
                "IMDB": "$IMDBArtistUrl",
                "MusicBrainz": "$MusicBrainzArtistURL",
                "Twitter": "$TwitterVerificationURL",
                "Facebook": $FacebookVerificationURL"
                }
            },
        "signature": "$RegisterPublisherSignature"
    }
}

deprecated Register Publisher schema

Edit Publisher

To view the JSON schema for Register Publisher, click Expand ->

{
    "oip-041": {
        "editPub": {
            "txid": "string",
            "timestamp": int,
            "patch": {
                // Squashed Edit of JSON Patch Schema https://tools.ietf.org/html/rfc6902
            }
        }
    },
    "signature": "string"
}

Register Promoter

To view the JSON schema for Register Promoter, click Expand ->

{  
    "oip-041":{  
        "promoter":{  
            "BTCaddress":"string",
            "LTCaddress":"string",
            "FLOaddress":"string",
            "version":1,
            "social":{  
                "facebook":"string",
                "twitter":"string",
                "instagram":"string"
            }
        },
        "signature":"string"
    }
}

deprecated Register Promoter schema

Register Autominer

To view the JSON schema for Register Autominer, click Expand ->

{
    "oip-041": {
        "autominer": {
            "FLOaddress": "string",
            "BTCaddress": "string",
            "endpointURL": "string",
            "version": 2
        },
        "signature": "string"
    }
}

deprecated Register Autominer schema

Register Autominer Pool

You can view information about the Register Autominer Pool Schema here

Register Retailer

To view the JSON schema for Register Retailer, click Expand ->

{
    "oip-041": {
        "retailer": {
            "FLOaddress": "string",
            "FLOaddress": "string",
            "http-url": "string",
            "version": 1,
            "opt": {
                "name": "string",
                "minimum-share": int
            }
        },
        "signature": "string"
    }
}

deprecated Register Retailer schema

Artifact Messages

Artifact Publish

To view the JSON schema for Artifact Publishing, click Expand ->

{
    "oip-041":{
        "artifact":{
            "publisher": "string",
            "timestamp": 10 digit int,
            "type": "string",
            "info":{
                "title": "string",
                "description": "string",
                "year": 4 digit int,
                "extraInfo":{
                    "artist": "string",
                    "company": "string",
                    "tags":[
                        "string",
                        "string"
                        ]
                    }
                },
            "payment":{
                "fiat": "string",
                "scale": int,
                "sugTip":[
                    int,
                    int,
                    int
                    ],
                "addresses": {
                    "three letter string":"string",
                    "three letter string":"string"
                },
                "tokens": {
                    "STRING": int,
                    "STRING": int
                }
                },
            "storage":{
                "network": "string",
                "location": "string,
                "files":[
                    {
                        "disBuy": boolean,
                        "disPlay": boolean,
                        "dName": "string",
                        "duration": int,
                        "fName": "string",
                        "fSize": int,
                        "sugPlay": "int",
                        "minPlay": "int",
                        "sugBuy": "int",
                        "minBuy": "int",
                        "disPer": "int",
                        "promo": "int",
                        "retail": "int",
                        "ptpFT": int,
                        "ptpDT": int,
                        "ptpDA": int,
                        "type": "string",
                        "tokenlyID": "string"
                    }
                },
            "signature": "string"
        }
}

Artifact Edit

To view the JSON schema for Artifact Edits, click Expand ->

{
    "oip-041": {
        "editArtifact": {
            "txid": "string",
            "timestamp": int,
            "patch": {
                // Squashed Edit of JSON Patch Schema https://tools.ietf.org/html/rfc6902
            }
        }
    },
    "signature": "string"
}

Artifact Transfer

To view the JSON schema for Artifact Transfers, click Expand ->

{
    "oip-041": {
    "transferArtifact": {
        "txid": "string",
            "to": "string",
            "from": "string",
            "timestamp": int
        },
        "signature": "string"
    }
}

Artifact Deactivate

To view the JSON schema for Artifact Deactivation, click Expand ->

{
    "oip-041": {
        "deactivateArtifact": {
            "txid": "string",
            "timestamp": int
        },
        "signature": "string"
    }
}

Historian Messages

Historian Datapoint

Plaintext data, stored in the block reward (coinbase) transaction comment.

Historian Block Reward

Plaintext data, stored the transaction comments. Historian Block Reward Message Format

Historian Summary