Blockchain Messages Format and Schemae

From OIP Wiki
Jump to: navigation, search
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 ->