package io.iohk.atala.prism.protos

Get desktop application:
View/edit binary Protocol Buffers messages

The necessary data to add a key to a DID.

Used in: UpdateDIDAction

• optional PublicKey key = 1

  The key to include.

Used in: UpdateDIDAction

• optional Service service = 1

Used in: AtalaObject

• repeated SignedAtalaOperation operations = 2

  A signed operation, necessary to post anything on the blockchain.

• optional AtalaBlock block_content = 4

  The block content.

The possible operations affecting the blockchain.

Used in: SignedAtalaOperation

• oneof operation

  The actual operation.

  • CreateDIDOperation create_did = 1

    Used to create a public DID.

  • UpdateDIDOperation update_did = 2

    Used to update an existing public DID.

  • IssueCredentialBatchOperation issue_credential_batch = 3

    Used to issue a batch of credentials.

  • RevokeCredentialsOperation revoke_credentials = 4

    Used to revoke a credential batch.

  • ProtocolVersionUpdateOperation protocol_version_update = 5

    Used to announce new protocol update

  • DeactivateDIDOperation deactivate_did = 6

    Used to deactivate DID

* Information about a ledger block. See Ledger documentation for details on which ledgers are possible.

Used in: TransactionInfo

• int32 number = 1

  Number of the block in the ledger.

• int32 index = 3

  Index of the transaction within the block.

• optional google.protobuf.Timestamp timestamp = 4

  Timestamp when the block was created.

* Holds the compressed representation of data needed to recover Elliptic Curve (EC)'s public key. @exclude TODO: Consider renaming this to CompressedECPublicKeyData.

Used in: PublicKey

• string curve = 1

  The curve name, like secp256k1.

• bytes data = 2

  compressed Elliptic Curve (EC) public key data.

The operation to create a public DID.

Used in: AtalaOperation

• optional CreateDIDOperation.DIDCreationData did_data = 1

  DIDCreationData with public keys and services

The data necessary to create a DID.

Used in: CreateDIDOperation

• repeated PublicKey public_keys = 2

  The keys that belong to this DID Document.

• repeated Service services = 3

  The list of services that belong to this DID Document.

Used in: OperationOutput

• string did_suffix = 1

Represents a credential's batch. Check the protocol docs to understand it.

Used in: IssueCredentialBatchOperation

• string issuer_did = 1

  The DID suffix that issues the credential's batch.

• bytes merkle_root = 2

  The Merkle root for the credential's batch.

The DID Document's data.

• string id = 1

  The DID suffix, where DID is in form did:prism:[DID suffix]

• repeated PublicKey public_keys = 2

  The keys that belong to this DID Document.

• repeated Service services = 3

  The list of services that belong to this DID Document.

* Represents a date by its parts (day, month, year).

• int32 year = 1

  A positive value.

• int32 month = 2

  A value in the [1, 12] range.

• int32 day = 3

  A value in the [1, 31] range (depending on the month, the maximum value might be 28).

Used in: AtalaOperation

• bytes previous_operation_hash = 1

  The hash of the operation that issued the DID.

• string id = 2

  DID Suffix of the DID to be deactivated

Used in: OperationOutput

(message has no fields)

* Holds the necessary data to recover an Elliptic Curve (EC)'s public key. @exclude TODO: Consider renaming this to ECPublicKeyData.

Used in: PublicKey

• string curve = 1

  The curve name, like secp256k1.

• bytes x = 2

  The x coordinate, represented as bytes.

• bytes y = 3

  The y coordinate, represented as bytes.

* A request that can be used to check service health. All PRISM services expose an RPC that accepts this message as request.

(message has no fields)

* A response that represents service health. Status code 0 with empty response represents a healthy and reachable service, while all other status codes represent issues with the service.

(message has no fields)

Specifies the data to issue a credential batch.

Used in: AtalaOperation

• optional CredentialBatchData credential_batch_data = 1

  The actual credential batch data.

Used in: OperationOutput

• string batch_id = 1

Every key has a single purpose:

Used in: PublicKey

• UNKNOWN_KEY = 0

  UNKNOWN_KEY is an invalid value - Protobuf uses 0 if no value is provided and we want the user to explicitly choose the usage.

• MASTER_KEY = 1

  This is the most privileged key-type, when any other key is lost, you could use this to recover the others.

