@distrohelena/canton-typescript-sdk 0.1.45 → 0.1.47

package/dist/cjs/core/types/canton-logger.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalPartySignatureFormat = exports.ExternalPartySignature = exports.ExternalPartyOnboardingTransaction = exports.ExternalPartyCryptoKeyFormat = exports.TransportKind = exports.TransportCapability = exports.SignCommandResult = exports.SignCommandRequest = exports.BearerTokenAuthProvider = exports.SynchronizerConnectivityServiceClient = exports.VersionServiceClient = exports.UserManagementServiceClient = exports.UpdateServiceClient = exports.TrafficControlServiceClient = exports.TopologyManagerWriteServiceClient = exports.TopologyManagerReadServiceClient = exports.TopologyAggregationServiceClient = exports.StateServiceClient = exports.ResourceManagementServiceClient = exports.PruningServiceClient = exports.PartyManagementServiceClient = exports.ParticipantStatusServiceClient = exports.ParticipantRepairServiceClient = exports.ParticipantPackageServiceClient = exports.ParticipantPartyManagementServiceClient = exports.ParticipantInspectionServiceClient = exports.PackageServiceClient = exports.PackageManagementServiceClient = exports.IdentityProviderConfigServiceClient = exports.IdentityInitializationServiceClient = exports.HealthServiceClient = exports.EventQueryServiceClient = exports.ContractServiceClient = exports.CommandSubmissionServiceClient = exports.CommandServiceClient = exports.CommandInspectionServiceClient = exports.CommandCompletionServiceClient = exports.ExternalPartyActivationResponse = exports.ExternalPartyActivationRequest = exports.ExternalPartyActivationClient = exports.CantonClientOptions = exports.CantonHashingClient = exports.PqsSchemaProfileError = exports.PqsQueryError = exports.QuerySnapshotIncompleteError = exports.QueryCapabilityError = exports.MemoryQueryCache = exports.QuerySource = exports.CantonManager = exports.CantonClient = void 0;
-exports.PackageReference = exports.PackageMetadataFilter = exports.ActiveContractsTraversalOptions = exports.OperationDeadline = exports.RequestOptions = exports.ReceivedAcsCommitmentState = exports.ReceivedAcsCommitmentPerSynchronizer = exports.ReceivedAcsCommitment = exports.PruningSchedule = exports.ParticipantPruningSchedule = exports.PendingOperationMetadata = exports.PackageStatus = exports.CantonHashPurpose = exports.HashFunction = exports.PackageFormat = exports.OffsetCheckpoint = exports.ObjectMeta = exports.LedgerUser = exports.KnownPackageDetails = exports.IdentityProviderConfig = exports.UserRightKind = exports.EventStreamKind = exports.DamlParty = exports.DamlNumeric = exports.ContractCreated = exports.ContractArchived = exports.CounterParticipantInfo = exports.CommitmentTimeRange = exports.CommitmentInterval = exports.Completion = exports.CommandUpdateSummary = exports.CommandTiming = exports.CommandStatus = exports.CommandState = exports.CommandRequestStatistics = exports.CommandInspectionContract = exports.ConnectedSynchronizerStatus = exports.ConnectedSynchronizer = exports.ConnectedSynchronizerHealth = exports.AdminTopologyQueueStatus = exports.AdminNotInitializedStatus = exports.AdminNotInitializedExternalInputKind = exports.AdminNodeStatus = exports.AdminComponentStatus = exports.AdminComponentHealthKind = exports.SubmissionMode = exports.GrpcChannelSecurity = exports.ExternalPartySigningPublicKey = exports.ExternalPartySigningKeySpec = exports.ExternalPartySigningAlgorithmSpec = void 0;
-exports.TopologyPublicKey = exports.TopologyPartyResult = exports.TopologyPartyParticipantSynchronizerPermission = exports.TopologyPartyParticipant = exports.TopologyMappingResult = exports.TopologyMappingOperation = exports.TopologyMappingCode = exports.TopologyKeyOwnerResult = exports.MultiTopologyTransactionSignature = exports.GeneratedTopologyTransaction = exports.TopologyEncryptionPublicKey = exports.ExternalTopologySignature = exports.TopologyDuration = exports.TopologyBaseResult = exports.TopologyBaseQuery = exports.SynchronizerTrustCertificate = exports.SequencerSynchronizerState = exports.PartyToParticipantParticipant = exports.PartyToParticipantOnboarding = exports.PartyToParticipant = exports.PartyToKeyMapping = exports.PartyHostingLimits = exports.ParticipantSynchronizerPermission = exports.ParticipantSynchronizerLimits = exports.ParticipantPermission = exports.OwnerToKeyMapping = exports.OnboardingRestriction = exports.NamespaceDelegationRestrictionKind = exports.NamespaceDelegationRestriction = exports.NamespaceDelegation = exports.MediatorSynchronizerState = exports.LsuSequencerConnectionSuccessor = exports.LsuSequencerConnection = exports.LsuAnnouncement = exports.DynamicSynchronizerParameters = exports.DynamicSequencingParameters = exports.DecentralizedNamespaceDefinition = exports.AcsCommitmentsCatchUpConfig = exports.WaitCommitmentsSetup = exports.TopologyStateFilter = exports.SynchronizerTimeRange = exports.SlowCounterParticipantSynchronizerConfig = exports.SentAcsCommitmentState = exports.SentAcsCommitmentPerSynchronizer = exports.SentAcsCommitment = exports.SdkCommand = exports.SafeToPruneCommitmentState = exports.ParticipantPackageDescription = exports.ParticipantModuleDescription = exports.ParticipantDarDescription = void 0;
-exports.ListAllRequest = exports.ListPackagesRequest = exports.GetCommandStatusRequest = exports.GetActiveContractsRequest = exports.GetActiveContractsPageRequest = exports.GetDarRequest = exports.GetDarContentsRequest = exports.AssembleSignedTopologyTransactionsRequest = exports.SubmitCommandTransactionResponse = exports.DamlRecord = exports.DamlEnum = exports.DamlVariant = exports.DamlGenMap = exports.DamlTextMap = exports.DamlTimestamp = exports.DamlDate = exports.DamlUnit = exports.DamlContractId = exports.PreparedCommandSubmission = exports.DisclosedContract = exports.AllocatePartyRequest = exports.CreateExternalPartyRequest = exports.PreparedDecentralizedParty = exports.FinalizeDecentralizedPartyRequest = exports.CreateDecentralizedPartyRequest = exports.ExerciseCommand = exports.ExerciseByKeyCommand = exports.CreateCommand = exports.CreateAndExerciseCommand = exports.SignedTopologyTransaction = exports.PreparedTopologyTransaction = exports.VettedPackages = exports.VettedPackage = exports.TrafficControlParameters = exports.TopologyVettedPackages = exports.TopologyVettedPackage = exports.TopologyTransactions = exports.TopologyTransactionItem = exports.TopologyTransactionSignature = exports.TopologyTimeRange = exports.TopologyStoreTemporary = exports.TopologyStoreSynchronizer = exports.TopologyStoreKind = exports.TopologyStoreId = exports.TopologyStoreAuthorized = exports.TopologySigningPublicKey = exports.TopologySigningKeysWithThreshold = exports.TopologySignatureFormat = exports.TopologySignatureDelegation = exports.TopologyForceFlag = void 0;
-exports.ListAllResponse = exports.GetUserResponse = exports.GetPartiesResponse = exports.GetPackageStatusResponse = exports.GetPackageResponse = exports.GetLedgerEndResponse = exports.GetLatestPrunedOffsetsResponse = exports.GetIdentityProviderConfigResponse = exports.GetCommandStatusResponse = exports.GetConnectedSynchronizersResponse = exports.GetActiveContractsPageResponse = exports.GetDarResponse = exports.GetDarContentsResponse = exports.AllocatePartyResponse = exports.UploadDarFileRequest = exports.GrantUserRightsRequest = exports.WaitForPartyHostingRequest = exports.TopologyListPartiesRequest = exports.SubmitCommandsRequest = exports.ListUsersRequest = exports.ListUserRightsRequest = exports.ListKeyOwnersRequest = exports.ListIdentityProviderConfigsRequest = exports.ListDarsRequest = exports.ListKnownPackagesRequest = exports.ListKnownPartiesRequest = exports.TopologyListVettedPackagesRequest = exports.ListSynchronizerTrustCertificateRequest = exports.ListSynchronizerParametersStateRequest = exports.ListSequencingParametersStateRequest = exports.ListSequencerSynchronizerStateRequest = exports.ListPartyToParticipantRequest = exports.ListPartyToKeyMappingRequest = exports.ListVettedPackagesRequest = exports.ListPartyHostingLimitsRequest = exports.ListParticipantSynchronizerPermissionRequest = exports.ListOwnerToKeyMappingRequest = exports.ListNamespaceDelegationRequest = exports.ListMediatorSynchronizerStateRequest = exports.ListLsuSequencerConnectionSuccessorRequest = exports.ListLsuAnnouncementRequest = exports.GetUserRequest = exports.GetPartiesRequest = exports.GetLedgerEndRequest = exports.GetLatestPrunedOffsetsRequest = exports.GetConnectedSynchronizersRequest = exports.GetPackageStatusRequest = exports.GetPackageRequest = exports.GetIdentityProviderConfigRequest = exports.ListDecentralizedNamespaceDefinitionRequest = void 0;
-exports.EndpointNotConfiguredError = exports.ObjectDisposedError = exports.NotSupportedError = exports.ConflictError = exports.TimeoutError = exports.SigningError = exports.GrpcTransportError = exports.TransportError = exports.AuthorizationError = exports.AuthenticationError = exports.ActiveContractsTraversalError = exports.ValidationError = exports.CantonError = exports.SynchronizerTime = exports.ParticipantNodeStatus = exports.PartyDetails = exports.UploadDarFileResponse = exports.GrantUserRightsResponse = exports.SubmitCommandResponse = exports.TopologyListPartiesResponse = exports.TopologyListVettedPackagesResponse = exports.ListVettedPackagesResponse = exports.ListUsersResponse = exports.ListUserRightsResponse = exports.ListSynchronizerTrustCertificateResponse = exports.ListSynchronizerParametersStateResponse = exports.ListSequencingParametersStateResponse = exports.ListSequencerSynchronizerStateResponse = exports.ListPartyToParticipantResponse = exports.ListPartyToKeyMappingResponse = exports.ListPartyHostingLimitsResponse = exports.ListParticipantSynchronizerPermissionResponse = exports.ListKeyOwnersResponse = exports.ListKnownPartiesResponse = exports.ListKnownPackagesResponse = exports.ListIdentityProviderConfigsResponse = exports.ListDarsResponse = exports.ListPackagesResponse = exports.ListOwnerToKeyMappingResponse = exports.ListNamespaceDelegationResponse = exports.ListMediatorSynchronizerStateResponse = exports.ListLsuSequencerConnectionSuccessorResponse = exports.ListLsuAnnouncementResponse = exports.ListDecentralizedNamespaceDefinitionResponse = void 0;
+exports.ExternalPartyOnboardingTransaction = exports.ExternalPartyCryptoKeyFormat = exports.TransportKind = exports.TransportCapability = exports.SignCommandResult = exports.SignCommandRequest = exports.BearerTokenAuthProvider = exports.SynchronizerConnectivityServiceClient = exports.VersionServiceClient = exports.UserManagementServiceClient = exports.UpdateServiceClient = exports.TrafficControlServiceClient = exports.TopologyManagerWriteServiceClient = exports.TopologyManagerReadServiceClient = exports.TopologyAggregationServiceClient = exports.StateServiceClient = exports.ResourceManagementServiceClient = exports.PruningServiceClient = exports.PartyManagementServiceClient = exports.ParticipantStatusServiceClient = exports.ParticipantRepairServiceClient = exports.ParticipantPackageServiceClient = exports.ParticipantPartyManagementServiceClient = exports.ParticipantInspectionServiceClient = exports.PackageServiceClient = exports.PackageManagementServiceClient = exports.IdentityProviderConfigServiceClient = exports.IdentityInitializationServiceClient = exports.HealthServiceClient = exports.EventQueryServiceClient = exports.ContractServiceClient = exports.CommandSubmissionServiceClient = exports.CommandServiceClient = exports.CommandInspectionServiceClient = exports.CommandCompletionServiceClient = exports.ExternalPartyActivationResponse = exports.ExternalPartyActivationRequest = exports.ExternalPartyActivationClient = exports.CantonClientOptions = exports.CantonHashingClient = exports.PqsSchemaProfileError = exports.PqsQueryError = exports.QuerySnapshotIncompleteError = exports.QueryCapabilityError = exports.HistoryWalkRequiredError = exports.ContractCacheRequiredError = exports.MemoryQueryCache = exports.QuerySource = exports.CantonManager = exports.CantonClient = void 0;
+exports.ActiveContractsTraversalOptions = exports.OperationDeadline = exports.RequestOptions = exports.ReceivedAcsCommitmentState = exports.ReceivedAcsCommitmentPerSynchronizer = exports.ReceivedAcsCommitment = exports.PruningSchedule = exports.ParticipantPruningSchedule = exports.PendingOperationMetadata = exports.PackageStatus = exports.CantonHashPurpose = exports.HashFunction = exports.PackageFormat = exports.OffsetCheckpoint = exports.ObjectMeta = exports.LedgerUser = exports.KnownPackageDetails = exports.IdentityProviderConfig = exports.UserRightKind = exports.EventStreamKind = exports.DamlParty = exports.DamlNumeric = exports.ContractCreated = exports.ContractArchived = exports.CounterParticipantInfo = exports.CommitmentTimeRange = exports.CommitmentInterval = exports.Completion = exports.CommandUpdateSummary = exports.CommandTiming = exports.CommandStatus = exports.CommandState = exports.CommandRequestStatistics = exports.CommandInspectionContract = exports.ConnectedSynchronizerStatus = exports.ConnectedSynchronizer = exports.ConnectedSynchronizerHealth = exports.AdminTopologyQueueStatus = exports.AdminNotInitializedStatus = exports.AdminNotInitializedExternalInputKind = exports.AdminNodeStatus = exports.AdminComponentStatus = exports.AdminComponentHealthKind = exports.SubmissionMode = exports.GrpcChannelSecurity = exports.ExternalPartySigningPublicKey = exports.ExternalPartySigningKeySpec = exports.ExternalPartySigningAlgorithmSpec = exports.ExternalPartySignatureFormat = exports.ExternalPartySignature = void 0;
+exports.TopologyPartyParticipantSynchronizerPermission = exports.TopologyPartyParticipant = exports.TopologyMappingResult = exports.TopologyMappingOperation = exports.TopologyMappingCode = exports.TopologyKeyOwnerResult = exports.MultiTopologyTransactionSignature = exports.GeneratedTopologyTransaction = exports.TopologyEncryptionPublicKey = exports.ExternalTopologySignature = exports.TopologyDuration = exports.TopologyBaseResult = exports.TopologyBaseQuery = exports.SynchronizerTrustCertificate = exports.SequencerSynchronizerState = exports.PartyToParticipantParticipant = exports.PartyToParticipantOnboarding = exports.PartyToParticipant = exports.PartyToKeyMapping = exports.PartyHostingLimits = exports.ParticipantSynchronizerPermission = exports.ParticipantSynchronizerLimits = exports.ParticipantPermission = exports.OwnerToKeyMapping = exports.OnboardingRestriction = exports.NamespaceDelegationRestrictionKind = exports.NamespaceDelegationRestriction = exports.NamespaceDelegation = exports.MediatorSynchronizerState = exports.LsuSequencerConnectionSuccessor = exports.LsuSequencerConnection = exports.LsuAnnouncement = exports.DynamicSynchronizerParameters = exports.DynamicSequencingParameters = exports.DecentralizedNamespaceDefinition = exports.AcsCommitmentsCatchUpConfig = exports.WaitCommitmentsSetup = exports.TopologyStateFilter = exports.SynchronizerTimeRange = exports.SlowCounterParticipantSynchronizerConfig = exports.SentAcsCommitmentState = exports.SentAcsCommitmentPerSynchronizer = exports.SentAcsCommitment = exports.SdkCommand = exports.SafeToPruneCommitmentState = exports.ParticipantPackageDescription = exports.ParticipantModuleDescription = exports.ParticipantDarDescription = exports.PackageReference = exports.PackageMetadataFilter = void 0;
+exports.GetCommandStatusRequest = exports.GetActiveContractsRequest = exports.GetActiveContractsPageRequest = exports.GetDarRequest = exports.GetDarContentsRequest = exports.AssembleSignedTopologyTransactionsRequest = exports.SubmitCommandTransactionResponse = exports.DamlRecord = exports.DamlEnum = exports.DamlVariant = exports.DamlGenMap = exports.DamlTextMap = exports.DamlTimestamp = exports.DamlDate = exports.DamlUnit = exports.DamlContractId = exports.PreparedCommandSubmission = exports.DisclosedContract = exports.AllocatePartyRequest = exports.CreateExternalPartyRequest = exports.PreparedDecentralizedParty = exports.FinalizeDecentralizedPartyRequest = exports.CreateDecentralizedPartyRequest = exports.ExerciseCommand = exports.ExerciseByKeyCommand = exports.CreateCommand = exports.CreateAndExerciseCommand = exports.SignedTopologyTransaction = exports.PreparedTopologyTransaction = exports.VettedPackages = exports.VettedPackage = exports.TrafficControlParameters = exports.TopologyVettedPackages = exports.TopologyVettedPackage = exports.TopologyTransactions = exports.TopologyTransactionItem = exports.TopologyTransactionSignature = exports.TopologyTimeRange = exports.TopologyStoreTemporary = exports.TopologyStoreSynchronizer = exports.TopologyStoreKind = exports.TopologyStoreId = exports.TopologyStoreAuthorized = exports.TopologySigningPublicKey = exports.TopologySigningKeysWithThreshold = exports.TopologySignatureFormat = exports.TopologySignatureDelegation = exports.TopologyForceFlag = exports.TopologyPublicKey = exports.TopologyPartyResult = void 0;
+exports.GetPartiesResponse = exports.GetPackageStatusResponse = exports.GetPackageResponse = exports.GetLedgerEndResponse = exports.GetLatestPrunedOffsetsResponse = exports.GetIdentityProviderConfigResponse = exports.GetCommandStatusResponse = exports.GetConnectedSynchronizersResponse = exports.GetActiveContractsPageResponse = exports.GetDarResponse = exports.GetDarContentsResponse = exports.AllocatePartyResponse = exports.UploadDarFileRequest = exports.GrantUserRightsRequest = exports.WaitForPartyHostingRequest = exports.TopologyListPartiesRequest = exports.SubmitCommandsRequest = exports.ListUsersRequest = exports.ListUserRightsRequest = exports.ListKeyOwnersRequest = exports.ListIdentityProviderConfigsRequest = exports.ListDarsRequest = exports.ListKnownPackagesRequest = exports.ListKnownPartiesRequest = exports.TopologyListVettedPackagesRequest = exports.ListSynchronizerTrustCertificateRequest = exports.ListSynchronizerParametersStateRequest = exports.ListSequencingParametersStateRequest = exports.ListSequencerSynchronizerStateRequest = exports.ListPartyToParticipantRequest = exports.ListPartyToKeyMappingRequest = exports.ListVettedPackagesRequest = exports.ListPartyHostingLimitsRequest = exports.ListParticipantSynchronizerPermissionRequest = exports.ListOwnerToKeyMappingRequest = exports.ListNamespaceDelegationRequest = exports.ListMediatorSynchronizerStateRequest = exports.ListLsuSequencerConnectionSuccessorRequest = exports.ListLsuAnnouncementRequest = exports.GetUserRequest = exports.GetPartiesRequest = exports.GetLedgerEndRequest = exports.GetLatestPrunedOffsetsRequest = exports.GetConnectedSynchronizersRequest = exports.GetPackageStatusRequest = exports.GetPackageRequest = exports.GetIdentityProviderConfigRequest = exports.ListDecentralizedNamespaceDefinitionRequest = exports.ListAllRequest = exports.ListPackagesRequest = void 0;
+exports.EndpointNotConfiguredError = exports.ObjectDisposedError = exports.NotSupportedError = exports.ConflictError = exports.TimeoutError = exports.SigningError = exports.GrpcTransportError = exports.TransportError = exports.AuthorizationError = exports.AuthenticationError = exports.ActiveContractsTraversalError = exports.ValidationError = exports.CantonError = exports.SynchronizerTime = exports.ParticipantNodeStatus = exports.PartyDetails = exports.UploadDarFileResponse = exports.GrantUserRightsResponse = exports.SubmitCommandResponse = exports.TopologyListPartiesResponse = exports.TopologyListVettedPackagesResponse = exports.ListVettedPackagesResponse = exports.ListUsersResponse = exports.ListUserRightsResponse = exports.ListSynchronizerTrustCertificateResponse = exports.ListSynchronizerParametersStateResponse = exports.ListSequencingParametersStateResponse = exports.ListSequencerSynchronizerStateResponse = exports.ListPartyToParticipantResponse = exports.ListPartyToKeyMappingResponse = exports.ListPartyHostingLimitsResponse = exports.ListParticipantSynchronizerPermissionResponse = exports.ListKeyOwnersResponse = exports.ListKnownPartiesResponse = exports.ListKnownPackagesResponse = exports.ListIdentityProviderConfigsResponse = exports.ListDarsResponse = exports.ListPackagesResponse = exports.ListOwnerToKeyMappingResponse = exports.ListNamespaceDelegationResponse = exports.ListMediatorSynchronizerStateResponse = exports.ListLsuSequencerConnectionSuccessorResponse = exports.ListLsuAnnouncementResponse = exports.ListDecentralizedNamespaceDefinitionResponse = exports.ListAllResponse = exports.GetUserResponse = void 0;
 var canton_client_js_1 = require("./client/canton-client.js");
 Object.defineProperty(exports, "CantonClient", { enumerable: true, get: function () { return canton_client_js_1.CantonClient; } });
 var canton_manager_js_1 = require("./query/canton-manager.js");
