Descriptor V2

.github/workflows/contracts.yaml

@@ -6,10 +6,13 @@ on:
       - master
   pull_request:
     paths:
-      - "packages/nouns-contracts/**"
-      - "packages/nouns-subgraph/**"
+      - 'packages/nouns-contracts/**'
+      - 'packages/nouns-subgraph/**'
     branches:
-      - "**"
+      - '**'
+
+env:
+  NODE_OPTIONS: --max_old_space_size=5120
 
 jobs:
   build_and_test:
@@ -50,4 +53,4 @@ jobs:
       - name: Run Forge tests
         run: |
           cd packages/nouns-contracts
-          forge test -vvv
+          forge test -vvv --ffi

packages/nouns-assets/images_test/create_duplicates.py

@@ -0,0 +1,28 @@
+"""
+Copies all the images in the subfolders
+This is just used for testing purposes
+"""
+
+import os
+import shutil
+
+
+def get_subfolders(directory):
+    return [f.path for f in os.scandir(directory) if f.is_dir()]
+
+
+def run():
+    for folder in get_subfolders('.'):
+        print(f"Going into {folder}")
+        f = os.listdir(folder)[0]
+        print(f"Found {f}, duplicating it")
+        for i in range(100):
+            dst_file = f.replace('.png', '_%03d.png' % i)
+            shutil.copyfile(os.path.join(folder, f),
+                            os.path.join(folder, dst_file))
+
+    print("Done")
+
+
+if __name__ == "__main__":
+    run()

packages/nouns-assets/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nouns/assets",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Nouns run-length encoded image data",
   "author": "Nounders",
   "homepage": "https://nouns.wtf",
@@ -9,13 +9,15 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "encode": "ts-node scripts/encode.ts",
+    "encode-more": "ts-node scripts/encode-more.ts",
+    "append-image-data": "ts-node scripts/append-image-data.ts",
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
     "build": "tsc -p tsconfig.build.json",
     "prepare": "yarn build",
     "test": "mocha -r ts-node/register \"test/**/*.test.ts\""
   },
   "devDependencies": {
-    "@nouns/sdk": "^0.1.4",
+    "@nouns/sdk": "^0.2.0",
     "@types/pngjs": "^6.0.1",
     "chai": "^4.2.0",
     "mocha": "^8.4.0",

packages/nouns-assets/scripts/append-image-data.ts

@@ -0,0 +1,20 @@
+import { ImageData } from '@nouns/sdk/src/image/types';
+import { promises as fs } from 'fs';
+
+/**
+ * Appends an image-data.json file to an existing one.
+ * The purpose is for the webapp to have one file with all the art, not split to pages like in the contracts storage
+ */
+const merge = async (baseFile: string, newFile: string, destinationFile: string) => {
+  const baseData: ImageData = JSON.parse((await fs.readFile(baseFile)).toString());
+  const newData: ImageData = JSON.parse((await fs.readFile(newFile)).toString());
+
+  for (const [k, v] of Object.entries(newData.images)) {
+    baseData.images[k].push(...v);
+  }
+
+  await fs.writeFile(destinationFile, JSON.stringify(baseData, null, 2));
+  console.log(`Wrote merged file to: ${destinationFile}`);
+};
+
+merge(process.argv[2], process.argv[3], process.argv[4]);

packages/nouns-assets/scripts/encode-more.ts

@@ -0,0 +1,37 @@
+import { PNGCollectionEncoder } from '@nouns/sdk';
+import { promises as fs } from 'fs';
+import path from 'path';
+import { readPngImage } from './utils';
+import { palette } from '../src/image-data.json';
+
+/**
+ * @notice creates an additional art json file. it assumes it's not the first one.
+ *   it also assumes the existing palette from the first one has all the needed colors.
+ * @sourceFolder a folder containing subfolders with the names: ['1-bodies', '2-accessories', '3-heads', '4-glasses']
+ * @destinationFilepath where to save the new json file
+ */
+const encode = async (sourceFolder: string, destinationFilepath: string) => {
+  const encoder = new PNGCollectionEncoder(palette);
+
+  const partfolders = ['1-bodies', '2-accessories', '3-heads', '4-glasses'];
+  for (const folder of partfolders) {
+    const folderpath = path.join(sourceFolder, folder);
+    const files = await fs.readdir(folderpath);
+    for (const file of files) {
+      const image = await readPngImage(path.join(folderpath, file));
+      encoder.encodeImage(file.replace(/\.png$/, ''), image, folder.replace(/^\d-/, ''));
+    }
+  }
+  await fs.writeFile(
+    destinationFilepath,
+    JSON.stringify(
+      {
+        images: encoder.data.images,
+      },
+      null,
+      2,
+    ),
+  );
+};
+
+encode(process.argv[2], process.argv[3]);

packages/nouns-assets/scripts/encode.ts

@@ -1,34 +1,10 @@
 import { PNGCollectionEncoder, PngImage } from '@nouns/sdk';
 import { promises as fs } from 'fs';
-import { PNG } from 'pngjs';
 import path from 'path';
+import { readPngImage } from './utils';
 
 const DESTINATION = path.join(__dirname, '../src/image-data.json');
 
-/**
- * Read a PNG image file and return a `PngImage` object.
- * @param path The path to the PNG file
- */
-const readPngImage = async (path: string): Promise<PngImage> => {
-  const buffer = await fs.readFile(path);
-  const png = PNG.sync.read(buffer);
-
-  return {
-    width: png.width,
-    height: png.height,
-    rgbaAt: (x: number, y: number) => {
-      const idx = (png.width * y + x) << 2;
-      const [r, g, b, a] = [png.data[idx], png.data[idx + 1], png.data[idx + 2], png.data[idx + 3]];
-      return {
-        r,
-        g,
-        b,
-        a,
-      };
-    },
-  };
-};
-
 const encode = async () => {
   const encoder = new PNGCollectionEncoder();
 

packages/nouns-assets/scripts/utils.ts

@@ -0,0 +1,27 @@
+import { PngImage } from '@nouns/sdk';
+import { promises as fs } from 'fs';
+import { PNG } from 'pngjs';
+
+/**
+ * Read a PNG image file and return a `PngImage` object.
+ * @param path The path to the PNG file
+ */
+export const readPngImage = async (path: string): Promise<PngImage> => {
+  const buffer = await fs.readFile(path);
+  const png = PNG.sync.read(buffer);
+
+  return {
+    width: png.width,
+    height: png.height,
+    rgbaAt: (x: number, y: number) => {
+      const idx = (png.width * y + x) << 2;
+      const [r, g, b, a] = [png.data[idx], png.data[idx + 1], png.data[idx + 2], png.data[idx + 3]];
+      return {
+        r,
+        g,
+        b,
+        a,
+      };
+    },
+  };
+};