• ISSUING_KEY = 2

  This key-type is used for issuing credentials only, it should be kept in a safe place to avoid malicious credentials being issued.

• KEY_AGREEMENT_KEY = 3

  This key-type is used to establish a shared symmetric key for secure end-to end communication use this key-type to encrypt the content.

• AUTHENTICATION_KEY = 4

  This key-type is used to authenticate requests or logging into services.

• REVOCATION_KEY = 5

  This key-type is used for revoking credentials only, it should be kept in a safe place to avoid malicious credentials being issued.

• CAPABILITY_INVOCATION_KEY = 6

  This key-type is used to specify a verification method that might be used by the DID subject to invoke a cryptographic capability, such as the authorization to update the DID Document.

• CAPABILITY_DELEGATION_KEY = 7

  This is used to specify a mechanism that might be used by the DID subject to delegate a cryptographic capability to another party, such as delegating the authority to access a specific HTTP API to a subordinate.

* The supported ledger types. Specifies which chain is used for storing transactions.

Used in: LedgerData, TransactionInfo

• UNKNOWN_LEDGER = 0

  Invalid default value.

• IN_MEMORY = 1

  Store transactions in memory instead of blockchain, used only for development.

• CARDANO_TESTNET = 4

  Cardano testnet, used for testing.

• CARDANO_MAINNET = 5

  Cardano mainnet, used in production.

Ledger data associated to a protocol event. Note that the difference with TransactionInfo is that this message contains a full timestamp, and there is no expectation for it to be optional.

Used in: PublicKey, Service

• string transaction_id = 1

  ID of the transaction.

• Ledger ledger = 2

  Ledger the transaction was published to.

• optional TimestampInfo timestamp_info = 3

  The timestamp of the protocol event.

Used to encode the responses of the operations issued in an AtalaBlock.

• oneof result

  • IssueCredentialBatchOutput batch_output = 1

    Represents the response provided by IssueCredentialBatchOperation.

  • CreateDIDOutput create_did_output = 2

    Represents the response provided by CreateDIDOperation.

  • UpdateDIDOutput update_did_output = 3

    Represents the response provided by UpdateDIDOperation.

  • RevokeCredentialsOutput revoke_credentials_output = 4

    Represents the response provided by RevokeCredentialOperation.

  • ProtocolVersionUpdateOutput protocol_version_update_output = 7

    Represents the response provided by ProtocolVersionUpdateOperation.

  • DeactivateDIDOutput deactivate_did_output = 8

• oneof operation_maybe

  • bytes operation_id = 5

    Operation identifier.

  • string error = 6

    Error description if PRISM Node service haven't scheduled the operation.

* The status of an Atala operation.

• UNKNOWN_OPERATION = 0

  The operation hasn't been received by the node service yet.

• PENDING_SUBMISSION = 1

  The transaction containing this operation hasn't been published to the chain yet.

• AWAIT_CONFIRMATION = 2

  The transaction containing this operation has been published to the chain, but hasn't been processed by PRISM yet.

• CONFIRMED_AND_APPLIED = 3

  The operation has been successfully applied to the PRISM.

• CONFIRMED_AND_REJECTED = 4

  The operation has been processed by PRISM, but rejected because of some error.

Used in: ProtocolVersionInfo

• int32 major_version = 1

  Represent the major version

• int32 minor_version = 2

  Represent the minor version

Used in: ProtocolVersionUpdateOperation

• string version_name = 1

  (optional) name of the version

• int32 effective_since = 4

  Cardano block number that tells since which block the update is enforced

• optional ProtocolVersion protocol_version = 5

  New major and minor version to be announced, If major value changes, the node MUST stop issuing and reading operations, and upgrade before `effective_since` because the new protocol version. If minor value changes, the node can opt to not update. All events _published_ by this node would be also understood by other nodes with the same major version. However, there may be new events that this node won't _read_

Specifies the protocol version update

Used in: AtalaOperation

• string proposer_did = 1

  The DID suffix that proposes the protocol update.

• optional ProtocolVersionInfo version = 2

  Information of the new version

Used in: OperationOutput

(message has no fields)

* Represents a public key with metadata, necessary for a DID document. @exclude TODO: Consider renaming this to something more specific, like DIDPublicKey.

Used in: AddKeyAction, CreateDIDOperation.DIDCreationData, DIDData

• string id = 1

  The key identifier within the DID Document.

• KeyUsage usage = 2

  The key's purpose.