@@ -14,6 +14,10 @@ var query_source_js_1 = require("./query/query-source.js");
 Object.defineProperty(exports, "QuerySource", { enumerable: true, get: function () { return query_source_js_1.QuerySource; } });
 var memory_query_cache_js_1 = require("./query/cache/memory-query-cache.js");
 Object.defineProperty(exports, "MemoryQueryCache", { enumerable: true, get: function () { return memory_query_cache_js_1.MemoryQueryCache; } });
+var contract_cache_required_error_js_1 = require("./query/errors/contract-cache-required-error.js");
+Object.defineProperty(exports, "ContractCacheRequiredError", { enumerable: true, get: function () { return contract_cache_required_error_js_1.ContractCacheRequiredError; } });
+var history_walk_required_error_js_1 = require("./query/errors/history-walk-required-error.js");
+Object.defineProperty(exports, "HistoryWalkRequiredError", { enumerable: true, get: function () { return history_walk_required_error_js_1.HistoryWalkRequiredError; } });
 var query_capability_error_js_1 = require("./query/errors/query-capability-error.js");
 Object.defineProperty(exports, "QueryCapabilityError", { enumerable: true, get: function () { return query_capability_error_js_1.QueryCapabilityError; } });
 var query_snapshot_incomplete_error_js_1 = require("./query/errors/query-snapshot-incomplete-error.js");

