archiver stores L1ToL2 pending messages

[rahul-kothari]

Description

Next step is the sequencer actually consuming the said messages - this will be a separate PR since this is big enough already.

Fixes #520

Checklist:

• I have reviewed my diff in github, line by line.
• Every change is related to the PR description.
• I have linked this pull request to the issue(s) that it resolves.
• There are no unexpected formatting changes, superfluous debug logs, or commented-out code.
• The branch has been merged or rebased against the head of its merge target.
• I'm happy for the PR to be merged at the reviewer's next convenience.

[Maddiaa0]

Does this decrease the size of the existing pendingMessages array? Or does it leave the sampled data there.

[rahul-kothari]

sampled for now - will remove in #529

[LHerskind]

Add a type for the return value.

[rahul-kothari]

Ah I tried but it gets quite ugly (which is why none of the methods here have a return type.
Basically you add a return type like : Promise<{ nextEthBlockNumber: bigint; retrievedData: L1ToL2Message[]}> and then the linter says Missing JDoc statement - except the linter wants the jdoc statement in the return statement itself (L143) as opposed to on L135.

[Maddiaa0]

You could make a generic type for each:

/**
 * Data retreived from logs
 */
type RollupLog<T> = {
  /**
   * The next block number.
   */
  nextEthBlockNumber: bigint;
  /**
   * The data returned.
   */
  retrievedData: T[];
}

Then have the return type be:

func something(): Promise<RollupLog<L1ToL2Message>> {}

should do the trick and appease the linter

[spalladino]

Nothing to add from my end on top of @Maddiaa0 and @LHerskind comments. Feel free to loop in @spypsy if you want a review from an Otter more familiar with the archiver than myself!

[Maddiaa0]

You could make a generic type for each:

/**
 * Data retreived from logs
 */
type RollupLog<T> = {
  /**
   * The next block number.
   */
  nextEthBlockNumber: bigint;
  /**
   * The data returned.
   */
  retrievedData: T[];
}

Then have the return type be:

func something(): Promise<RollupLog<L1ToL2Message>> {}

should do the trick and appease the linter