Difference between revisions of "Blockchain Messages Format and Schemae"

From OIP Wiki
Jump to: navigation, search
(add nav table)
Line 3: Line 3:
 
!Register/Publish
 
!Register/Publish
 
!Edit
 
!Edit
!Reassign Ownership
+
!Transfer Control
 
!Deactivate
 
!Deactivate
 
|-
 
|-
 
!Publishers
 
!Publishers
|[[Blockchain Messages Format and Schemae#Register Publisher|Register Publisher]]
+
|[[#Publisher Register|Publisher Register]]
|[[#Edit Publisher|Edit Publisher]]
+
|[[#Edit Publisher|Publisher Edit]]
 
|
 
|
 
|
 
|
 
|-
 
|-
 
!Artifacts
 
!Artifacts
|Publish Artifact
+
|[[#Artifact Publish|Artifact Publish]]
|Edit Artifact
+
|[[#Artifact Edit|Artifact Edit]]
|Reassign Artifact
+
|[[#Artifact Transfer|Artifact Reassign]]
|Deactivate Artifact
+
|[[#Artifact Deactivate|Artifact Deactivate]]
 
|-
 
|-
 
!Promoters
 
!Promoters
|Register Promoter
+
|[[#Promoter Register|Promoter Register]]
|Edit Promoter
+
|[[#Promoter Edit|Promoter Edit]]
 
|
 
|
 
|
 
|
 
|-
 
|-
 
!Retailers
 
!Retailers
|Register Retailer
+
|[[#Retailer Register|Retailer Register]]
|Edit Retailer
+
|[[#Retailer Edit|Retailer Edit]]
 
|
 
|
 
|
 
|
 
|-
 
|-
 
!Autominers
 
!Autominers
|Register Autominer
+
|[[#Autominer Register|Autominer Register]]
|Edit Autominer
+
|[[#Autominer Edit|Autominer Edit]]
 
|
 
|
 
|
 
|
 
|-
 
|-
 
!Autominer Pools
 
!Autominer Pools
|Register Autominer Pool
+
|[[#Autominer Pool Register|Autominer Pool Register]]
|Edit Autominer Pool
+
|[[#Autominer Pool Edit|Autominer Pool Edit]]
 
|
 
|
 
|
 
|
Line 50: Line 50:
 
== Registration Messages ==
 
== Registration Messages ==
  
=== Register Publisher ===
+
=== 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 '''''Register Publisher''''', click Expand ->  
+
To view the JSON schema for '''''Publisher Register''''', click Expand ->  
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
  {
 
  {
Line 81: Line 81:
 
</div>
 
</div>
 
A list of Registered Publishers can be found at [[Alexandrias_Hosted_APIs#Get_All_Publishers|Alexandria's hosted API endpoint]]
 
A list of Registered Publishers can be found at [[Alexandrias_Hosted_APIs#Get_All_Publishers|Alexandria's hosted API endpoint]]
=== Edit Publisher ===
+
=== Publisher Edit ===
 
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">

Revision as of 01:12, 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.

Registration Messages

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

Register Promoter

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

Register Autominer

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

Register Autominer Pool

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

Register Retailer

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

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