Difference between revisions of "Blockchain Messages Format and Schemae"

From OIP Wiki
Jump to: navigation, search
(formatting)
Line 47: Line 47:
  
 
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 ==
 
  
 
=== Publisher Register ===
 
=== Publisher Register ===
Plaintext data, stored in a transaction comment.
+
Plaintext data, stored in a transaction comment.<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
 
 
To view the JSON schema for '''''Publisher Register''''', click Expand ->  
 
To view the JSON schema for '''''Publisher Register''''', click Expand ->  
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Line 77: Line 74:
 
     }
 
     }
 
  }
 
  }
[[deprecated register publisher|deprecated '''''Register Publisher''''' schema]]
+
[[deprecated register publisher|deprecated '''''Publisher Register''''' schema]]
 
</div>
 
</div>
 
</div>
 
</div>
Line 100: Line 97:
 
</div>
 
</div>
 
</div>
 
</div>
=== Register Retailer ===
+
=== Retailer Register ===
 
Plaintext data, stored in a transaction comment.
 
Plaintext data, stored in a transaction comment.
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
Line 124: Line 121:
 
</div>
 
</div>
 
A list of Registered Retailers can be found at [[Alexandrias_Hosted_APIs#Retailers|Alexandria's hosted API endpoint]]
 
A list of Registered Retailers can be found at [[Alexandrias_Hosted_APIs#Retailers|Alexandria's hosted API endpoint]]
=== Register Promoter ===
+
=== Promoter Register ===
 
Plaintext data, stored in a transaction comment.
 
Plaintext data, stored in a transaction comment.
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
Line 149: Line 146:
 
</div>
 
</div>
 
A list of Registered Promoters can be found at [[Alexandrias_Hosted_APIs#Promoters|Alexandria's hosted API endpoint]]
 
A list of Registered Promoters can be found at [[Alexandrias_Hosted_APIs#Promoters|Alexandria's hosted API endpoint]]
=== Register Autominer ===
+
=== Autominer Register ===
 
Plaintext data, stored in a transaction comment.
 
Plaintext data, stored in a transaction comment.
 
<div class="toccolours mw-collapsible mw-collapsed">
 
<div class="toccolours mw-collapsible mw-collapsed">
Line 169: Line 166:
 
</div>
 
</div>
 
A list of Registered Autominers can be found at [[Alexandrias_Hosted_APIs#Autominers|Alexandria's hosted API endpoint]]
 
A list of Registered Autominers can be found at [[Alexandrias_Hosted_APIs#Autominers|Alexandria's hosted API endpoint]]
=== Register Autominer Pool ===
+
=== Autominer Pool Register ===
 
Plaintext data, stored in a transaction comment.   
 
Plaintext data, stored in a transaction comment.   
 
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]]   

Revision as of 01:19, 3 January 2018

Register/Publish Edit Transfer Control Deactivate
Publishers Publisher Register Publisher Edit
Artifacts Artifact Publish Artifact Edit Artifact Reassign Artifact Deactivate
Promoters Promoter Register Promoter Edit
Retailers Retailer Register Retailer Edit
Autominers Autominer Register Autominer Edit
Autominer Pools Autominer Pool Register Autominer Pool Edit

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.

Publisher Register

Plaintext data, stored in a transaction comment.

To view the JSON schema for Publisher Register, 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 Publisher Register schema

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

Publisher Edit

Plaintext data, stored in a transaction comment.

To view the JSON schema for Edit 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"
}

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": 1,
            "opt": {
                "name": "string",
                "minimum-share": int
            }
        },
        "signature": "string"
    }
}

deprecated Register Retailer schema

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

Promoter Register

Plaintext data, stored in a transaction comment.

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

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

Autominer Register

Plaintext data, stored in a transaction comment.

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

Plaintext data, stored in a transaction comment. You can view information about the Register Autominer Pool Schema here A list of Registered Autominer Pools can be found at Alexandria's hosted API endpoint

Artifact Messages

Artifact Publish

Plaintext data, stored in one or more transaction comments, using the multipart scheme.

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

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