string public_key = 1
string name = 2
A human readable name identifying the Agent
uint64 timestamp = 3
Unix UTC timestamp of approximately when this agent was registered

repeated Agent entries = 1

message AnswerProposalAction

payload.proto:106

Used in: SCPayload

string record_id = 1
The natural key of the Record
string receiving_agent = 2
The public key of the Agent to whom the proposal is sent
Proposal.Role role = 3
The role being proposed (owner, custodian, or reporter)
AnswerProposalAction.Response response = 4
The respose to the Proposal (accept, reject, or cancel)

enum AnswerProposalAction.Response

payload.proto:107

Used in: AnswerProposalAction

ACCEPT = 0
REJECT = 1
CANCEL = 2

Used in: BatchList

bytes header = 1
The serialized version of the BatchHeader
string header_signature = 2
The signature derived from signing the header
repeated Transaction transactions = 3
A list of the transactions that match the list of transaction_ids listed in the batch header
bool trace = 4
A debugging flag which indicates this batch should be traced through the system, resulting in a higher level of debugging output.

string signer_public_key = 1
Public key for the client that signed the BatchHeader
repeated string transaction_ids = 2
List of transaction.header_signatures that match the order of transactions required for the batch

repeated Batch batches = 1

Used in: SCPayload

string name = 1
The human-readable name of the Agent. This does not need to be unique.

Used in: SCPayload

string record_id = 1
The natural key of the Record
string receiving_agent = 2
the public key of the Agent to whom the Proposal is sent (must be different from the Agent creating the Proposal)
Proposal.Role role = 3
repeated string properties = 4

Used in: SCPayload

string record_id = 1
The natural key of the Record
string record_type = 2
The name of the RecordType this Record belongs to
repeated PropertyValue properties = 3

Used in: SCPayload

string name = 1
repeated PropertySchema properties = 2

Used in: SCPayload

string record_id = 1
The natural key of the Record

Used in: PropertyPage.ReportedValue, PropertyValue

sint64 latitude = 1
Coordinates are expected to be in millionths of a degree
sint64 longitude = 2

Used in: PropertyContainer

string name = 1
The name of the Property, e.g. "temperature". This must be unique among Properties.
string record_id = 2
The natural key of the Property's associated Record.
PropertySchema.DataType data_type = 3
The Property's type (int, string, etc.)
repeated Property.Reporter reporters = 4
The Reporters authorized to send updates, sorted by index. New Reporters should be given an index equal to the number of Reporters already authorized.
uint32 current_page = 5
The page to which new updates are added. This number represents the last 4 hex characters of the page's address. Consequently, it should not exceed 16^4 = 65536.
bool wrapped = 6
A flag indicating whether the first 16^4 pages have been filled. This is used to calculate the last four hex characters of the address of the page containing the earliest updates. When it is false, the earliest page's address will end in "0001". When it is true, the earliest page's address will be one more than the current_page, or "0001" if the current_page is "ffff".
bool fixed = 9
If set to true, values may only be set for this Property during Record creation, not later with updates.
sint32 number_exponent = 10
Used with numbers to communicate how the integer value should be converted to a fractional number. Uses the same principle as scientific notation. A number value of 1, with an exponent of 3, would be 1,000 (1 * 10^3). A number value of 1, with an exponent of -3, would be 0.001 (1 * 10^-3).
repeated string enum_options = 11
Used with ENUM data types, the string names of available options
repeated PropertySchema struct_properties = 12
Used with STRUCT data types, defines the properties a struct must contain
string unit = 20
This optional metadata describes the unit a Property is measured in

Used in: Property

string public_key = 1
The public key of the Agent authorized to report updates.
bool authorized = 2
uint32 index = 3
An update must be stored with some way of identifying which Agent sent it. Storing a full public key for each update would be wasteful, so instead Reporters are identified by their index in the `reporters` field.

repeated Property entries = 1

Used in: PropertyPageContainer

string name = 1
The name of the page's associated Property and the record_id of its associated Record. These are required to distinguish pages with colliding addresses.
string record_id = 2
repeated PropertyPage.ReportedValue reported_values = 3
ReportedValues are sorted first by timestamp, then by reporter_index

Used in: PropertyPage

