contract.json

{
    "$schema": "http://json-schema.org/schema#",
    "title": "PDO Contract Request",
    "id": "http://tradenet.org/pdo/eservice/contract/requests#",
    "definitions": {
        "ContractRequest": {
            "id": "#ContractRequest",
            "description": [
                "a request to create a new instance of a contract state",
                "associated with the contract identifier"
            ],
            "type": "object",
            "properties": {
                "Operation": {
                    "description": [
                        "field describing the type of the request"
                    ],
                    "type": "string",
                    "enum": [
                        "initialize",
                        "update"
                    ],
                    "required": true
                },
                "ContractID": {
                    "description": [
                        "encoded contract id"
                    ],
                    "$ref": "#/pdo/basetypes/contract-id",
                    "required": true
                },
                "CreatorID": {
                    "description": [
                        "contract creator identifier"
                    ],
                    "$ref": "#/pdo/basetypes/transactor-id",
                    "required": true
                },
                "EncryptedStateEncryptionKey": {
                    "description": [
                        "encrypted state encryption key"
                    ],
                    "$ref": "#/pdo/basetypes/state-encryption-key",
                    "required": true
                },
                "ContractCode": {
                    "description": [
                        "contract code",
                        "required for initialize operation"
                    ],
                    "type": "object",
                    "properties": {
                        "Code": {
                            "description": [
                                "the contract code"
                            ],
                            "type": "string",
                            "maxLength": 65535,
                            "required": true
                        },
                        "Name": {
                            "description": [
                                "the name of the contract class in the code"
                            ],
                            "type": "string",
                            "maxLength": 32,
                            "required": true
                        },
                        "Nonce": {
                            "description": [
                                "random string to facilitate randomness code hash"
                            ],
                            "type": "string",
                            "maxLength": 32,
                            "required": true
                        }
                        "CompilationReport": {
                            "type": "object",
                            "description": [
                                "signed proof of code provenance and integrity"
                            ],
                            "properties": {
                                "CompilerName": {
                                    "description": [
                                        "the name of the compiler that built the code"
                                    ],
                                    "type": "string",
                                    "maxLength": 32,
                                    "required": true
                                },
                                "CompilerVersion": {
                                    "description": [
                                        "the version number of the compiler that built the code"
                                    ],
                                    "type": "string",
                                    "maxLength": 32,
                                    "required": true
                                },
                                "CompilerConfiguration": {
                                    "description": [
                                        "a string of all compiler flags"
                                    ],
                                    "type": "string",
                                    "maxLength": 128,
                                    "required": true
                                },
                                "SourceHash": {
                                    "description": [
                                        "hash of the source/byte code compiler input"
                                    ],
                                    "$ref": "#/pdo/basetypes/encoded-hash",
                                    "required": true
                                },
                                "BinaryHash": {
                                    "description": [
                                        "hash of the native binary code compiler output"
                                    ],
                                    "$ref": "#/pdo/basetypes/encoded-hash",
                                    "required": true
                                },
                                "CompilerSignature": {
                                    "description": [
                                        "signature over the compiler inputs and output"
                                    ],
                                    "$ref": "#escda-signature",
                                    "required": true
                                },
                                "CompilerVerifyingKey": {
                                    "description": [
                                        "identifier for the compiler that built the code"
                                    ],
                                    "$ref": "#transactor-id",
                                    "required": true
                                },
                                "CompilerKeyLedgerSig": {
                                    "description": [
                                        "ledger signature over the compiler's key"
                                    ],
                                    "$ref": "#escda-signature",
                                    "required": false
                                }
                            },
                            "required": false
                        }
                    },
                    "required": false
                },
                "ContractCodeHash": {
                    "description": [
                        "hash of the contract code",
                        "required for update operations"
                    ],
                    "$ref": "#/pdo/basetypes/encoded-hash",
                    "required": false
                },
                "ContractStateHash": {
                    "description": [
                        "hash of the contract state",
                        "required for update operation"
                    ],
                    "$ref": "#/pdo/basetypes/encoded-hash",
                    "required": false
                },
                "ContractMessage": {
                    "description": [
                        ""
                    ],
                    "type": "object",
                    "properties": {
                        "InvocationRequest": {
                            "description": [
                                "the message to be sent to the contract",
                                "see invocation api for format"
                            ],
                            "type": "string",
                            "maxLength": 65535,
                            "required": true
                        },
                        "OriginatorVerifyingKey": {
                            "description": [
                                "identifier for the transactor requesting the method invocation"
                            ],
                            "$ref": "#transactor-id",
                            "required": true
                        },
                        "ChannelVerifyingKey": {
                            "description": [
                                "public key for the channel key pair"
                            ],
                            "$ref": "#transactor-id",
                            "required": true
                        },
                        "Nonce": {
                            "description": [
                                "random string to facilitate randomness in the message"
                            ],
                            "type": "string",
                            "maxLength": 32,
                            "required": true
                        },
                        "Signature": {
                            "description": [
                                "signature over the expression"
                            ],
                            "$ref": "#escda-signature",
                            "required": true
                        }
                    },
                    "required": true
                }
            }
        },
        "ContractResponse": {
            "id": "#ContractResponse",
            "description": [
                "General schema for responses from the contract enclave"
            ],
            "type": "object",
            "properties": {
                "Status": {
                    "description": [
                        "flag to indicate success/failure of the invocation",
                        "TODO: distinguish between contract/policy failure"
                    ],
                    "type": "boolean",
                    "required": true
                },
                "StateChanged": {
                    "description": [
                        "flag to indicate that state was changed"
                    ],
                    "type": "boolean",
                    "required": true
                },
                "InvocationResponse": {
                    "description": [
                        "the value returned from method evaluation",
                        "see invocation api for format"
                    ],
                    "type": "string",
                    "maxLength": 65535,
                    "required": true
                },
                "Signature": {
                    "description": [
                        "signature of the request/response"
                    ],
                    "$ref": "#/pdo/basetypes/ecdsa-signature",
                    "required": true
                },
                "StateHash": {
                    "description": [
                        "hash of the state that must be committed"
                    ],
                    "$ref": "#/pdo/basetypes/encoded-hash",
                    "required": true
                },
                "Dependencies": {
                    "description": [
                        "List of dependent contract commits"
                    ],
                    "type": "array",
                    "items": {
                        "$ref": "#/pdo/basetypes/state-reference",
                        "minItems": 0,
                        "uniqueItems": true,
                        "default": []
                    },
                    "required": true
                }
            }
        }
    }
}