Document generic types available in the `envio` package

[PaulRBerg]

I wanted to import the Envio generic types (e.g. genericEvent) not from my auto-generated types but from the envio package (the goal is to make code reuse easier between different indexers).

I looked up this information in the docs but it looks like this feature is not documented:

But the feature exists — the envio package exports generic types, as I can see on npmjs.com.

The types can be imported like so:

import type { genericEvent } from "envio/src/Internal.gen";

[DZakh]

Thanks for the feedback. We are in the process of refactoring HyperIndex from codegen-first to library-first format. A few releases ago we started exposing a few generic types directly from the envio package and we'll add even more in the future.

[PaulRBerg]

Great. In the meantime, we ended up hard-coding these types (FYI):

/**
 * @file Generic bindings needed because Envio doesn't export them.
 * @see https://github.com/enviodev/hyperindex/issues/532
 */
import type { t as Address_t } from "envio/src/Address.gen";
import type { genericEvent as Internal_genericEvent } from "envio/src/Internal.gen";

export type Address = Address_t;

export type AggregatedBlock_t = {
  readonly timestamp: number;
  readonly hash: string;
  readonly number: number;
};

export type AggregatedTransaction_t = {
  readonly to: undefined | Address_t;
  readonly hash: string;
  readonly transactionIndex: number;
  readonly value: bigint;
  readonly from: undefined | Address_t;
};

export type Block_t = {
  readonly number: number;
  readonly timestamp: number;
  readonly hash: string;
};

export type eventLog<params> = Internal_genericEvent<params, Block_t, Transaction_t>;
export type EventLog<params> = eventLog<params>;
export type Event<Params extends object = Record<string, unknown>> = EventLog<Params>;

export type Transaction_t = {
  readonly from: undefined | Address_t;
  readonly hash: string;
  readonly to: undefined | Address_t;
  readonly transactionIndex: number;
  readonly value: bigint;
};

[DZakh]

Could you share a link to the code? Curious to see how you use them 👀

[PaulRBerg]

Most of the types are not used directly but I hard-coded them in our code base just in case, so that I don't have to remember where to find them.

Here's the link — note that this URL may not be available in the future as I am planning on force pushing commits to this branch.

https://github.com/sablier-labs/indexers/blob/59dab80f49c28c4813897445e48c6d6e2cf91b47/src/envio/common/bindings.ts