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

proto.prism.node

package proto.prism.node

Members list

Type members

Classlikes

final case class BlockInfo(number: Int, index: Int, timestamp: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Value parameters

index

Index of the transaction within the block.

number

Number of the block in the ledger.

timestamp

Timestamp when the block was created.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[BlockInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
BlockInfo.type
final case class CreateDIDOutput(didSuffix: 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 CreateDIDOutput extends GeneratedMessageCompanion[CreateDIDOutput]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateDIDOutput]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DIDData(id: String, publicKeys: Seq[PublicKey], services: Seq[Service], context: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage

The DID Document's data.

The DID Document's data.

Value parameters

context

The list of @context values to consider on JSON-LD representations

id

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

publicKeys

The keys that belong to this DID Document.

services

The list of services that belong to this DID Document.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DIDData]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
DIDData.type
final case class DeactivateDIDOutput(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 DeactivateDIDOutput extends GeneratedMessageCompanion[DeactivateDIDOutput]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeactivateDIDOutput]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class EventOutput(result: Result, eventMaybe: EventMaybe, unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Attributes

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

Attributes

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

The status of an Atala event.

The status of an Atala event.

Attributes

Companion
object
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Recognized
object UNKNOWN_EVENT
class Unrecognized
Show all
object EventStatus extends GeneratedEnumCompanion[EventStatus]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[EventStatus]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetDidDocumentRequest(did: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Request to find a DID Document. See NodeService.GetDidDocument for more information.

Request to find a DID Document. See NodeService.GetDidDocument for more information.

Value parameters

did

The DID.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetDidDocumentRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetDidDocumentResponse(document: Option[DIDData], lastSyncedBlockTimestamp: Option[Timestamp], lastUpdateEvent: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage

Response to a DID Document query. See NodeService.GetDidDocument for more information.

Response to a DID Document query. See NodeService.GetDidDocument for more information.

Value parameters

document

The DID Document.

lastSyncedBlockTimestamp

Timestamp of the latest synchronized block.

lastUpdateEvent

The hash of the last did update event.

Attributes

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

Attributes

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

Request to get the event status. See NodeService.GetEventInfo for more information.

Request to get the event status. See NodeService.GetEventInfo for more information.

Value parameters

eventId

Event identifier. The identifier is returned to the corresponding event request.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetEventInfoRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetEventInfoResponse(eventStatus: EventStatus, transactionId: String, lastSyncedBlockTimestamp: Option[Timestamp], details: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Response with the current event status. See NodeService.GetEventInfo for more information.

Response with the current event status. See NodeService.GetEventInfo for more information.

Value parameters

details

Contains additional information about the event state. For example, error descriptions. Can be empty.

eventStatus

Contains the status of this event.

lastSyncedBlockTimestamp

Timestamp of the latest synchronized block.

transactionId

Transaction identifier containing the event. Presented only when event was approved by the ledger.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetEventInfoResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetLastSyncedBlockTimestampRequest(unknownFields: UnknownFieldSet) extends GeneratedMessage

Request to retrieve the timestamp of the latest synchronized (processed by PRISM Node) block. See NodeService.GetLastSyncedBlockTimestampRequest for more information.

Request to retrieve the timestamp of the latest synchronized (processed by PRISM Node) block. See NodeService.GetLastSyncedBlockTimestampRequest for more information.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetLastSyncedBlockTimestampRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetLastSyncedBlockTimestampResponse(lastSyncedBlockTimestamp: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage

Response with the timestamp of the latest synchronized (processed by PRISM Node) block. See NodeService.GetLastSyncedBlockTimestampResponse for more information.

Response with the timestamp of the latest synchronized (processed by PRISM Node) block. See NodeService.GetLastSyncedBlockTimestampResponse for more information.

Value parameters

lastSyncedBlockTimestamp

Timestamp of the latest synchronized (processed by PRISM Node) block.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetLastSyncedBlockTimestampResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetNodeBuildInfoRequest(unknownFields: UnknownFieldSet) extends GeneratedMessage

Request to get the Node version info. See NodeService.GetNodeBuildInfo for more information.

Request to get the Node version info. See NodeService.GetNodeBuildInfo for more information.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetNodeBuildInfoRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetNodeBuildInfoResponse(version: String, scalaVersion: String, sbtVersion: String, unknownFields: UnknownFieldSet) extends GeneratedMessage

Response with the Node version info. See NodeService.GetNodeBuildInfo for more information.

Response with the Node version info. See NodeService.GetNodeBuildInfo for more information.

Value parameters

sbtVersion

The SBT version used to compile the app.

scalaVersion

The Scala version used to compile the app.

version

The actual version.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetNodeBuildInfoResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetNodeNetworkProtocolInfoRequest(unknownFields: UnknownFieldSet) extends GeneratedMessage

Request to get the Node version info. See NodeService.GetNodeBuildInfo for more information.

Request to get the Node version info. See NodeService.GetNodeBuildInfo for more information.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetNodeNetworkProtocolInfoRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetNodeNetworkProtocolInfoResponse(supportedNetworkProtocolVersion: Option[ProtocolVersion], currentNetworkProtocolVersion: Option[ProtocolVersion], unknownFields: UnknownFieldSet) extends GeneratedMessage

Response with the Node Protocol version info. See NodeService.GetNodeProtocolVersionInfo for more information.

Response with the Node Protocol version info. See NodeService.GetNodeProtocolVersionInfo for more information.

Value parameters

currentNetworkProtocolVersion

Current network protocol version number.

supportedNetworkProtocolVersion

Network protocol version number supported by Node.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetNodeNetworkProtocolInfoResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class HealthCheckRequest(unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[HealthCheckRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class HealthCheckResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage

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.

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.

Attributes

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

Attributes

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

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

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

Attributes

Companion
object
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object IN_MEMORY
trait Recognized
class Unrecognized
Show all
object Ledger extends GeneratedEnumCompanion[Ledger]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[Ledger]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Ledger.type
object NodeServiceGrpc

Attributes

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

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ProtocolVersionUpdateOutput(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 ProtocolVersionUpdateOutput extends GeneratedMessageCompanion[ProtocolVersionUpdateOutput]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProtocolVersionUpdateOutput]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ScheduleEventsRequest(signedEvents: Seq[SignedPrismEvent], unknownFields: UnknownFieldSet) extends GeneratedMessage

Request to retrieve transaction info and events outputs.

Request to retrieve transaction info and events outputs.

Value parameters

signedEvents

List of signed events to apply. The events will be applied in the order specified here. a list of signed events

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ScheduleEventsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ScheduleEventsResponse(outputs: Seq[EventOutput], unknownFields: UnknownFieldSet) extends GeneratedMessage

Response with the transaction info and events outputs.

Response with the transaction info and events outputs.

Value parameters

outputs

The responses for scheduled events, ordered the same as the events sent in ScheduleEventsRequest.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ScheduleEventsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TransactionInfo(transactionId: String, ledger: Ledger, block: Option[BlockInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage

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

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

Value parameters

block

Block the transaction was included in.

ledger

Ledger the transaction was published to.

transactionId

Transaction ID.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransactionInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateDIDOutput(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 UpdateDIDOutput extends GeneratedMessageCompanion[UpdateDIDOutput]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateDIDOutput]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ZioPrismNodeApi

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Generated with