merge sprint ending 8/20/24

.github/ISSUE_TEMPLATE/chain_request.md

@@ -7,6 +7,6 @@ assignees: ''
 
 ---
 
-Please include the network name, RPC url, chain id, native currency symbol, block explorer url, and whether or not the chain in your issue is a testnet.
+Please include the network name, RPC url, chain id, native currency symbol, block explorer url, your chain's logo, and whether or not the chain in your issue is a testnet.
 
 Please use [this issue](https://github.com/jk-labs-inc/jokerace/issues/2047) as a template! 

.gitignore

@@ -7,6 +7,7 @@ packages/react-app-revamp/public/workbox-*.js
 packages/react-app-revamp/public/worker-*.js
 
 
+
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 **/node_modules
 

README.md

@@ -20,13 +20,13 @@ NEXT_PUBLIC_R2_ACCOUNT_ID=
 NEXT_PUBLIC_R2_ACCESS_KEY_ID=
 NEXT_PUBLIC_R2_SECRET_ACCESS_KEY=
 NEXT_PUBLIC_MERKLE_TREES_BUCKET=
-NEXT_PUBLIC_IMAGE_UPLOAD_BUCKET=
-NEXT_PUBLIC_ETHERSCAN_KEY=
 ```
 
 Optional
 ```
 NEXT_PUBLIC_ALCHEMY_KEY=
+NEXT_PUBLIC_ETHERSCAN_KEY=
+NEXT_PUBLIC_IMAGE_UPLOAD_BUCKET=
 ```
 ## Getting Started
 

package.json

@@ -26,7 +26,7 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "husky": "9.1.4",
-    "turbo": "2.0.13"
+    "husky": "9.1.5",
+    "turbo": "2.0.14"
   }
 }

packages/image-processing-worker/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space

packages/image-processing-worker/.prettierrc

@@ -0,0 +1,6 @@
+{
+	"printWidth": 140,
+	"singleQuote": true,
+	"semi": true,
+	"useTabs": true
+}

packages/image-processing-worker/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@scaffold-eth/image-processing-worker",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "deploy": "wrangler deploy",
+    "dev": "wrangler dev",
+    "start": "wrangler dev",
+    "test": "vitest",
+    "cf-typegen": "wrangler types"
+  },
+  "devDependencies": {
+    "@cloudflare/vitest-pool-workers": "0.4.5",
+    "@cloudflare/workers-types": "4.20240815.0",
+    "@types/node": "22.3.0",
+    "typescript": "5.5.2",
+    "vitest": "1.5.0",
+    "wrangler": "3.60.3"
+  },
+  "dependencies": {
+    "jimp": "0.22.12"
+  }
+}

packages/image-processing-worker/src/index.ts

@@ -0,0 +1,121 @@
+import * as _Jimp from 'jimp';
+
+// @ts-ignore
+const Jimp = typeof self !== 'undefined' ? self.Jimp || _Jimp : _Jimp;
+
+interface Sizes {
+	[key: string]: { width: number; height: number };
+}
+
+const SIZES: Sizes = {
+	medium: { width: 600, height: 400 },
+	thumbnail: { width: 200, height: 200 },
+};
+
+export interface Env {
+	MY_BUCKET: R2Bucket;
+	IMAGE_QUEUE: Queue;
+}
+
+interface R2ObjectInfo {
+	key: string;
+	size: number;
+	eTag: string;
+}
+
+interface R2Event {
+	account: string;
+	bucket: string;
+	object: R2ObjectInfo;
+	action: string;
+	eventTime: string;
+}
+
+async function resizeImage(imageData: ArrayBuffer, maxWidth: number, maxHeight: number): Promise<ArrayBuffer> {
+	try {
+		const image = await Jimp.read(imageData);
+		const originalWidth = image.getWidth();
+		const originalHeight = image.getHeight();
+
+		// Calculate aspect ratio
+		const aspectRatio = originalWidth / originalHeight;
+
+		// Calculate new dimensions
+		let newWidth = maxWidth;
+		let newHeight = maxHeight;
+
+		if (aspectRatio > 1) {
+			// Image is wider than it is tall
+			newHeight = Math.round(newWidth / aspectRatio);
+			if (newHeight > maxHeight) {
+				newHeight = maxHeight;
+				newWidth = Math.round(newHeight * aspectRatio);
+			}
+		} else {
+			// Image is taller than it is wide
+			newWidth = Math.round(newHeight * aspectRatio);
+			if (newWidth > maxWidth) {
+				newWidth = maxWidth;
+				newHeight = Math.round(newWidth / aspectRatio);
+			}
+		}
+
+		image.resize(newWidth, newHeight, Jimp.RESIZE_BEZIER);
+		const quality = 80;
+		return await image.quality(quality).getBufferAsync(Jimp.MIME_JPEG);
+	} catch (error) {
+		console.error('Error resizing image:', error);
+		throw error;
+	}
+}
+
+export default {
+	async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+		if (request.method === 'POST') {
+			try {
+				const body = await request.json();
+				await env.IMAGE_QUEUE.send(body);
+				return new Response('Event queued for processing', { status: 202 });
+			} catch (error) {
+				return new Response('Error processing request', { status: 500 });
+			}
+		}
+		return new Response('Send a POST request with R2 event data to process an image');
+	},
+
+	async queue(batch: MessageBatch<R2Event>, env: Env, ctx: ExecutionContext): Promise<void> {
+		for (const message of batch.messages) {
+			const event: R2Event = message.body;
+			const key = event.object.key;
+
+			if (Object.keys(SIZES).some((size) => key.includes(`-${size}`))) {
+				continue;
+			}
+
+			try {
+				const r2Object = await env.MY_BUCKET.get(key);
+				if (!r2Object) {
+					console.error('Object not found:', key);
+					continue;
+				}
+
+				const imageData = await r2Object.arrayBuffer();
+
+				await Promise.all(
+					Object.entries(SIZES).map(async ([size, dimensions]) => {
+						const { height, width } = dimensions;
+						const resizedImageData = await resizeImage(imageData, width, height);
+						const newKey = `${key.replace(/\.[^/.]+$/, '')}-${size}`;
+						await env.MY_BUCKET.put(newKey, resizedImageData, {
+							httpMetadata: {
+								contentType: 'image/jpeg',
+							},
+						});
+					}),
+				);
+			} catch (error) {
+				console.error('Error processing image:', error);
+			}
+		}
+	},
+};

packages/image-processing-worker/test/index.spec.ts

@@ -0,0 +1,25 @@
+// test/index.spec.ts
+import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
+import { describe, it, expect } from 'vitest';
+import worker from '../src/index';
+
+// For now, you'll need to do something like this to get a correctly-typed
+// `Request` to pass to `worker.fetch()`.
+const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
+
+describe('Hello World worker', () => {
+	it('responds with Hello World! (unit style)', async () => {
+		const request = new IncomingRequest('http://example.com');
+		// Create an empty context to pass to `worker.fetch()`.
+		const ctx = createExecutionContext();
+		const response = await worker.fetch(request, env, ctx);
+		// Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
+		await waitOnExecutionContext(ctx);
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+
+	it('responds with Hello World! (integration style)', async () => {
+		const response = await SELF.fetch('https://example.com');
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+});

packages/image-processing-worker/test/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../tsconfig.json",
+	"compilerOptions": {
+		"types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
+	},
+	"include": ["./**/*.ts", "../src/env.d.ts"],
+	"exclude": []
+}

packages/image-processing-worker/tsconfig.json

@@ -0,0 +1,105 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+		/* Projects */
+		// "incremental": true,                              /* Enable incremental compilation */
+		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+		/* Language and Environment */
+		"target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+		"lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
+		"jsx": "react-jsx" /* Specify what JSX code is generated. */,
+		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+		/* Modules */
+		"module": "es2022" /* Specify what module code is generated. */,
+		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
+		"moduleResolution": "Bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
+		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		"types": [
+			"@cloudflare/workers-types/2023-07-01"
+		] /* Specify type package names to be included without being referenced in a source file. */,
+		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+		"resolveJsonModule": true /* Enable importing .json files */,
+		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+		/* JavaScript Support */
+		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
+		"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
+		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+		/* Emit */
+		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+		// "removeComments": true,                           /* Disable emitting comments. */
+		"noEmit": true /* Disable emitting files from a compilation. */,
+		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
+		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+		/* Interop Constraints */
+		"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
+		"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
+		// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+		/* Type Checking */
+		"strict": true /* Enable all strict type-checking options. */,
+		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+		/* Completeness */
+		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+	},
+	"exclude": ["test"],
+	"include": ["worker-configuration.d.ts", "src/**/*.ts"]
+}

packages/image-processing-worker/vitest.config.mts

@@ -0,0 +1,11 @@
+import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
+
+export default defineWorkersConfig({
+	test: {
+		poolOptions: {
+			workers: {
+				wrangler: { configPath: './wrangler.toml' },
+			},
+		},
+	},
+});

packages/image-processing-worker/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

packages/image-processing-worker/wrangler.toml

@@ -0,0 +1,20 @@
+name = "image-processing-worker"
+main = "src/index.ts"
+compatibility_date = "2023-05-18"
+node_compat = true
+
+[[r2_buckets]]
+binding = "MY_BUCKET"
+bucket_name = "jokerace-images"
+
+[[queues.producers]]
+queue = "image-processing-queue"
+binding = "IMAGE_QUEUE"
+
+[[queues.consumers]]
+queue = "image-processing-queue"
+max_batch_size = 10
+max_batch_timeout = 5
+
+[build]
+command = "yarn install"