package/dist/cjs/query/canton-manager.js

@@ -37,9 +37,12 @@ class CantonManager {
                 updateService: this.grpc.updateService,
                 packageService: this.grpc.packageService,
                 endpointScope: options.grpc.ledgerEndpoint ?? "ledger",
+                incrementalHistory: options.incrementalHistory,
+                walkHistory: options.walkHistory,
+                logger: options.logger,
                 contractCache: options.cache === undefined
                     ? undefined
-                    : new grpc_contract_cache_js_1.GrpcContractCache(this.grpc.stateService, options.cache.store, options.cache.ttlMs, options.grpc.ledgerEndpoint ?? "ledger"),
+                    : new grpc_contract_cache_js_1.GrpcContractCache(this.grpc.stateService, options.cache.store, options.cache.ttlMs, options.grpc.ledgerEndpoint ?? "ledger", undefined, options.cache.maxPageSize, this.grpc.updateService, { enabled: options.cache.betaDeltaRefresh, maxOffsetGap: options.cache.maxDeltaOffsetGap, maxUpdates: options.cache.maxDeltaUpdates }),
             });
         }
     }

package/dist/cjs/query/errors/contract-cache-required-error.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractCacheRequiredError = void 0;
+const canton_error_js_1 = require("../../core/errors/canton-error.js");
+/**
+ * gRPC typed queries never download the ACS implicitly: reading active contracts requires an explicitly
+ * warmed contract cache, so the (potentially very large) ACS transfer only ever happens when the caller
+ * asks for it via cacheContracts(). Thrown when an ACS-backed query runs without a warm entry for its
+ * party scope.
+ */
+class ContractCacheRequiredError extends canton_error_js_1.CantonError {
+    parties;
+    constructor(parties) {
+        super("gRPC active-contract queries require a warmed contract cache. Configure the cache "
+            + "({ store, ttlMs }) and call cacheContracts("
+            + (parties === undefined ? "" : JSON.stringify({ parties }))
+            + ") before querying; the prewarm's party scope must match the query's.");
+        this.parties = parties;
+    }
+}
+exports.ContractCacheRequiredError = ContractCacheRequiredError;