uint32 reporter_index = 1
The index of the reporter id in reporters field
uint64 timestamp = 2
Approximately when this value was reported, as a Unix UTC timestamp
bytes bytes_value = 11
The type-specific value of the update. Only one of these fields should be used, and it should match the type specified for this Property in the RecordType.
bool boolean_value = 12
sint64 number_value = 13
string string_value = 14
uint32 enum_value = 15
repeated PropertyValue struct_values = 16
optional Location location_value = 17

repeated PropertyPage entries = 1

Used in: CreateRecordTypeAction, Property, RecordType

string name = 1
The name of the property, e.g. "temperature"
PropertySchema.DataType data_type = 2
The Property's type (int, string, etc.)
bool required = 3
A flag indicating whether initial values must be provided for the Property when a Record is created.
bool fixed = 4
Another flag. If set to true, values may only be set for this Property during Record creation, not later with updates.
bool delayed = 5
A flag that indicates a property may not be set at record creation, only later during subsequent property updates.
sint32 number_exponent = 10
Used with numbers to communicate how the integer value should be converted to a fractional number. Uses the same principle as scientific notation. A number value of 1, with an exponent of 3, would be 1,000 (1 * 10^3). A number value of 1, with an exponent of -3, would be 0.001 (1 * 10^-3).
repeated string enum_options = 11
Used with ENUM data types, the string names of available options
repeated PropertySchema struct_properties = 12
Used with STRUCT data types, defines the properties a struct must contain
string unit = 20
This optional metadata describes the unit a Property is measured in

Used in: Property, PropertySchema, PropertyValue

TYPE_UNSET = 0
BYTES = 1
BOOLEAN = 2
NUMBER = 3
STRING = 4
ENUM = 5
STRUCT = 6
LOCATION = 7

Used in: CreateRecordAction, PropertyPage.ReportedValue, UpdatePropertiesAction

string name = 1
The name of the property being set
PropertySchema.DataType data_type = 2
The PropertyValue's type (int, string, etc.)
bytes bytes_value = 11
The type-specific value to initialize or update a Property. Only one of these fields should be used, and it should match the type specified for this Property in the RecordType.
bool boolean_value = 12
sint64 number_value = 13
string string_value = 14
string enum_value = 15
repeated PropertyValue struct_values = 16
optional Location location_value = 17

Used in: ProposalContainer

string record_id = 1
uint64 timestamp = 2
The time at which the Proposal was created
string issuing_agent = 3
The public key of the Agent sending the Proposal. This Agent must be the owner of the Record (or the custodian, if the Proposal is to transfer custodianship).
string receiving_agent = 4
The public key of the Agent to whom the Proposal is sent.
Proposal.Role role = 5
What the Proposal is for -- transferring ownership, transferring custodianship, or authorizing a reporter.
repeated string properties = 6
The names of properties for which the reporter is being authorized (empty for owner or custodian transfers)
Proposal.Status status = 7
The status of the Proposal. For a given Record and receiving Agent, there can be only one open Proposal at a time for each role.
string terms = 8
The human-readable terms of transfer.

Used in: AnswerProposalAction, CreateProposalAction, Proposal

OWNER = 0
CUSTODIAN = 1
REPORTER = 2

Used in: Proposal

OPEN = 0
ACCEPTED = 1
REJECTED = 2
CANCELED = 3

repeated Proposal entries = 1

Used in: RecordContainer

string record_id = 1
The user-defined natural key which identifies the object in the real world (for example a serial number)
string record_type = 2
repeated Record.AssociatedAgent owners = 3
Ordered oldest to newest by timestamp
repeated Record.AssociatedAgent custodians = 4
bool final = 5
Flag indicating whether the Record can be updated. If it is set to true, then the record has been finalized and no further changes can be made to it or its Properties.

Used in: Record

string agent_id = 1
uint64 timestamp = 2

repeated Record entries = 1

Used in: RecordTypeContainer

string name = 1
A unique human-readable designation for the RecordType
repeated PropertySchema properties = 2

repeated RecordType entries = 1

Used in: SCPayload

string record_id = 1
The natural key of the Record
string reporter_id = 2
The reporter's public key
repeated string properties = 3
The names of the Properties for which the reporter's authorization is revoked

