feat: shared package & remove samples (#2)

# 🤖 Linear Closes GIT-72 ## Description Base `shared` package with events structure and removed samples ## Checklist before requesting a review - [X] I have conducted a self-review of my code. - [X] I have conducted a QA. - [X] If it is a core feature, I have included comprehensive tests.
defi-wonderland · Oct 7, 2024 · e7544bc · e7544bc
2 parents 8500783 + ce24c18
commit e7544bc
Show file tree

Hide file tree

Showing 37 changed files with 321 additions and 382 deletions.
diff --git a/apps/sample-app/.env.example b/apps/sample-app/.env.example
diff --git a/apps/sample-app/README.md b/apps/sample-app/README.md
diff --git a/apps/sample-app/package.json b/apps/sample-app/package.json
diff --git a/apps/sample-app/src/config/env.ts b/apps/sample-app/src/config/env.ts
diff --git a/apps/sample-app/src/config/index.ts b/apps/sample-app/src/config/index.ts
diff --git a/apps/sample-app/src/index.ts b/apps/sample-app/src/index.ts
diff --git a/apps/sample-app/src/stats/balances.controller.ts b/apps/sample-app/src/stats/balances.controller.ts
diff --git a/apps/sample-app/src/stats/index.ts b/apps/sample-app/src/stats/index.ts
diff --git a/apps/sample-app/test/stats/controller/balances.controller.spec.ts b/apps/sample-app/test/stats/controller/balances.controller.spec.ts
diff --git a/apps/sample-app/tsconfig.build.json b/apps/sample-app/tsconfig.build.json
diff --git a/packages/sample-lib/src/exceptions/index.ts b/packages/sample-lib/src/exceptions/index.ts
diff --git a/packages/sample-lib/src/exceptions/invalidRpcUrl.exception.ts b/packages/sample-lib/src/exceptions/invalidRpcUrl.exception.ts
diff --git a/packages/sample-lib/src/external.ts b/packages/sample-lib/src/external.ts
diff --git a/packages/sample-lib/src/interfaces/blockchainProvider.interface.ts b/packages/sample-lib/src/interfaces/blockchainProvider.interface.ts
diff --git a/packages/sample-lib/src/interfaces/index.ts b/packages/sample-lib/src/interfaces/index.ts
diff --git a/packages/sample-lib/src/internal.ts b/packages/sample-lib/src/internal.ts
diff --git a/packages/sample-lib/src/providers/blockchainProvider.ts b/packages/sample-lib/src/providers/blockchainProvider.ts
diff --git a/packages/sample-lib/src/providers/index.ts b/packages/sample-lib/src/providers/index.ts
diff --git a/packages/sample-lib/test/unit/blockchainProvider.spec.ts b/packages/sample-lib/test/unit/blockchainProvider.spec.ts
diff --git a/packages/sample-lib/tsconfig.json b/packages/sample-lib/tsconfig.json
diff --git a/packages/sample-lib/vitest.config.ts b/packages/sample-lib/vitest.config.ts
diff --git a/packages/sample-lib/README.md → packages/shared/README.md b/packages/sample-lib/README.md → packages/shared/README.md
diff --git a/packages/sample-lib/package.json → packages/shared/package.json b/packages/sample-lib/package.json → packages/shared/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "@ts-turborepo-boilerplate/sample-lib",
+    "name": "@grants-stack-indexer/shared",
     "version": "0.0.1",
     "private": true,
     "description": "",
@@ -28,6 +28,6 @@
         "test:cov": "vitest run --config vitest.config.ts --coverage"
     },
     "dependencies": {
-        "viem": "2.21.4"
+        "viem": "2.21.19"
     }
 }
diff --git a/packages/shared/src/external.ts b/packages/shared/src/external.ts
@@ -0,0 +1 @@
+export type { AnyProtocolEvent, Address } from "./internal.js";
diff --git a/packages/sample-lib/src/index.ts → packages/shared/src/index.ts b/packages/sample-lib/src/index.ts → packages/shared/src/index.ts
diff --git a/packages/shared/src/internal.ts b/packages/shared/src/internal.ts
@@ -0,0 +1,2 @@
+export type { Address } from "viem";
+export * from "./types/index.js";
diff --git a/packages/shared/src/types/events/allo.ts b/packages/shared/src/types/events/allo.ts
@@ -0,0 +1,20 @@
+import { Address } from "../../internal.js";
+
+/**
+ * This type is used to represent a Allo events.
+ */
+export type AlloEvent = "PoolCreated";
+
+/**
+ * This type maps Allo events to their respective parameters.
+ */
+export type AlloEventParams<T extends AlloEvent> = T extends "PoolCreated"
+    ? PoolCreatedParams
+    : never;
+
+// =============================================================================
+// =============================== Event Parameters ============================
+// =============================================================================
+export type PoolCreatedParams = {
+    contractAddress: Address;
+};
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export type { AnyProtocolEvent, Address } from "./internal.js";
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export type { Address } from "viem";
		export * from "./types/index.js";