• optional LedgerData added_on = 5

  The ledger details related to the event that added the key to the DID Document.

• optional LedgerData revoked_on = 6

  The ledger details related to the event that revoked the key to the DID Document.

• oneof key_data

  The key's representation.

  • ECKeyData ec_key_data = 8

    The Elliptic Curve (EC) key.

  • CompressedECKeyData compressed_ec_key_data = 9

    Compressed Elliptic Curve (EC) key.

The necessary data to remove a key from a DID.

Used in: UpdateDIDAction

• string keyId = 1

  the key id to remove

Used in: UpdateDIDAction

• string serviceId = 1

Specifies the credentials to revoke (the whole batch, or just a subset of it).

Used in: AtalaOperation

• bytes previous_operation_hash = 1

  The hash of the operation that issued the batch.

• string credential_batch_id = 2

  The corresponding batch ID, as returned in IssueCredentialBatchResponse.

• repeated bytes credentials_to_revoke = 3

  The hashes of the credentials to revoke. If empty, the full batch is revoked.

Used in: OperationOutput

(message has no fields)

Used in: AddServiceAction, CreateDIDOperation.DIDCreationData, DIDData

• string id = 1

• string type = 2

• repeated string service_endpoint = 3

• optional LedgerData added_on = 4

  (when present) The ledger details related to the event that added the service.

• optional LedgerData deleted_on = 5

  (when present) The ledger details related to the event that revoked the service.

A signed operation, necessary to post anything on the blockchain.

Used in: AtalaBlock

• string signed_with = 1

  The key ID used to sign the operation, it must belong to the DID that signs the operation.

• bytes signature = 2

  The actual signature.

• optional AtalaOperation operation = 3

  The operation that was signed.

* This enum provides a way for some RPC requests to specify the direction so that the response values are sorted the way you want them to. Note that it specifies the direction only and doesn't say anything about a comparator (e.g. natural order, some RPC-specific order etc).

• SORT_BY_DIRECTION_UNKNOWN = 0

  Nothing provided, each API can define whether to fail or take a default value (commonly ASCENDING).

• SORT_BY_DIRECTION_ASCENDING = 1

  Sort the results in ascending order.

• SORT_BY_DIRECTION_DESCENDING = 2

  Sort the results in descending order.

* Represents a time interval between two given timestamps. The message represents a closed interval (i.e. both ends are inclusive and mandatory).

• optional google.protobuf.Timestamp start_timestamp = 1

  * The starting timestamp. start_timestamp must be before or equal to end_timestamp.

• optional google.protobuf.Timestamp end_timestamp = 2

  * The ending timestamp. end_timestamp must be after or equal to start_timestamp.

Includes timestamping details about a blockchain's block.

Used in: LedgerData

• uint32 block_sequence_number = 2

  The transaction index inside the underlying block.

• uint32 operation_sequence_number = 3

  The operation index inside the AtalaBlock.

• optional google.protobuf.Timestamp block_timestamp = 4

  The timestamp provided from the underlying blockchain.

* Information about a ledger transaction and the block that the transaction is included in.

• string transaction_id = 1

  Transaction ID.

• Ledger ledger = 2

  Ledger the transaction was published to.

• optional BlockInfo block = 3

  Block the transaction was included in.

The potential details that can be updated in a DID.

Used in: UpdateDIDOperation

• oneof action

  The action to perform.

  • AddKeyAction add_key = 1

    Used to add a new key to the DID.

  • RemoveKeyAction remove_key = 2

    Used to remove a key from the DID.

  • AddServiceAction add_service = 3

    Used to add a new service to a DID,

  • RemoveServiceAction remove_service = 4

    Used to remove an existing service from a DID,

  • UpdateServiceAction update_service = 5

    Used to Update a list of service endpoints of a given service on a given DID.

Specifies the necessary data to update a public DID.

Used in: AtalaOperation

• bytes previous_operation_hash = 1

  The hash of the operation that issued the DID.

• string id = 2

  @exclude TODO: To be redefined after we start using this operation.

• repeated UpdateDIDAction actions = 3

  The actual updates to perform on the DID.

Used in: OperationOutput

(message has no fields)

Used in: UpdateDIDAction

• string serviceId = 1

  scoped to the did, unique per did

• string type = 2

  new type if provided

• repeated string service_endpoints = 3

  Will replace all existing service endpoints of the service with provided ones