SCPayload.Action action = 1
uint64 timestamp = 2
Approximately when transaction was submitted, as a Unix UTC timestamp
optional CreateAgentAction create_agent = 3
The transaction handler will read from just one of these fields according to the Action.
optional CreateRecordAction create_record = 4
optional FinalizeRecordAction finalize_record = 5
optional CreateRecordTypeAction create_record_type = 6
optional UpdatePropertiesAction update_properties = 7
optional CreateProposalAction create_proposal = 8
optional AnswerProposalAction answer_proposal = 9
optional RevokeReporterAction revoke_reporter = 10

Used in: SCPayload

CREATE_AGENT = 0
CREATE_RECORD = 1
FINALIZE_RECORD = 2
CREATE_RECORD_TYPE = 3
UPDATE_PROPERTIES = 4
CREATE_PROPOSAL = 5
ANSWER_PROPOSAL = 6
REVOKE_REPORTER = 7

Used in: Batch, TransactionList

bytes header = 1
The serialized version of the TransactionHeader
string header_signature = 2
The signature derived from signing the header
bytes payload = 3
The payload is the encoded family specific information of the transaction. Example cbor({'Verb': verb, 'Name': name,'Value': value})

string batcher_public_key = 1
Public key for the client who added this transaction to a batch
repeated string dependencies = 2
A list of transaction signatures that describe the transactions that must be processed before this transaction can be valid
string family_name = 3
The family name correlates to the transaction processor's family name that this transaction can be processed on, for example 'intkey'
string family_version = 4
The family version correlates to the transaction processor's family version that this transaction can be processed on, for example "1.0"
repeated string inputs = 5
A list of addresses that are given to the context manager and control what addresses the transaction processor is allowed to read from.
string nonce = 6
A random string that provides uniqueness for transactions with otherwise identical fields.
repeated string outputs = 7
A list of addresses that are given to the context manager and control what addresses the transaction processor is allowed to write to.
string payload_sha512 = 9
The sha512 hash of the encoded payload
string signer_public_key = 10
Public key for the client that signed the TransactionHeader

A simple list of transactions that needs to be serialized before it can be transmitted to a batcher.

repeated Transaction transactions = 1

Used in: SCPayload

string record_id = 1
The natural key of the Record
repeated PropertyValue properties = 2

Default package

message Agent

string public_key = 1

string name = 2

uint64 timestamp = 3

message AgentContainer

repeated Agent entries = 1

message AnswerProposalAction

string record_id = 1

string receiving_agent = 2

Proposal.Role role = 3

AnswerProposalAction.Response response = 4

enum AnswerProposalAction.Response

ACCEPT = 0

REJECT = 1

CANCEL = 2

message Batch

bytes header = 1

string header_signature = 2

repeated Transaction transactions = 3

bool trace = 4

message BatchHeader

string signer_public_key = 1

repeated string transaction_ids = 2

message BatchList

repeated Batch batches = 1

message CreateAgentAction

string name = 1

message CreateProposalAction

string record_id = 1

string receiving_agent = 2

Proposal.Role role = 3

repeated string properties = 4

message CreateRecordAction

string record_id = 1

string record_type = 2

repeated PropertyValue properties = 3

message CreateRecordTypeAction

string name = 1

repeated PropertySchema properties = 2

message FinalizeRecordAction

string record_id = 1

message Location

sint64 latitude = 1

sint64 longitude = 2

message Property

string name = 1

string record_id = 2

PropertySchema.DataType data_type = 3

repeated Property.Reporter reporters = 4

uint32 current_page = 5

bool wrapped = 6

bool fixed = 9

sint32 number_exponent = 10

repeated string enum_options = 11

repeated PropertySchema struct_properties = 12

string unit = 20

message Property.Reporter

string public_key = 1

bool authorized = 2

uint32 index = 3

message PropertyContainer

repeated Property entries = 1

message PropertyPage

string name = 1

string record_id = 2

repeated PropertyPage.ReportedValue reported_values = 3

message PropertyPage.ReportedValue

uint32 reporter_index = 1

uint64 timestamp = 2

bytes bytes_value = 11

bool boolean_value = 12

sint64 number_value = 13

string string_value = 14

uint32 enum_value = 15

repeated PropertyValue struct_values = 16

optional Location location_value = 17

message PropertyPageContainer

repeated PropertyPage entries = 1

message PropertySchema