Added HashLips conversion and IPFS upload

Author: robdmoore

.gitignore

@@ -8,3 +8,4 @@ cache
 .DS_Store
 .idea
 .cache
+hashlips-output

README.md

@@ -27,18 +27,19 @@ We recommend you first execute this against a locally running Algorand sandbox n
 
 ### Regardless of whether minting against local Algorand emulator or not
 
-1. Open in VS Code (or your IDE of choice, although you'll get a better developer experience in VS Code since there are run and debug configurations and settings specified)
-2. Install recommended extensions
-3. Inside `minter`:
+1. Run your HashLips generator and copy the output from the `build` folder into the `hashlips-output` folder in this repository - that should result in a `hashlips-output/images` and `hashlips-output/json` folder
+2. Open in VS Code (or your IDE of choice, although you'll get a better developer experience in VS Code since there are run and debug configurations and settings specified)
+3. Install recommended extensions
+4. Inside `minter`:
 
    - Copy `.env.sample` to `.env` and fill in the relevant variables, including Web3.Storage token and, depending on whether you want to test against either the local sandbox or Algorand TestNet, the Algorand node config (e.g. via [AlgoNode](https://algonode.io/api/) or via [PureStake](https://purestake.io/), for which you would need to [create an account](https://developer.purestake.io/signup))
    - Run `npm install`
 
-4. Add the metadata for your particular NFT project in `minter/index.ts`
+5. Add the metadata for your particular NFT project in `minter/index.ts` (look for `NFT metadata - edit this`)
 
-5. (If using VS Code) Choose the thing you want to run/debug from the "Run and Debug" pane (ctrl+shift+D on Windows) and hit F5 and it will launch it with breakpoint debugging
+6. (If using VS Code) Choose the thing you want to run/debug from the "Run and Debug" pane (ctrl+shift+D on Windows) and hit F5 and it will launch it with breakpoint debugging
 
-6. OR (If not using VS Code) run `npm run dev` in the `minter` folder
+7. OR (If not using VS Code) run `npm run dev` in the `minter` folder
 
 ## Ongoing development
 

minter/index.ts

@@ -1,5 +1,8 @@
 import { Account, Algodv2 } from 'algosdk'
-import fs from 'fs'
+import fsSync from 'fs'
+import fs from 'fs/promises'
+import path from 'path'
+import { getFilesFromPath, Web3Storage } from 'web3.storage'
 import { CREATOR_ACCOUNT } from './constants'
 import { getAccount } from './functions/account'
 import { chunkArray } from './functions/array'
@@ -18,22 +21,47 @@ const mediaType = MediaType.Image
 /**** End of NFT metadata ******/
 /*********************************/
 
-if (!fs.existsSync('.env') && !process.env.ALGOD_SERVER) {
-  console.error('Copy .env.sample to .env before starting the application.')
+if (!fsSync.existsSync('.env') && (!process.env.ALGOD_SERVER || !process.env.WEB3_STORAGE_API_TOKEN)) {
+  console.error('Copy .env.sample to .env and fill in before starting the application.')
   process.exit(1)
 }
 ;(async () => {
   try {
     const client = await getAlgoClient()
+    const storage = new Web3Storage({ token: process.env.WEB3_STORAGE_API_TOKEN! })
     const creatorAccount = await getAccount(client, CREATOR_ACCOUNT)
 
-    // todo: Get HashLips metadata
-    const project = {
-      name: 'PROJECT',
-    }
+    // Upload images to IPFS
+    const cid = await uploadToIPFS(storage, '../hashlips-output/images/')
+
+    // Parse HashLips metadata output
     const nftsToMint: NFT[] = []
+    const hashLipsOutput = await fs.readdir(path.join(__dirname, '../hashlips-output/json'))
+    for (let metadataFile of hashLipsOutput) {
+      if (metadataFile === '_metadata.json') {
+        continue
+      }
 
-    console.log(`Minting NFTs for ${project.name}`)
+      const metadataJSON = await fs.readFile(path.join(__dirname, '../hashlips-output/json', metadataFile))
+      const metadata = JSON.parse(metadataJSON.toString('utf-8')) as HashLipsMetadata
+
+      const traits: Record<string, string> = {}
+      if (metadata.attributes) {
+        metadata.attributes.forEach((a) => {
+          traits[a.trait_type] = a.value
+        })
+      }
+
+      nftsToMint.push({
+        dna: metadata.dna,
+        imageUrl: metadata.image.replace('ipfs://NewUriToReplace/', `ipfs://${cid}/images/`),
+        name: metadata.name,
+        description: metadata.description,
+        traits: traits,
+      })
+    }
+
+    console.log(`Found ${nftsToMint.length} HashLips generated NFTs`)
 
     const accountInformation = await client.accountInformation(creatorAccount.addr).do()
     const existingAlgorandNFTs = (accountInformation['created-assets'] as AssetResult[]).filter(
@@ -84,6 +112,21 @@ if (!fs.existsSync('.env') && !process.env.ALGOD_SERVER) {
     process.exit(1)
   }
 })()
+interface HashLipsMetadataTrait {
+  trait_type: string
+  value: string
+}
+
+interface HashLipsMetadata {
+  compiler: string
+  date: number
+  description: string
+  dna: string
+  edition: number
+  image: string
+  name: string
+  attributes: HashLipsMetadataTrait[]
+}
 
 interface NFT {
   dna: string
@@ -94,6 +137,11 @@ interface NFT {
   traits?: Record<string, string>
 }
 
+async function uploadToIPFS(storage: Web3Storage, filePath: string) {
+  const fileRef = await getFilesFromPath(filePath)
+  return await storage.put(fileRef)
+}
+
 async function getAlgorandNFTTransaction(
   client: Algodv2,
   creatorAccount: Account,