@midnight-ntwrk/midnight-js-protocol 5.0.0-beta.8-pre.765ca083 → 5.0.0-beta.8

package/dist/index.d.ts

@@ -41,6 +41,30 @@ function _mergeNamespaces(n, m) {
  */
 declare const LEDGER_VERSIONS: readonly ["v8", "v9"];
 type LedgerVersion = (typeof LEDGER_VERSIONS)[number];
+/**
+ * The era whose objects this build hands out live, through `./ledger`.
+ *
+ * A protocol fact rather than a consumer's choice: it is decided by which
+ * ledger the package links eagerly, and every other era is reached lazily and
+ * crosses package boundaries as bytes. Declared here so that no package
+ * downstream restates "which era is now" as a literal of its own.
+ *
+ * The type is the single literal, not {@link LedgerVersion}, so a value typed
+ * by it DISCRIMINATES — the same discipline `CurrentPipelineEra` follows in
+ * `midnight-js-contracts`.
+ */
+declare const CURRENT_LEDGER_VERSION: "v9";
+type CurrentLedgerVersion = typeof CURRENT_LEDGER_VERSION;
+/**
+ * Every era this build still speaks but does not run live — the eras that
+ * cross a package boundary as serialized bytes.
+ *
+ * Defined as the complement of {@link CURRENT_LEDGER_VERSION}, so a further
+ * era joins this set by being added to {@link LEDGER_VERSIONS} and nothing
+ * else. The value list below is checked against that complement at build time.
+ */
+type RetainedLedgerVersion = Exclude<LedgerVersion, CurrentLedgerVersion>;
+declare const RETAINED_LEDGER_VERSIONS: readonly ["v8"];
 
 /**
  * Stable error-code strings for this package. Every error class in this module
@@ -947,7 +971,7 @@ declare const versionOfRecord: (record: VersionedRecord) => LedgerVersion;
  * will land in, and a stale reading is wrong exactly at the fork boundary,
  * where that question matters. `PublicDataProvider.queryLatestProtocolVersion`
  * states the same prohibition as a requirement on its implementations; this
- * parameter is a structural type, so nothing here can enforce it. See ADR 0008.
+ * parameter is a structural type, so nothing here can enforce it. See ADR 0007.
  *
  * @param source The indexer or node client to ask for the head version.
  * @returns A promise for the {@link LedgerVersion} at the network head.
@@ -1258,5 +1282,5 @@ interface Ledger8Engine {
  */
 declare const loadLedger8Engine: () => Promise<Ledger8Engine>;
 
-export { ComposeFailedError, ComposeOptionError, DownConvertFailedError, INITIAL_LEDGER_PARAMETERS, LEDGER_VERSIONS, Ledger8InstanceMismatchError, Ledger8RuntimeInvalidError, Ledger8RuntimeMissingError, MerkleNotRehashedError, NO_CIRCUIT, PROTOCOL_ERROR_CODES, PayloadNotATransactionError, StateDecodeFailedError, TRANSACTION_TAG_PREFIX, UnknownLedger8AxisError, UnknownLedgerVersionError, UnknownProtocolVersionError, loadLedger8, loadLedger8Engine, loadLedgerEra, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
-export type { CallTranscriptSource, ComposeCallEntry, ComposeCallOptions, ComposeDeployOptions, ComposeOption, ComposeStage, ConstructorResultPojo, ContractEntryPointPojo, ContractStatePojo, DeployResultPojo, DownConvertStage, DownConvertedState, EraPartitionCallOptions, ExecuteCircuitOptions, ExecuteConstructorOptions, Ledger8ChargedState, Ledger8DeployableContractState, Ledger8Engine, Ledger8InstanceAxis, Ledger8StateValue, LedgerEra, LedgerParametersOption, LedgerVersion, PartitionContext, PartitionedCallTranscript, ProtocolErrorCode, ProtocolV8, ProtocolVersionSource, ProtocolVersionUnknownReason, RetainedEraSubpath, TranscriptPojo, VersionResolutionPath, VersionedRecord, WrapKeepStateCallOptions };
+export { CURRENT_LEDGER_VERSION, ComposeFailedError, ComposeOptionError, DownConvertFailedError, INITIAL_LEDGER_PARAMETERS, LEDGER_VERSIONS, Ledger8InstanceMismatchError, Ledger8RuntimeInvalidError, Ledger8RuntimeMissingError, MerkleNotRehashedError, NO_CIRCUIT, PROTOCOL_ERROR_CODES, PayloadNotATransactionError, RETAINED_LEDGER_VERSIONS, StateDecodeFailedError, TRANSACTION_TAG_PREFIX, UnknownLedger8AxisError, UnknownLedgerVersionError, UnknownProtocolVersionError, loadLedger8, loadLedger8Engine, loadLedgerEra, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
+export type { CallTranscriptSource, ComposeCallEntry, ComposeCallOptions, ComposeDeployOptions, ComposeOption, ComposeStage, ConstructorResultPojo, ContractEntryPointPojo, ContractStatePojo, CurrentLedgerVersion, DeployResultPojo, DownConvertStage, DownConvertedState, EraPartitionCallOptions, ExecuteCircuitOptions, ExecuteConstructorOptions, Ledger8ChargedState, Ledger8DeployableContractState, Ledger8Engine, Ledger8InstanceAxis, Ledger8StateValue, LedgerEra, LedgerParametersOption, LedgerVersion, PartitionContext, PartitionedCallTranscript, ProtocolErrorCode, ProtocolV8, ProtocolVersionSource, ProtocolVersionUnknownReason, RetainedEraSubpath, RetainedLedgerVersion, TranscriptPojo, VersionResolutionPath, VersionedRecord, WrapKeepStateCallOptions };

package/dist/index.js

@@ -9,7 +9,7 @@ import { hashVerifierKey } from '@midnight-ntwrk/compact-js';
 import * as compactJs from '@midnight-ntwrk/compact-js';
 export { compactJs };
 import { l as loadLedger8 } from './shared/load-C0TZnEd2.js';
-export { LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord } from './version.js';
+export { CURRENT_LEDGER_VERSION, LEDGER_VERSIONS, RETAINED_LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord } from './version.js';
 import * as compactRuntime from '@midnight-ntwrk/compact-runtime';
 export { compactRuntime };
 import * as platformJs from '@midnight-ntwrk/platform-js';

package/dist/prove.d.ts

@@ -31,7 +31,7 @@ import { ProvingProvider } from '@midnightntwrk/ledger-v9';
  * version-tagged shape the rest of the flow expects.
  *
  * @see docs/adr/0006-version-tagged-payloads-at-provider-seams.md
- * @see docs/adr/0011-publish-era-handles-alongside-their-plain-data.md
+ * @see docs/adr/0010-publish-era-handles-alongside-their-plain-data.md
  */
 declare const proveV8Transaction: (txBytes: Uint8Array, provingProvider: ProvingProvider) => Promise<Uint8Array>;
 

package/dist/prove.js

@@ -67,7 +67,7 @@ const assertSerializedTransaction = (txBytes) => {
  * version-tagged shape the rest of the flow expects.
  *
  * @see docs/adr/0006-version-tagged-payloads-at-provider-seams.md
- * @see docs/adr/0011-publish-era-handles-alongside-their-plain-data.md
+ * @see docs/adr/0010-publish-era-handles-alongside-their-plain-data.md
  */
 const proveV8Transaction = async (txBytes, provingProvider) => {
     assertSerializedTransaction(txBytes);

package/dist/version.d.ts

@@ -10,6 +10,30 @@
  */
 declare const LEDGER_VERSIONS: readonly ["v8", "v9"];
 type LedgerVersion = (typeof LEDGER_VERSIONS)[number];
+/**
+ * The era whose objects this build hands out live, through `./ledger`.
+ *
+ * A protocol fact rather than a consumer's choice: it is decided by which
+ * ledger the package links eagerly, and every other era is reached lazily and
+ * crosses package boundaries as bytes. Declared here so that no package
+ * downstream restates "which era is now" as a literal of its own.
+ *
+ * The type is the single literal, not {@link LedgerVersion}, so a value typed
+ * by it DISCRIMINATES — the same discipline `CurrentPipelineEra` follows in
+ * `midnight-js-contracts`.
+ */
+declare const CURRENT_LEDGER_VERSION: "v9";
+type CurrentLedgerVersion = typeof CURRENT_LEDGER_VERSION;
+/**
+ * Every era this build still speaks but does not run live — the eras that
+ * cross a package boundary as serialized bytes.
+ *
+ * Defined as the complement of {@link CURRENT_LEDGER_VERSION}, so a further
+ * era joins this set by being added to {@link LEDGER_VERSIONS} and nothing
+ * else. The value list below is checked against that complement at build time.
+ */
+type RetainedLedgerVersion = Exclude<LedgerVersion, CurrentLedgerVersion>;
+declare const RETAINED_LEDGER_VERSIONS: readonly ["v8"];
 
 /**
  * Which call path asked for a ledger version:
@@ -83,7 +107,7 @@ declare const versionOfRecord: (record: VersionedRecord) => LedgerVersion;
  * will land in, and a stale reading is wrong exactly at the fork boundary,
  * where that question matters. `PublicDataProvider.queryLatestProtocolVersion`
  * states the same prohibition as a requirement on its implementations; this
- * parameter is a structural type, so nothing here can enforce it. See ADR 0008.
+ * parameter is a structural type, so nothing here can enforce it. See ADR 0007.
  *
  * @param source The indexer or node client to ask for the head version.
  * @returns A promise for the {@link LedgerVersion} at the network head.
@@ -93,5 +117,5 @@ declare const versionOfRecord: (record: VersionedRecord) => LedgerVersion;
  */
 declare const networkHeadVersion: (source: ProtocolVersionSource) => Promise<LedgerVersion>;
 
-export { LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
-export type { LedgerVersion, ProtocolVersionSource, VersionedRecord };
+export { CURRENT_LEDGER_VERSION, LEDGER_VERSIONS, RETAINED_LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
+export type { CurrentLedgerVersion, LedgerVersion, ProtocolVersionSource, RetainedLedgerVersion, VersionedRecord };

package/dist/version.js

@@ -25,6 +25,20 @@ import { UnknownProtocolVersionError } from './errors.js';
  * this leaf module and re-exported by `../version.ts`.
  */
 const LEDGER_VERSIONS = Object.freeze(['v8', 'v9']);
+/**
+ * The era whose objects this build hands out live, through `./ledger`.
+ *
+ * A protocol fact rather than a consumer's choice: it is decided by which
+ * ledger the package links eagerly, and every other era is reached lazily and
+ * crosses package boundaries as bytes. Declared here so that no package
+ * downstream restates "which era is now" as a literal of its own.
+ *
+ * The type is the single literal, not {@link LedgerVersion}, so a value typed
+ * by it DISCRIMINATES — the same discipline `CurrentPipelineEra` follows in
+ * `midnight-js-contracts`.
+ */
+const CURRENT_LEDGER_VERSION = 'v9';
+const RETAINED_LEDGER_VERSIONS = Object.freeze(['v8']);
 
 /*
  * This file is part of midnight-js.
@@ -104,7 +118,7 @@ const versionOfRecord = (record) => protocolVersionToLedger(record.protocolVersi
  * will land in, and a stale reading is wrong exactly at the fork boundary,
  * where that question matters. `PublicDataProvider.queryLatestProtocolVersion`
  * states the same prohibition as a requirement on its implementations; this
- * parameter is a structural type, so nothing here can enforce it. See ADR 0008.
+ * parameter is a structural type, so nothing here can enforce it. See ADR 0007.
  *
  * @param source The indexer or node client to ask for the head version.
  * @returns A promise for the {@link LedgerVersion} at the network head.
@@ -114,5 +128,5 @@ const versionOfRecord = (record) => protocolVersionToLedger(record.protocolVersi
  */
 const networkHeadVersion = async (source) => protocolVersionToLedger(await source.queryLatestProtocolVersion(), 'construct');
 
-export { LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
+export { CURRENT_LEDGER_VERSION, LEDGER_VERSIONS, RETAINED_LEDGER_VERSIONS, networkHeadVersion, protocolVersionToLedger, versionOfRecord };
 //# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sources":["../src/lib/shared/ledger-version.ts","../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;AAaG;AAEH;;;;;;;;;AASG;AACI,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,CAAU;;ACzBlE;;;;;;;;;;;;;AAaG;AA6BH;AACA;AACA,MAAM,oBAAoB,GAAG;AAC3B,IAAA,CAAC,EAAE,IAAI;AACP,IAAA,CAAC,EAAE;CACsD;AAQ3D;AACA;AACA,MAAM,YAAY,GAAG,CAAC,KAA6C,EAAE,GAAW,KAC9E,KAAK,CAAC,GAAG,CAAC;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACI,MAAM,uBAAuB,GAAG,CACrC,eAAuB,EACvB,IAAA,GAA8B,WAAW,KACxB;AACjB,IAAA,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,eAAe,GAAG,CAAC,EAAE;QAC7D,MAAM,IAAI,2BAA2B,CAAC,eAAe,EAAE,IAAI,EAAE,WAAW,CAAC;IAC3E;AACA,IAAA,MAAM,MAAM,GAAG,YAAY,CAAC,oBAAoB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC;AAC1F,IAAA,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,2BAA2B,CAAC,eAAe,EAAE,IAAI,EAAE,SAAS,CAAC;IACzE;AACA,IAAA,OAAO,MAAM;AACf;AAEA;;;;;;;;AAQG;AACI,MAAM,eAAe,GAAG,CAAC,MAAuB,KACrD,uBAAuB,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM;AAExD;;;;;;;;;;;;;;;;AAgBG;MACU,kBAAkB,GAAG,OAAO,MAA6B,KACpE,uBAAuB,CAAC,MAAM,MAAM,CAAC,0BAA0B,EAAE,EAAE,WAAW;;;;"}
+{"version":3,"file":"version.js","sources":["../src/lib/shared/ledger-version.ts","../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;AAaG;AAEH;;;;;;;;;AASG;AACI,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,CAAU;AAGlE;;;;;;;;;;;AAWG;AACI,MAAM,sBAAsB,GAAG;AAa/B,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAqD;;ACrDhH;;;;;;;;;;;;;AAaG;AA2CH;AACA;AACA,MAAM,oBAAoB,GAAG;AAC3B,IAAA,CAAC,EAAE,IAAI;AACP,IAAA,CAAC,EAAE;CACsD;AAQ3D;AACA;AACA,MAAM,YAAY,GAAG,CAAC,KAA6C,EAAE,GAAW,KAC9E,KAAK,CAAC,GAAG,CAAC;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACI,MAAM,uBAAuB,GAAG,CACrC,eAAuB,EACvB,IAAA,GAA8B,WAAW,KACxB;AACjB,IAAA,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,eAAe,GAAG,CAAC,EAAE;QAC7D,MAAM,IAAI,2BAA2B,CAAC,eAAe,EAAE,IAAI,EAAE,WAAW,CAAC;IAC3E;AACA,IAAA,MAAM,MAAM,GAAG,YAAY,CAAC,oBAAoB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC;AAC1F,IAAA,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,2BAA2B,CAAC,eAAe,EAAE,IAAI,EAAE,SAAS,CAAC;IACzE;AACA,IAAA,OAAO,MAAM;AACf;AAEA;;;;;;;;AAQG;AACI,MAAM,eAAe,GAAG,CAAC,MAAuB,KACrD,uBAAuB,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM;AAExD;;;;;;;;;;;;;;;;AAgBG;MACU,kBAAkB,GAAG,OAAO,MAA6B,KACpE,uBAAuB,CAAC,MAAM,MAAM,CAAC,0BAA0B,EAAE,EAAE,WAAW;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midnight-ntwrk/midnight-js-protocol",
-  "version": "5.0.0-beta.8-pre.765ca083",
+  "version": "5.0.0-beta.8",
   "type": "module",
   "description": "Protocol type re-exports for midnight-js framework",
   "types": "dist/index.d.ts",
@@ -104,6 +104,5 @@
   },
   "engines": {
     "node": ">=22.12"
-  },
-  "stableVersion": "5.0.0-beta.7"
+  }
 }