Difference between revisions of "Blockchain Messages Format and Schemae"

From OIP Wiki
Jump to: navigation, search
(Artifact Publish)
(Artifact Messages)
Line 27: Line 27:
  
 
=== 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 schema information for '''''Artifact Publishing''''', click Expand ->  
 
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
  {
 
  {
Line 100: Line 98:
  
 
=== Artifact Edit ===
 
=== Artifact Edit ===
You can view the schema information for Artifact Edits here: [[Artifact Edit Message Format]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 +
To view the JSON schema for '''''Artifact Edits''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "[[Variable Definitions#oip-041|oip-041]]": {
 +
        "[[Variable Definitions#editArtifact|editArtifact]]": {
 +
            "[[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>
  
 
=== Artifact Transfer ===
 
=== Artifact Transfer ===
You can view the Schema for Artifact Transfers here: [[Artifact Transfer Message Format]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 
+
To view the JSON schema for '''''Artifact Transfers''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "[[Variable Definitions#oip-041|oip-041]]": {
 +
    "[[Variable Definitions#transferArtifact|transferArtifact]]": {
 +
        "[[Variable Definitions#txid|txid]]": "string",
 +
            "[[Variable Definitions#to|to]]": "string",
 +
            "[[Variable Definitions#from|from]]": "string",
 +
            "[[Variable Definitions#timestamp|timestamp]]": int
 +
        },
 +
        "[[Variable Definitions#signature|signature]]": "string"
 +
    }
 +
}
 +
</div>
 +
</div>
 
=== Artifact Deactivate ===
 
=== Artifact Deactivate ===
You can view the Schema for Artifact Deactivations here: [[Artifact Deactivation Message Format]]
+
<div class="toccolours mw-collapsible mw-collapsed">
 +
To view the JSON schema for '''''Artifact Deactivation''''', click Expand ->
 +
<div class="mw-collapsible-content">
 +
{
 +
    "[[Variable Definitions#oip-041|oip-041]]": {
 +
        "[[Variable Definitions#deactivateArtifact|deactivateArtifact]]": {
 +
            "[[Variable Definitions#txid|txid]]": "string",
 +
            "[[Variable Definitions#timestamp|timestamp]]": int
 +
        },
 +
        "[[Variable Definitions#signature|signature]]": "string"
 +
    }
 +
}
 +
</div>
 +
</div>
  
 
== Historian Messages ==
 
== Historian Messages ==

Revision as of 22:58, 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

You can view information about the Register Publish Schema here

Edit Publisher

You can view information about the Edit Publish Schema here

Register Promoter

You can view information about the Register Promoter Schema here

Register Autominer

You can view information about the Register Autominer Schema here

Register Autominer Pool

You can view information about the Register Autominer Pool Schema here

Register Retailer

You can view information about the Register Retailer Schema here

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 Datapoint Message Format

Historian Block Reward

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

Historian Summary