package/dist/cjs/query/errors/history-walk-required-error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HistoryWalkRequiredError = void 0;
+const canton_error_js_1 = require("../../core/errors/canton-error.js");
+/**
+ * gRPC typed queries never replay ledger history implicitly: transactions/events/exercises queries — and
+ * contracts queries whose predicates or includes reach archived state — require the walkHistory option, so
+ * the (potentially very expensive) replay only ever happens when the caller asked for it.
+ */
+class HistoryWalkRequiredError extends canton_error_js_1.CantonError {
+    relation;
+    constructor(relation) {
+        super(`The "${relation}" query requires replaying ledger history, which is disabled by default. `
+            + "Enable the walkHistory option to permit it (pair it with incrementalHistory so repeat "
+            + "queries fetch only new offsets), or reshape the query to active-only state served by the "
+            + "contract cache.");
+        this.relation = relation;
+    }
+}
+exports.HistoryWalkRequiredError = HistoryWalkRequiredError;

package/dist/cjs/query/grpc/grpc-contract-cache.js

@@ -4,26 +4,43 @@ exports.GrpcContractCache = void 0;
 exports.normalizeParties = normalizeParties;
 const types_1 = require("node:util/types");
 const validation_error_js_1 = require("../../core/errors/validation-error.js");
+const transaction_filter_js_1 = require("../../transports/grpc/generated/canton/com/daml/ledger/api/v2/transaction_filter.js");
 const contracts_mapper_js_1 = require("../../transports/grpc/mappers/contracts-mapper.js");
 const query_source_js_1 = require("../query-source.js");
 const grpc_relation_mapper_js_1 = require("./grpc-relation-mapper.js");
 const grpc_query_snapshot_reader_js_1 = require("./grpc-query-snapshot-reader.js");
