Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArchivedEvent

Records that a contract has been archived, and choices may no longer be exercised on it.

Example:

{
    eventType: 'archived',
    contractId: 'my-contract-id',
    eventId: 'my-event-id',
    templateId: {
        packageId: 'my-package-id',
        moduleName: 'SomeModule',
        entityName: 'SomeTemplate'
    },
    witnessParties: [ 'Alice', 'Bob' ]
}

To express values in a more concise way, you can have a look at the ValueHelpers.

see

Identifier

Hierarchy

  • ArchivedEvent

Index

Properties

contractId

contractId: string

The identifier of the archived contract.

eventId

eventId: string

The identifier of this particular event.

eventType

eventType: "archived"

A fixed type tag to identify this as an archived event.

templateId

templateId: Identifier

The template of the archived contract.

witnessParties

witnessParties: string[]

The parties that are notified of this event. For archived events, these are the intersection of the stakeholders of the contract in question and the parties specified in the TransactionFilter. The stakeholders are the union of the signatories and the observers of the contract.

Generated using TypeDoc