Difference between revisions of "Blockchain Messages Format and Schemae"

From OIP Wiki
Jump to: navigation, search
(Historian Messages)
(Autominer Block Reward)
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Multipart Messages ==
+
__FORCETOC__
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.
+
{| class="wikitable"
 +
!
 +
!Register/Publish
 +
!Edit
 +
!Transfer Control
 +
!Deactivate
 +
!Historian
 +
|-
 +
!Publishers
 +
|[[#Publisher Register|Publisher Register]]
 +
|[[#Edit Publisher|Publisher Edit]]
 +
|
 +
|
 +
|
 +
|-
 +
!Artifacts
 +
|[[#Artifact Publish|Artifact Publish]]
 +
|[[#Artifact Edit|Artifact Edit]]
 +
|[[#Artifact Transfer|Artifact Transfer]]
 +
|[[#Artifact Deactivate|Artifact Deactivate]]
 +
|
 +
|-
 +
!Retailers
 +
|[[#Retailer Register|Retailer Register]]
 +
|[[#Retailer Edit|Retailer Edit]]
 +
|
 +
|
 +
|
 +
|-
 +
!Promoters
 +
|[[#Promoter Register|Promoter Register]]
 +
|[[#Promoter Edit|Promoter Edit]]
 +
|
 +
|
 +
|
 +
|-
 +
!Autominer Pools
 +
|[[#Autominer Pool Register|Autominer Pool Register]]
 +
|[[#Autominer Pool Edit|Autominer Pool Edit]]
 +
|
 +
|
 +
|[[Blockchain Messages Format and Schemae#Autominer Pool Historian Datapoint|Datapoint]]
 +
|-
 +
!Autominers
 +
|[[#Autominer Register|Autominer Register]]
 +
|[[#Autominer Edit|Autominer Edit]]
 +
|
 +
|
 +
|[[#Autominer Block Reward|Block Reward]]
 +
|}
 +
 
 +
= Multipart Messages =
 +
All of the below blockchain messages are stored as plaintext in one or more transaction comments. If the total message length is 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 [[Multipart Message Format|here]].
 
You can find information on how Multipart messages are formed [[Multipart Message Format|here]].
  
== Registration Messages ==
+
[[message protocol]]
  
=== Register Publisher ===
+
== Publisher Register ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
To view the JSON schema for '''''Register Publisher''''', click Expand ->  
+
To view the JSON schema for '''''Publisher Register''''', click Expand ->  
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
{
+
  {
    "oip-041": {
+
  "[[Variable Definitions#oip.23.23.23|oip042]]": {
        "pub": {
+
  "[[Variable_Definitions#register|register]]": {
            "alias": "$PublisherAlias",
+
  "[[Variable_Definitions#pub|pub]]": {
            "address": "$PublisherAddress",
+
  "[[Variable_Definitions#alias|alias]]": "string",
            "timestamp": $UnixTime,
+
  "[[Variable_Definitions#address|address]]": "string",
            "info": {
+
  "[[Variable_Definitions#timestamp|timestamp]]": integer,
                "emailmd5": "$md5HashOfEmail",
+
  "[[Variable_Definitions#authorized|authorized]]": ["string", "string"],
                "avatarNetwork": "$IPFSorBittorrentorHTTP"
+
  "extraInfo": {
                "avatar": "$NetworkAddressOfAvatarImage
+
  "[[Variable_Definitions#emailmd5|emailmd5]]": "string",
                "bitmessage": "$bitmessageAddress",
+
  "[[Variable_Definitions#avatarNetwork|avatarNetwork]]": "string",
                },
+
  "[[Variable_Definitions#avatar|avatar]]": "string",
            "verification": {
+
  "[[Variable_Definitions#headerImageNetwork|headerImageNetwork]]": "string",
                "IMDB": "$IMDBArtistUrl",
+
  "[[Variable_Definitions#headerImage|headerImage]]": "string",
                "MusicBrainz": "$MusicBrainzArtistURL",
+
  "[[Variable_Definitions#bitmessage|bitmessage]]": "string"
                "Twitter": "$TwitterVerificationURL",
+
  },
                "Facebook": $FacebookVerificationURL"
+
  "verification": {
                }
+
  "[[Variable_Definitions#IMDB|IMDB]]": "string",
            },
+
  "[[Variable_Definitions#MusicBrainz|MusicBrainz]]": "string",
        "signature": "$RegisterPublisherSignature"
+
  "[[Variable_Definitions#Twitter|Twitter]]": "string",
    }
+
  "[[Variable_Definitions#Facebook|Facebook]]": "string"
}
+
  }
[[deprecated register publisher|deprecated '''''Register Publisher''''' schema]]
+
  },
 +
  "[[Variable_Definitions#signature|signature]]": "string"
 +
  }
 +
  }
 +
  }
 +
[[deprecated register publisher|deprecated '''''Publisher Register''''' schema]]
 
</div>
 
</div>
 
</div>
 
</div>
=== Edit Publisher ===
+
A list of Registered Publishers can be found at [[Alexandrias_Hosted_APIs#Get_All_Publishers|Alexandria's hosted API endpoint]]
 +
 
 +
== Publisher Edit ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
To view the JSON schema for '''''Register Publisher''''', click Expand ->  
+
To view the JSON schema for '''''Publisher Edit''''', click Expand ->  
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
  {
 
  {
     "[[Variable Definitions#oip-041|oip-041]]": {
+
     "[[Variable Definitions#oip.23.23.23|oip042]]": {
         "[[Variable Definitions#editPub|editPub]]": {
+
         "[[Variable Definitions#edit|edit]]": {
             "[[Variable Definitions#txid|txid]]": "string",
+
             "[[Variable Definitions#pub|pub]]": {
            "[[Variable Definitions#timestamp|timestamp]]": int,
+
                "[[Variable Definitions#address|address]]": "string",
            "[[Variable Definitions#patch|patch]]": {
+
                "[[Variable Definitions#timestamp|timestamp]]": int,
                // [[Squash Edit|Squashed Edit]] of JSON Patch Schema https://tools.ietf.org/html/rfc6902
+
                "[[Variable Definitions#patch|patch]]": {
 +
                    // [[Squash Edit|Squashed Edit]] of JSON Patch Schema https://tools.ietf.org/html/rfc6902
 +
                }
 
             }
 
             }
 
         }
 
         }
Line 53: Line 114:
 
</div>
 
</div>
 
</div>
 
</div>
=== Register Promoter ===
 
<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 ===
 
<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 ===
 
You can view information about the Register Autominer Pool Schema [[Autominer Pool Registration Message Format|here]]
 
 
=== Register Retailer ===
 
<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 Publish ===
+
== Artifact Publish ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
 
To view the JSON schema for '''''Artifact Publishing''''', click Expand ->  
 
To view the JSON schema for '''''Artifact Publishing''''', click Expand ->  
Line 141: Line 135:
 
                         "string",
 
                         "string",
 
                         "string"
 
                         "string"
                        ]
+
                    ]
                    }
+
                }
                },
+
            },
 
             "payment":{
 
             "payment":{
 
                 "[[Variable Definitions#fiat|fiat]]": "string",
 
                 "[[Variable Definitions#fiat|fiat]]": "string",
Line 160: Line 154:
 
                     "STRING": int
 
                     "STRING": int
 
                 }
 
                 }
                },
+
            },
 
             "storage":{
 
             "storage":{
 
                 "[[Variable Definitions#network|network]]": "string",
 
                 "[[Variable Definitions#network|network]]": "string",
Line 185: Line 179:
 
                         "tokenlyID": "string"
 
                         "tokenlyID": "string"
 
                     }
 
                     }
                 },
+
                 ]
            "[[Variable Definitions#signature_2|signature]]": "string"
+
            },
        }
+
        "[[Variable Definitions#signature_2|signature]]": "string"
 +
    }
 
  }
 
  }
 
</div>
 
</div>
 
</div>
 
</div>
 +
A list of Published Artifacts can be found at [[Alexandrias_Hosted_APIs#Artifacts|Alexandria's hosted API endpoint]]
  
=== Artifact Edit ===
+
== Artifact Edit ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
 
To view the JSON schema for '''''Artifact Edits''''', click Expand ->  
 
To view the JSON schema for '''''Artifact Edits''''', click Expand ->  
Line 211: Line 207:
 
</div>
 
</div>
  
=== Artifact Transfer ===
+
== Artifact Transfer ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
 
To view the JSON schema for '''''Artifact Transfers''''', click Expand ->  
 
To view the JSON schema for '''''Artifact Transfers''''', click Expand ->  
Line 228: Line 224:
 
</div>
 
</div>
 
</div>
 
</div>
=== Artifact Deactivate ===
+
 
 +
== Artifact Deactivate ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
 
To view the JSON schema for '''''Artifact Deactivation''''', click Expand ->  
 
To view the JSON schema for '''''Artifact Deactivation''''', click Expand ->  
Line 244: Line 241:
 
</div>
 
</div>
  
== Historian Messages ==
+
== Retailer Register ==
 +
Plaintext data, stored in a transaction comment.
 +
<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": 2,
 +
            "extraInfo": {
 +
                "name": "string",
 +
                "minimum-share": int
 +
            },
 +
            "verification": {
 +
                "twitter": "string",
 +
                "facebook": "string"
 +
            }
 +
        },
 +
        "signature": "string"
 +
    }
 +
}
 +
[[deprecated register retailer|deprecated '''''Register Retailer''''' schema]]
 +
</div>
 +
</div>
 +
A list of Registered Retailers can be found at [[Alexandrias_Hosted_APIs#Retailers|Alexandria's hosted API endpoint]]
 +
 
 +
== Promoter Register ==
 +
<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": 2,
 +
            "extraInfo": {
 +
                "name": "string",
 +
                "minimum-share": int
 +
            },
 +
            "verification":{ 
 +
                "facebook":"string",
 +
                "twitter":"string"
 +
            }
 +
        },
 +
        "signature":"string"
 +
    }
 +
}
 +
[[deprecated register promoter|deprecated '''''Register Promoter''''' schema]]
 +
</div>
 +
</div>
 +
A list of Registered Promoters can be found at [[Alexandrias_Hosted_APIs#Promoters|Alexandria's hosted API endpoint]]
 +
 
 +
== Autominer Register ==
 +
<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>
 +
A list of Registered Autominers can be found at [[Alexandrias_Hosted_APIs#Autominers|Alexandria's hosted API endpoint]]
 +
 
 +
== Autominer Pool Register ==
 +
<div class="toccolours mw-collapsible mw-collapsed">
 +
To view the JSON schema for '''''Register Autominer Pool''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "oip-041": {
 +
        "autominerPool": {
 +
            "FLOaddress": "string",
 +
            "webURL": "string",
 +
            "PoolName": "string",
 +
            "TargetMargin": integer,
 +
            "PoolShare": integer,
 +
            "version": 2
 +
        },
 +
        "signature": "string"
 +
    }
 +
}
 +
[[Deprecated register autominer pool|deprecated '''''Register Autominer Pool''''' schema]]
 +
</div>
 +
</div>
 +
A list of Registered Autominer Pools can be found at [[Alexandrias_Hosted_APIs#Autominer_Pool|Alexandria's hosted API endpoint]]
 +
 
 +
= Historian Messages =
  
=== Historian Datapoint ===
+
== Autominer Pool Historian Datapoint ==
 
Plaintext data, stored in the block reward (coinbase) transaction comment.
 
Plaintext data, stored in the block reward (coinbase) transaction comment.
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
Line 253: Line 349:
 
  {
 
  {
 
  oip-historian-2:
 
  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]]
 +
}
 +
 +
{
 +
oip042Hd:
 +
pub:
 +
historypoint:
 
  [[pool_flo_address]]:
 
  [[pool_flo_address]]:
 
  [[results.mrr.last_10]]:
 
  [[results.mrr.last_10]]:
Line 265: Line 376:
 
</div>
 
</div>
 
</div>
 
</div>
=== Historian Block Reward ===
+
== Autominer Block Reward ==
 
+
<div class="toccolours mw-collapsible mw-collapsed">
Plaintext data, stored the transaction comments. [[Historian Block Reward Message Format]]
+
To view the JSON schema for '''''Historian Block Reward''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    oip042Hb:
 +
    [[pool_flo_address]]:
 +
    [[block]]:
 +
    [[historian-blockreward-signature]]
 +
}
 +
</div>
 +
</div>

Latest revision as of 23:32, 31 January 2018

Register/Publish Edit Transfer Control Deactivate Historian
Publishers Publisher Register Publisher Edit
Artifacts Artifact Publish Artifact Edit Artifact Transfer Artifact Deactivate
Retailers Retailer Register Retailer Edit
Promoters Promoter Register Promoter Edit
Autominer Pools Autominer Pool Register Autominer Pool Edit Datapoint
Autominers Autominer Register Autominer Edit Block Reward

Multipart Messages

All of the below blockchain messages are stored as plaintext in one or more transaction comments. If the total message length is 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.

message protocol

Publisher Register

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

 {
 	"oip042": {
 		"register": {
 			"pub": {
 				"alias": "string",
 				"address": "string",
 				"timestamp": integer,
 				"authorized": ["string", "string"],
 				"extraInfo": {
 					"emailmd5": "string",
 					"avatarNetwork": "string",
 					"avatar": "string",
 					"headerImageNetwork": "string",
 					"headerImage": "string",
 					"bitmessage": "string"
 				},
 				"verification": {
 					"IMDB": "string",
 					"MusicBrainz": "string",
 					"Twitter": "string",
 					"Facebook": "string"
 				}
 			},
 			"signature": "string"
 		}
 	}
 }

deprecated Publisher Register schema

A list of Registered Publishers can be found at Alexandria's hosted API endpoint

Publisher Edit

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

{
    "oip042": {
        "edit": {
            "pub": {
                "address": "string",
                "timestamp": int,
                "patch": {
                    // Squashed Edit of JSON Patch Schema https://tools.ietf.org/html/rfc6902
                }
            }
        }
    },
    "signature": "string"
}

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"
    }
}

A list of Published Artifacts can be found at Alexandria's hosted API endpoint

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"
    }
}

Retailer Register

Plaintext data, stored in a transaction comment.

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

{
    "oip-041": {
        "retailer": {
            "FLOaddress": "string",
            "FLOaddress": "string",
            "http-url": "string",
            "version": 2,
            "extraInfo": {
                "name": "string",
                "minimum-share": int
            },
            "verification": {
                "twitter": "string",
                "facebook": "string"
            }
        },
        "signature": "string"
    }
}

deprecated Register Retailer schema

A list of Registered Retailers can be found at Alexandria's hosted API endpoint

Promoter Register

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

{  
    "oip-041":{  
        "promoter":{  
            "BTCaddress":"string",
            "LTCaddress":"string",
            "FLOaddress":"string",
            "version": 2,
            "extraInfo": {
                "name": "string",
                "minimum-share": int
            },
            "verification":{  
                "facebook":"string",
                "twitter":"string"
            }
        },
        "signature":"string"
    }
}

deprecated Register Promoter schema

A list of Registered Promoters can be found at Alexandria's hosted API endpoint

Autominer Register

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

A list of Registered Autominers can be found at Alexandria's hosted API endpoint

Autominer Pool Register

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

{
    "oip-041": {
        "autominerPool": {
            "FLOaddress": "string",
            "webURL": "string",
            "PoolName": "string",
            "TargetMargin": integer,
            "PoolShare": integer,
            "version": 2
        },
        "signature": "string"
    }
}

deprecated Register Autominer Pool schema

A list of Registered Autominer Pools can be found at Alexandria's hosted API endpoint

Historian Messages

Autominer Pool Historian Datapoint

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

Autominer Block Reward

To view the JSON schema for Historian Block Reward, click Expand ->