+const DELTA_DEFAULT_MAX_OFFSET_GAP = 1_000_000;
+const DELTA_MAX_PAGES = 10_000;
 class GrpcContractCache {
     stateService;
     store;
     ttlMs;
     endpointScope;
     now;
+    maxPageSize;
+    updateService;
+    delta;
     inflight = new Map();
-    constructor(stateService, store, ttlMs, endpointScope, now = Date.now) {
+    constructor(stateService, store, ttlMs, endpointScope, now = Date.now, maxPageSize, updateService, delta = {}) {
         this.stateService = stateService;
         this.store = store;
         this.ttlMs = ttlMs;
         this.endpointScope = endpointScope;
         this.now = now;
+        this.maxPageSize = maxPageSize;
+        this.updateService = updateService;
+        this.delta = delta;
         if (!Number.isFinite(ttlMs) || ttlMs <= 0) {
             throw new validation_error_js_1.ValidationError("Contract cache ttlMs must be a positive finite number.");
         }
+        else if (maxPageSize !== undefined && (!Number.isFinite(maxPageSize) || !Number.isInteger(maxPageSize) || maxPageSize <= 0)) {
+            throw new validation_error_js_1.ValidationError("Contract cache maxPageSize must be a positive integer.");
+        }
+        for (const [name, value] of Object.entries({ maxOffsetGap: delta.maxOffsetGap, maxUpdates: delta.maxUpdates })) {
+            if (value !== undefined && (!Number.isFinite(value) || !Number.isInteger(value) || value < 0)) {
+                throw new validation_error_js_1.ValidationError(`Contract cache delta ${name} must be a non-negative integer.`);
+            }
+        }
     }
     async cacheContracts(args) {
         const parties = normalizeParties(args);
@@ -49,7 +66,7 @@ class GrpcContractCache {
         if (snapshot === undefined) {
             return undefined;
         }
-        return Object.freeze({ activeAtOffset: snapshot.activeAtOffset, contracts: snapshot.contracts });
+        return Object.freeze({ activeAtOffset: snapshot.activeAtOffset, contracts: snapshot.contracts, creationMetadata: snapshot.creationMetadata });
     }
     async invalidateContractsCache(args) {
         const parties = normalizeParties(args);
@@ -62,7 +79,186 @@ class GrpcContractCache {
         }
         await this.store.deleteAsync(key);
     }
+    /** Measures the cached snapshot against the current ledger end, without changing anything. */
+    async inspectContractsCacheAsync(args) {
+        const parties = normalizeParties(args);
+        const base = asCompatibleSnapshot(await this.store.getAsync(cacheKey(this.endpointScope, parties)), this.endpointScope, parties, currentEpochMs(this.now), true);
+        if (base === undefined || this.stateService.getLedgerEndAsync === undefined) {
+            return undefined;
+        }
+        const ledgerEnd = parseCacheOffset((await this.stateService.getLedgerEndAsync({})).offset);
+        const activeAt = parseCacheOffset(base.activeAtOffset);
+        if (ledgerEnd === undefined || activeAt === undefined || ledgerEnd < activeAt) {
+            return undefined;
+        }
+        return Object.freeze({
+            activeAtOffset: base.activeAtOffset,
+            ledgerEndOffset: ledgerEnd.toString(),
+            offsetGap: (ledgerEnd - activeAt).toString(),
+            contractCount: base.contracts.length,
+            expiresAt: new Date(base.expiresAtEpochMs),
+        });
+    }
     async populateAsync(parties, key) {
+        // An expired snapshot is still a valid delta base: expiry gates queries, not refreshes.
+        const base = asCompatibleSnapshot(await this.store.getAsync(key), this.endpointScope, parties, currentEpochMs(this.now), true);
+        if (base !== undefined && this.updateService !== undefined && this.delta.enabled === true) {
+            const delta = await this.tryDeltaRefreshAsync(parties, key, base);
+            if (delta !== undefined) {
+                return delta;
+            }
+        }
+        return this.fullRefreshAsync(parties, key, base);
+    }
+    /**
+     * Patches the base snapshot forward from the update stream instead of re-downloading the ACS. Returns
+     * undefined — meaning "do the full download instead" — whenever correctness cannot be proven cheaply:
+     * pruning past the base offset, an offset gap or update count beyond the configured budgets, any
+     * reassignment or topology change in the window (multi-synchronizer moves cannot be patched safely), an
+     * exercised event where ACS_DELTA promises none, or an archive/create inconsistent with the base rows.
+     */
+    async tryDeltaRefreshAsync(parties, key, base) {
+        if (this.stateService.getLedgerEndAsync === undefined || this.stateService.getLatestPrunedOffsetsAsync === undefined || this.updateService === undefined) {
+            return undefined;
+        }
+        try {
+            const baseOffset = parseCacheOffset(base.activeAtOffset);
+            const pruned = parseCacheOffset((await this.stateService.getLatestPrunedOffsetsAsync({})).participantPrunedUpToInclusive);
+            const ledgerEnd = parseCacheOffset((await this.stateService.getLedgerEndAsync({})).offset);
+            if (baseOffset === undefined || pruned === undefined || pruned > baseOffset || ledgerEnd === undefined || ledgerEnd < baseOffset) {
+                return undefined;
+            }
+            const offsetGap = ledgerEnd - baseOffset;
+            if (offsetGap === 0n) {
+                return this.writeSnapshotAsync(parties, key, base.activeAtOffset, base.contracts, base.creationMetadata, { refresh: "noop", offsetGap: "0" });
+            }
+            const maxOffsetGap = BigInt(this.delta.maxOffsetGap ?? DELTA_DEFAULT_MAX_OFFSET_GAP);
+            if (offsetGap > maxOffsetGap) {
+                return undefined;
+            }
+            const window = await this.readDeltaWindowAsync(parties, base, ledgerEnd.toString());
+            if (window === undefined) {
+                return undefined;
+            }
+            const baseIds = new Set(base.contracts.map((row) => row.contractId));
+            const adds = new Map();
+            const removes = new Set();
+            for (const entry of window.entries) {
+                if (entry.kind === "created") {
+                    if (baseIds.has(entry.event.contractId) || adds.has(entry.event.contractId)) {
+                        return undefined;
+                    }
+                    adds.set(entry.event.contractId, { event: entry.event, synchronizerId: entry.synchronizerId });
+                }
+                else if (adds.has(entry.contractId)) {
+                    adds.delete(entry.contractId);
+                }
+                else if (baseIds.has(entry.contractId)) {
+                    removes.add(entry.contractId);
+                }
+                else {
+                    return undefined;
+                }
+            }
+            const survivors = [...adds.values()].map(({ event, synchronizerId }) => ({
+                contractEntry: {
+                    oneofKind: "activeContract",
+                    activeContract: { createdEvent: event, synchronizerId, reassignmentCounter: "0" },
+                },
+            }));
+            const fragment = (0, grpc_relation_mapper_js_1.mapGrpcQueryRelationFragment)([], survivors);
+            const contracts = [...base.contracts.filter((row) => !removes.has(row.contractId)), ...fragment.contracts]
+                .sort((left, right) => left.contractId.localeCompare(right.contractId));
+            const addedMetadata = fragment.creationIdentities.map((identity) => ({
+                contractId: identity.contractId,
+                packageName: identity.packageName,
+                representativePackageId: identity.representativePackageId,
+            }));
+            const creationMetadata = [...base.creationMetadata.filter((entry) => !removes.has(entry.contractId)), ...addedMetadata]
+                .sort((left, right) => left.contractId.localeCompare(right.contractId));
+            return await this.writeSnapshotAsync(parties, key, ledgerEnd.toString(), contracts, creationMetadata, {
+                refresh: "delta",
+                offsetGap: offsetGap.toString(),
+                deltaUpdateCount: window.entries.length,
+            });
+        }
+        catch {
+            // Any validation failure in the window falls back to the full download, which re-validates from scratch.
+            return undefined;
+        }
+    }
+    async readDeltaWindowAsync(parties, base, endInclusive) {
+        const eventFormat = (0, contracts_mapper_js_1.mapGrpcQueryContractsRequest)(parties === undefined ? { allParties: true } : { parties }).eventFormat;
+        const maxUpdates = this.delta.maxUpdates ?? Math.max(1_000, 2 * base.contracts.length);
+        const entries = [];
+        const seenPageTokens = new Set();
+        const end = parseCacheOffset(endInclusive);
+        let expectedLowestExclusive = parseCacheOffset(base.activeAtOffset);
+        let pageToken;
+        let updatesSeen = 0;
+        for (let pagesRead = 0; pagesRead < DELTA_MAX_PAGES; pagesRead += 1) {
+            const request = {
+                beginOffsetExclusive: base.activeAtOffset,
+                endOffsetInclusive: endInclusive,
+                updateFormat: { includeTransactions: { eventFormat, transactionShape: transaction_filter_js_1.TransactionShape.ACS_DELTA } },
+                descendingOrder: false,
+                pageToken: pageToken === undefined ? undefined : Uint8Array.from(pageToken),
+            };
+            const response = await this.updateService.getUpdatesPageAsync(request);
+            const lowest = parseCacheOffset(response.lowestPageOffsetExclusive);
+            const highest = parseCacheOffset(response.highestPageOffsetInclusive);
+            if (lowest === undefined || highest === undefined || lowest !== expectedLowestExclusive || highest < lowest || highest > end) {
+                return undefined;
+            }
+            updatesSeen += response.updates.length;
+            if (updatesSeen > maxUpdates) {
+                return undefined;
+            }
+            for (const update of response.updates) {
+                const collected = collectDeltaEntries(update, entries);
+                if (!collected) {
+                    return undefined;
+                }
+            }
+            const nextPageToken = response.nextPageToken;
+            if (nextPageToken === undefined || nextPageToken.length === 0) {
+                return highest === end ? { entries } : undefined;
+            }
+            else if (highest >= end || highest <= lowest) {
+                return undefined;
+            }
+            const tokenKey = Array.from(nextPageToken).join(",");
+            if (seenPageTokens.has(tokenKey)) {
+                return undefined;
+            }
+            seenPageTokens.add(tokenKey);
+            expectedLowestExclusive = highest;
+            pageToken = Uint8Array.from(nextPageToken);
+        }
+        return undefined;
+    }
+    async writeSnapshotAsync(parties, key, activeAtOffset, contracts, creationMetadata, outcome) {
+        const expiresAtEpochMs = effectiveExpiryEpochMs(this.now, this.ttlMs);
+        const snapshot = {
+            version: 2,
+            endpointScope: this.endpointScope,
+            parties,
+            activeAtOffset,
+            expiresAtEpochMs,
+            contracts: copyRows(contracts),
+            creationMetadata: creationMetadata.map((entry) => ({ ...entry })),
+        };
+        await this.store.setAsync(key, snapshot, this.ttlMs);
+        return {
+            source: query_source_js_1.QuerySource.grpc,
+            cached: true,
+            activeAtOffset,
+            contractCount: contracts.length,
+            expiresAt: new Date(expiresAtEpochMs),
+            ...outcome,
+        };
+    }
+    async fullRefreshAsync(parties, key, base) {
         const activeContracts = [];
         const seenPageTokens = new Set();
         // Every continuation request must be identical to the first page's request apart from the page
@@ -70,7 +266,9 @@ class GrpcContractCache {
         // the response's now-explicit activeAtOffset into page 2+ makes it reject the token
         // (INVALID_ACS_PAGE_TOKEN) — the token was prepared for a request with the field absent. The token
         // itself pins the snapshot offset; the echoed offset is only tracked to validate it stays constant.
-        const baseRequest = (0, contracts_mapper_js_1.mapGrpcQueryContractsRequest)(parties === undefined ? { allParties: true } : { parties });
+        const baseRequest = (0, contracts_mapper_js_1.mapGrpcQueryContractsRequest)(parties === undefined
+            ? { allParties: true, maxPageSize: this.maxPageSize }
+            : { parties, maxPageSize: this.maxPageSize });
         let activeAtOffset;
         let pageToken;
         do {
@@ -94,22 +292,35 @@ class GrpcContractCache {
                 seenPageTokens.add(tokenKey);
             }
         } while (pageToken !== undefined && pageToken.length > 0);
-        const contracts = (0, grpc_relation_mapper_js_1.mapGrpcQueryRelationFragment)([], activeContracts).contracts;
+        const fragment = (0, grpc_relation_mapper_js_1.mapGrpcQueryRelationFragment)([], activeContracts);
+        const contracts = fragment.contracts;
+        const creationMetadata = fragment.creationIdentities.map((identity) => ({
+            contractId: identity.contractId,
+            packageName: identity.packageName,
+            representativePackageId: identity.representativePackageId,
+        }));
         const expiresAtEpochMs = effectiveExpiryEpochMs(this.now, this.ttlMs);
+        const baseOffset = base === undefined ? undefined : parseCacheOffset(base.activeAtOffset);
+        const newOffset = parseCacheOffset(activeAtOffset);
         const result = {
             source: query_source_js_1.QuerySource.grpc,
             cached: true,
             activeAtOffset: activeAtOffset,
             contractCount: contracts.length,
             expiresAt: new Date(expiresAtEpochMs),
+            refresh: "full",
+            ...(baseOffset !== undefined && newOffset !== undefined && newOffset >= baseOffset
+                ? { offsetGap: (newOffset - baseOffset).toString() }
+                : {}),
         };
         const snapshot = {
-            version: 1,
+            version: 2,
             endpointScope: this.endpointScope,
             parties,
             activeAtOffset: activeAtOffset,
             expiresAtEpochMs,
             contracts: copyRows(contracts),
+            creationMetadata,
         };
         await this.store.setAsync(key, snapshot, this.ttlMs);
         return result;
@@ -155,7 +366,43 @@ function normalizeParties(args) {
 function cacheKey(endpointScope, parties) {
     return `grpc-contract-cache:v1:${JSON.stringify([endpointScope, parties])}`;
 }
-function asCompatibleSnapshot(value, endpointScope, parties, nowEpochMs) {
+/** Collects created/archived events from one ACS_DELTA update; false means the window cannot be patched. */
+function collectDeltaEntries(update, entries) {
+    if (update === null || typeof update !== "object") {
+        return false;
+    }
+    const oneof = update.update;
+    if (oneof === undefined || oneof.oneofKind === "offsetCheckpoint") {
+        return oneof !== undefined;
+    }
+    else if (oneof.oneofKind !== "transaction") {
+        // Reassignments and topology changes move contracts between synchronizers/visibility in ways a
+        // row-level patch cannot represent safely.
+        return false;
+    }
+    const transaction = oneof.transaction;
+    const synchronizerId = transaction?.synchronizerId;
+    if (typeof synchronizerId !== "string" || synchronizerId.length === 0 || !Array.isArray(transaction?.events)) {
+        return false;
+    }
+    for (const wrapped of transaction.events) {
+        const event = wrapped?.event;
+        if (event?.oneofKind === "created" && event.created !== undefined) {
+            entries.push({ kind: "created", event: event.created, synchronizerId });
+        }
+        else if (event?.oneofKind === "archived" && typeof event.archived?.contractId === "string" && event.archived.contractId.length > 0) {
+            entries.push({ kind: "archived", contractId: event.archived.contractId });
+        }
+        else {
+            return false;
+        }
+    }
+    return true;
+}
+function parseCacheOffset(value) {
+    return (0, grpc_query_snapshot_reader_js_1.isCanonicalGrpcOffset)(value) ? BigInt(value) : undefined;
+}
+function asCompatibleSnapshot(value, endpointScope, parties, nowEpochMs, ignoreExpiry = false) {
     try {
         if (value === null || typeof value !== "object") {
             return undefined;
@@ -168,7 +415,8 @@ function asCompatibleSnapshot(value, endpointScope, parties, nowEpochMs) {
         const activeAtOffset = candidate.activeAtOffset;
         const expiresAtEpochMs = candidate.expiresAtEpochMs;
         const contracts = materializeContractRows(candidate.contracts);
-        if (version !== 1
+        const creationMetadata = materializeCreationMetadata(candidate.creationMetadata, contracts);
+        if (version !== 2
             || storedEndpointScope !== endpointScope
             || (rawParties !== undefined && storedParties === undefined)
             || !sameParties(storedParties, parties)
@@ -179,8 +427,9 @@ function asCompatibleSnapshot(value, endpointScope, parties, nowEpochMs) {
             || typeof expiresAtEpochMs !== "number"
             || !Number.isFinite(expiresAtEpochMs)
             || !Number.isFinite(new Date(expiresAtEpochMs).getTime())
-            || expiresAtEpochMs <= nowEpochMs
-            || contracts === undefined) {
+            || (!ignoreExpiry && expiresAtEpochMs <= nowEpochMs)
+            || contracts === undefined
+            || creationMetadata === undefined) {
             return undefined;
         }
         return {
@@ -190,6 +439,7 @@ function asCompatibleSnapshot(value, endpointScope, parties, nowEpochMs) {
             activeAtOffset,
             expiresAtEpochMs,
             contracts,
+            creationMetadata,
         };
     }
     catch {
@@ -253,6 +503,40 @@ function materializePageToken(value) {
         throw new Error("Active-contracts response nextPageToken is invalid.");
     }
 }
+function materializeCreationMetadata(value, contracts) {
+    if (contracts === undefined) {
+        return undefined;
+    }
+    const entries = materializeIndexedValues(value, materializeCreationMetadataEntry);
+    if (entries === undefined || entries.some((entry) => entry === undefined)) {
+        return undefined;
+    }
+    const materialized = entries;
+    // Coherence: exactly one metadata entry per contract row, so the contractType join can never dangle.
+    const metadataContractIds = new Set(materialized.map((entry) => entry.contractId));
+    if (metadataContractIds.size !== materialized.length
+        || materialized.length !== contracts.length
+        || !contracts.every((row) => metadataContractIds.has(row.contractId))) {
+        return undefined;
+    }
+    return materialized;
+}
+function materializeCreationMetadataEntry(value) {
+    if (value === null || typeof value !== "object") {
+        return undefined;
+    }
+    const candidate = value;
+    const contractId = candidate.contractId;
+    const packageName = candidate.packageName;
+    const representativePackageId = candidate.representativePackageId;
+    if (typeof contractId !== "string"
+        || typeof packageName !== "string"
+        || packageName.length === 0
+        || (typeof representativePackageId !== "string" && representativePackageId !== null)) {
+        return undefined;
+    }
+    return { contractId, packageName, representativePackageId };
+}
 function materializeContractRows(value) {
     const rows = materializeIndexedValues(value, materializeContractRow);
     if (rows === undefined) {