scala-did-docs
API
Generated with
scala-did-docs/proto.prism

proto.prism

package proto.prism

Members list

Type members

Classlikes

final case class AddKeyAction(key: Option[PublicKey], unknownFields: UnknownFieldSet) extends GeneratedMessage

The necessary data to add a key to a DID.

The necessary data to add a key to a DID.

Value parameters

key

The key to include.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AddKeyAction extends GeneratedMessageCompanion[AddKeyAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AddKeyAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class AddServiceAction(service: Option[Service], unknownFields: UnknownFieldSet) extends GeneratedMessage

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AddServiceAction extends GeneratedMessageCompanion[AddServiceAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AddServiceAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class BitstringStatusList(bytes: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

This is implementation of https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslist

  • BitstringStatusList is used for JWT VC ______ LINK!

This is implementation of https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslist

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BitstringStatusList extends GeneratedMessageCompanion[BitstringStatusList]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[BitstringStatusList]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CompressedECKeyData(curve: String, data: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

Holds the compressed representation of data needed to recover Elliptic Curve (EC)'s public key.

Holds the compressed representation of data needed to recover Elliptic Curve (EC)'s public key.

Value parameters

curve

The curve name, like secp256k1.

data

compressed Elliptic Curve (EC) public key data.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CompressedECKeyData extends GeneratedMessageCompanion[CompressedECKeyData]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CompressedECKeyData]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateDIDOperation(didData: Option[DIDCreationData], unknownFields: UnknownFieldSet) extends GeneratedMessage

The operation to create a public DID.

The operation to create a public DID.

Value parameters

didData

DIDCreationData with public keys and services

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateDIDOperation extends GeneratedMessageCompanion[CreateDIDOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateDIDOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateStorageEntryOperation(didPrismHash: ByteString, data: Data, unknownFields: UnknownFieldSet) extends GeneratedMessage
  • StorageEventCreateEntry To be valid, this operation needs to be signed by an issuing key of the DID:
    1. The issuing key need to be valid at the Operation momment
    1. The DID needs not to be Deactivate

Value parameters

didPrismHash

The specificId of the did:prism.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateStorageEntryOperation extends GeneratedMessageCompanion[CreateStorageEntryOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateStorageEntryOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CredentialBatchData(issuerDid: String, merkleRoot: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

Check the protocol docs to understand it.

Check the protocol docs to understand it.

Value parameters

issuerDid

The DID suffix that issues the credential's batch.

merkleRoot

The Merkle root for the credential's batch.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CredentialBatchData extends GeneratedMessageCompanion[CredentialBatchData]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CredentialBatchData]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DeactivateDIDOperation(previousOperationHash: ByteString, id: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Value parameters

id

DID Suffix of the DID to be deactivated

previousOperationHash

The hash of the most recent operation that was used to create or update the DID.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeactivateDIDOperation extends GeneratedMessageCompanion[DeactivateDIDOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeactivateDIDOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ECKeyData(curve: String, x: ByteString, y: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

Holds the necessary data to recover an Elliptic Curve (EC)'s public key.

Holds the necessary data to recover an Elliptic Curve (EC)'s public key.

Value parameters

curve

The curve name, like secp256k1.

x

The x coordinate, represented as bytes.

y

The y coordinate, represented as bytes.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ECKeyData extends GeneratedMessageCompanion[ECKeyData]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ECKeyData]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
ECKeyData.type
final case class IssueCredentialBatchOperation(credentialBatchData: Option[CredentialBatchData], unknownFields: UnknownFieldSet) extends GeneratedMessage

Represents a credential's batch. Specifies the data to issue a credential batch.

Represents a credential's batch. Specifies the data to issue a credential batch.

Value parameters

credentialBatchData

The actual credential batch data.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IssueCredentialBatchOperation extends GeneratedMessageCompanion[IssueCredentialBatchOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[IssueCredentialBatchOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class KeyUsage(val value: Int) extends GeneratedEnum

Every key has a single purpose:

Every key has a single purpose:

Attributes

Companion
object
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ISSUING_KEY
object MASTER_KEY
trait Recognized
object UNKNOWN_KEY
object VDR_KEY
class Unrecognized
Show all
object KeyUsage extends GeneratedEnumCompanion[KeyUsage]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[KeyUsage]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
KeyUsage.type
final case class PatchContextAction(context: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage

Value parameters

context

The list of strings to use by resolvers during resolution when producing a JSON-LD output

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PatchContextAction extends GeneratedMessageCompanion[PatchContextAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PatchContextAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PrismBlock(operations: Seq[SignedPrismOperation], unknownFields: UnknownFieldSet) extends GeneratedMessage

Represent a block that holds operations.

Represent a block that holds operations.

Value parameters

operations

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

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PrismBlock extends GeneratedMessageCompanion[PrismBlock]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PrismBlock]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
PrismBlock.type
object PrismCredentialBatchProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class PrismObject(blockContent: Option[PrismBlock], unknownFields: UnknownFieldSet) extends GeneratedMessage

Wraps an PrismBlock and its metadata.

Wraps an PrismBlock and its metadata.

Value parameters

blockContent

The block content.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PrismObject extends GeneratedMessageCompanion[PrismObject]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PrismObject]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PrismOperation(operation: Operation, unknownFields: UnknownFieldSet) extends GeneratedMessage

The possible operations affecting the blockchain.

The possible operations affecting the blockchain.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PrismOperation extends GeneratedMessageCompanion[PrismOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PrismOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object PrismProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
PrismProto.type
object PrismSsiProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
object PrismStorageProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
object PrismVersionProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ProtocolVersion(majorVersion: Int, minorVersion: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage

Value parameters

majorVersion

Represent the major version

minorVersion

Represent the minor version

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProtocolVersion extends GeneratedMessageCompanion[ProtocolVersion]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProtocolVersion]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ProtocolVersionInfo(versionName: String, effectiveSince: Int, protocolVersion: Option[ProtocolVersion], unknownFields: UnknownFieldSet) extends GeneratedMessage

Value parameters

effectiveSince

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

protocolVersion

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

versionName

(optional) name of the version

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProtocolVersionInfo extends GeneratedMessageCompanion[ProtocolVersionInfo]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProtocolVersionInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ProtocolVersionUpdateOperation(proposerDid: String, version: Option[ProtocolVersionInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage

Specifies the protocol version update

Specifies the protocol version update

Value parameters

proposerDid

The DID suffix that proposes the protocol update.

version

Information of the new version

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProtocolVersionUpdateOperation extends GeneratedMessageCompanion[ProtocolVersionUpdateOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProtocolVersionUpdateOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PublicKey(id: String, usage: KeyUsage, keyData: KeyData, unknownFields: UnknownFieldSet) extends GeneratedMessage

Represents a public key with metadata, necessary for a DID document.

Represents a public key with metadata, necessary for a DID document.

Value parameters

id

The key identifier within the DID Document.

usage

The key's purpose.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PublicKey extends GeneratedMessageCompanion[PublicKey]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PublicKey]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
PublicKey.type
final case class RemoveKeyAction(keyId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

The necessary data to remove a key from a DID.

The necessary data to remove a key from a DID.

Value parameters

keyId

the key id to remove

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RemoveKeyAction extends GeneratedMessageCompanion[RemoveKeyAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RemoveKeyAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RemoveServiceAction(serviceId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RemoveServiceAction extends GeneratedMessageCompanion[RemoveServiceAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RemoveServiceAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RevokeCredentialsOperation(previousOperationHash: ByteString, credentialBatchId: String, credentialsToRevoke: Seq[ByteString], unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Value parameters

credentialBatchId

The corresponding batch ID, as returned in IssueCredentialBatchResponse.

credentialsToRevoke

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

previousOperationHash

The hash of the operation that issued the batch.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RevokeCredentialsOperation extends GeneratedMessageCompanion[RevokeCredentialsOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RevokeCredentialsOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Service(id: String, `type`: String, serviceEndpoint: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Service extends GeneratedMessageCompanion[Service]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Service]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Service.type
final case class SignedPrismOperation(signedWith: String, signature: ByteString, operation: Option[PrismOperation], unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Value parameters

operation

The operation that was signed.

signature

The actual signature.

signedWith

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

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SignedPrismOperation extends GeneratedMessageCompanion[SignedPrismOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SignedPrismOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TokenStatusList(listSize: Int, statusSize: Int, intStatus: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

This is implementation of https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslist

  • TokenStatusList is used for JWT VC ______ LINK!

This is implementation of https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslist

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TokenStatusList extends GeneratedMessageCompanion[TokenStatusList]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TokenStatusList]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateDIDAction(action: Action, unknownFields: UnknownFieldSet) extends GeneratedMessage

The potential details that can be updated in a DID.

The potential details that can be updated in a DID.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateDIDAction extends GeneratedMessageCompanion[UpdateDIDAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateDIDAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateDIDOperation(previousOperationHash: ByteString, id: String, actions: Seq[UpdateDIDAction], unknownFields: UnknownFieldSet) extends GeneratedMessage

Specifies the necessary data to update a public DID.

Specifies the necessary data to update a public DID.

Value parameters

actions

The actual updates to perform on the DID.

id

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

previousOperationHash

The hash of the most recent operation that was used to create or update the DID.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateDIDOperation extends GeneratedMessageCompanion[UpdateDIDOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateDIDOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateServiceAction(serviceId: String, `type`: String, serviceEndpoints: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Value parameters

serviceId

scoped to the did, unique per did

type

new type if provided

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateServiceAction extends GeneratedMessageCompanion[UpdateServiceAction]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateServiceAction]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateStorageEntryOperation(previousOperationHash: ByteString, data: Data, unknownFields: UnknownFieldSet) extends GeneratedMessage
  • StorageEventUpdateEntry To be valid, this operation needs to be signed by an issuing key of the DID:
    1. The issuing key need to be valid at the Operation momment
    1. The DID needs not to be Deactivate

Value parameters

previousOperationHash

The hash of the most recent operation that was used to create or update the VDR Entry.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateStorageEntryOperation extends GeneratedMessageCompanion[UpdateStorageEntryOperation]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateStorageEntryOperation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with