cantonjs 0.0.1

package/src/types/reassignment.ts

@@ -0,0 +1,68 @@
+/**
+ * Canton reassignment types.
+ *
+ * Reassignments transfer contracts between synchronizers (domains).
+ * A reassignment consists of an unassign from the source synchronizer
+ * followed by an assign to the target synchronizer.
+ */
+
+import type { CreatedEvent } from './contract.js'
+
+/** A reassignment event from the update stream. */
+export type Reassignment = {
+  readonly updateId: string
+  readonly commandId?: string
+  readonly workflowId?: string
+  readonly offset: number
+  readonly events: readonly ReassignmentEvent[]
+  readonly traceContext?: Record<string, string>
+  readonly recordTime: string
+}
+
+/** Tagged reassignment event: either an assign or unassign. */
+export type ReassignmentEvent =
+  | { readonly AssignedEvent: AssignedEvent }
+  | { readonly UnassignedEvent: UnassignedEvent }
+
+/** Contract assigned to a target synchronizer. */
+export type AssignedEvent = {
+  readonly source: string
+  readonly target: string
+  readonly unassignId: string
+  readonly submitter: string
+  readonly reassignmentCounter: number
+  readonly createdEvent: CreatedEvent
+}
+
+/** Contract unassigned from a source synchronizer. */
+export type UnassignedEvent = {
+  readonly unassignId: string
+  readonly contractId: string
+  readonly templateId: string
+  readonly packageName: string
+  readonly source: string
+  readonly target: string
+  readonly submitter: string
+  readonly reassignmentCounter: number
+  readonly assignmentExclusivity?: string
+  readonly witnessParties: readonly string[]
+}
+
+/** Reassignment command for submitting a contract transfer. */
+export type ReassignmentCommand =
+  | { readonly UnassignCommand: UnassignCommand }
+  | { readonly AssignCommand: AssignCommand }
+
+/** Command to unassign a contract from its current synchronizer. */
+export type UnassignCommand = {
+  readonly contractId: string
+  readonly source: string
+  readonly target: string
+}
+
+/** Command to assign a previously unassigned contract to a target synchronizer. */
+export type AssignCommand = {
+  readonly unassignId: string
+  readonly source: string
+  readonly target: string
+}

package/src/types/transaction.ts

@@ -0,0 +1,57 @@
+/**
+ * Canton transaction and update types.
+ *
+ * Updates are the primary way to observe ledger changes. They use tagged
+ * discriminated unions on the wire:
+ *   { "Transaction": { "value": JsTransaction } }
+ *   | { "Reassignment": Reassignment }
+ *   | { "OffsetCheckpoint": { "value": OffsetCheckpoint } }
+ *   | { "TopologyTransaction": TopologyTransaction }
+ */
+
+import type { TaggedEvent } from './contract.js'
+import type { EventFormat } from './command.js'
+import type { Reassignment } from './reassignment.js'
+
+/** A transaction from the ledger (wire format). */
+export type JsTransaction = {
+  readonly updateId: string
+  readonly commandId?: string
+  readonly workflowId?: string
+  readonly effectiveAt: string
+  readonly events: readonly TaggedEvent[]
+  readonly offset: number
+  readonly synchronizerId: string
+  readonly recordTime: string
+  readonly traceContext?: Record<string, string>
+  readonly externalTransactionHash?: string
+  readonly paidTrafficCost?: number
+}
+
+/** An offset checkpoint from the update stream. */
+export type OffsetCheckpoint = {
+  readonly offset: number
+  readonly synchronizerTimes?: readonly {
+    readonly synchronizerId: string
+    readonly recordTime: string
+  }[]
+}
+
+/** Tagged update union as it appears on the wire. */
+export type TaggedUpdate =
+  | { readonly Transaction: { readonly value: JsTransaction } }
+  | { readonly Reassignment: Reassignment }
+  | { readonly OffsetCheckpoint: { readonly value: OffsetCheckpoint } }
+  | { readonly TopologyTransaction: unknown }
+
+/** Update format for streaming requests. */
+export type UpdateFormat = {
+  readonly includeTransactions?: {
+    readonly transactionShape:
+      | 'TRANSACTION_SHAPE_ACS_DELTA'
+      | 'TRANSACTION_SHAPE_LEDGER_EFFECTS'
+    readonly eventFormat: EventFormat
+  }
+  readonly includeReassignments?: EventFormat
+  readonly includeTopologyEvents?: unknown
+}

package/src/types/user.ts

@@ -0,0 +1,41 @@
+/**
+ * Canton user management types.
+ *
+ * Users are the identity layer above parties. A user can act as multiple parties
+ * and have different rights.
+ *
+ * Rights on the wire use deeply nested tagged unions:
+ *   { "kind": { "CanActAs": { "value": { "party": "..." } } } }
+ */
+
+import type { ObjectMeta } from './party.js'
+
+/** A user in the Canton user management system (wire format). */
+export type User = {
+  readonly id: string
+  readonly primaryParty?: string
+  readonly isDeactivated?: boolean
+  readonly metadata?: ObjectMeta
+  readonly identityProviderId?: string
+}
+
+/** A right on the wire (tagged union). */
+export type Right = {
+  readonly kind: RightKind
+}
+
+/** Right kind (tagged discriminated union). */
+export type RightKind =
+  | { readonly CanActAs: { readonly value: { readonly party: string } } }
+  | { readonly CanReadAs: { readonly value: { readonly party: string } } }
+  | { readonly CanExecuteAs: { readonly value: { readonly party: string } } }
+  | { readonly CanExecuteAsAnyParty: { readonly value: Record<string, never> } }
+  | { readonly CanReadAsAnyParty: { readonly value: Record<string, never> } }
+  | { readonly ParticipantAdmin: { readonly value: Record<string, never> } }
+  | { readonly IdentityProviderAdmin: { readonly value: Record<string, never> } }
+
+/** Request to create a user. */
+export type CreateUserRequest = {
+  readonly user: User
+  readonly rights?: readonly Right[]
+}