Class Epoch

constructor

• new Epoch(integer: bigint, numerator: bigint, denominator: bigint): Epoch

  Construct a new Epoch.

  The constructor enforces a positive denominator. If denominator is non-positive an Error is thrown.

  Parameters

  • integer: bigint

    Whole number portion of the epoch.
  • numerator: bigint

    Fractional numerator.
  • denominator: bigint

    Fractional denominator (must be > 0).

  Returns Epoch

Readonlyinteger

Readonlynumerator

Readonlydenominator

0

• get "0"(): bigint

  Returns bigint

  Deprecated

  use integer instead Backwards-compatible array-style index 0 referencing the whole epoch integer.

1

• get "1"(): bigint

  Returns bigint

  Deprecated

  use numerator instead Backwards-compatible array-style index 1 referencing the epoch fractional numerator.

2

• get "2"(): bigint

  Returns bigint

  Deprecated

  use denominator instead Backwards-compatible array-style index 2 referencing the epoch fractional denominator.

Staticfrom

• from(epochLike: EpochLike): Epoch

  Create an Epoch from an EpochLike value.

  Accepts:

  • an Epoch instance (returned as-is)
  • an object { integer, numerator, denominator } where each field is NumLike
  • a tuple [integer, numerator, denominator] where each element is NumLike

  All returned fields are converted to Num using numFrom.

  Parameters

  • epochLike: EpochLike

    Value to convert into an Epoch.

  Returns Epoch

  A new or existing Epoch instance.

Staticzero

• zero(): Epoch

  Return an epoch representing zero (0 + 0/1).

  Returns Epoch

StaticoneCycle

• oneCycle(): Epoch

  Return an epoch representing one cycle (180 + 0/1).

  This is a NervosDAO convenience constant.

  Returns Epoch

compare

• compare(other: EpochLike): -1 | 0 | 1

  Compare this epoch to another EpochLike.

  Comparison is performed by converting both epochs to a common integer representation: (integer * denominator + numerator) scaled by the other's denominator.

  Parameters

  • other: EpochLike

    EpochLike value to compare against.

  Returns -1 | 0 | 1

  1 if this > other, 0 if equal, -1 if this < other.

eq

• eq(other: EpochLike): boolean

  Check equality with another EpochLike.

  Parameters

  • other: EpochLike

    EpochLike to test equality against.

  Returns boolean

  true if both epochs represent the same value.

normalized

• normalized(): Epoch

  Return a normalized epoch:

  • Ensures numerator is non-negative by borrowing from integer if needed.
  • Reduces the fraction (numerator/denominator) by their GCD.
  • Carries any whole units from the fraction into integer.

  Returns Epoch

  A new, normalized Epoch instance.

add

• add(other: EpochLike): Epoch

  Add another epoch to this one.

  If denominators differ, the method aligns to a common denominator before adding the fractional numerators, then returns a normalized Epoch.

  Parameters

  • other: EpochLike

    EpochLike to add.

  Returns Epoch

  New Epoch equal to this + other.

sub

• sub(other: EpochLike): Epoch

  Subtract an epoch from this epoch.

  Parameters

  • other: EpochLike

    EpochLike to subtract.

  Returns Epoch

  New Epoch equal to this - other.

toUnix

• toUnix(reference: ClientBlockHeader): bigint

  Convert this epoch to an estimated Unix timestamp in milliseconds using as reference the block header.

  Parameters

  • reference: ClientBlockHeader

    ClientBlockHeader providing a reference epoch and timestamp.

  Returns bigint

  Unix timestamp in milliseconds as bigint.