validate manifest

Author: hazelnutcloud

CHANGELOG.md

@@ -1,5 +1,6 @@
 # v0.4.12 (unreleased)
 - fix: version number
+- feat: validate manifest when building and deploying
 
 # v0.4.11
 - fix: show error message when `arkive deploy` fails

cli/deploy/mod.ts

@@ -1,10 +1,11 @@
+import { parseArkiveManifest } from '../../mod.ts'
 import { join, wait } from '../deps.ts'
 import { cleanup } from './cleanup.ts'
 import { pkg } from './pkg.ts'
 import { upload } from './upload.ts'
 
 export const action = async (
-	options: { public?: true; major?: true, env?: string },
+	options: { public?: true; major?: true; env?: string },
 	directory: string,
 ) => {
 	const dev = options.env?.toLowerCase() === 'dev'
@@ -35,6 +36,11 @@ export const action = async (
 			throw new Error(`Manifest must have a name property.`)
 		}
 
+		const { problems } = parseArkiveManifest.manifest(manifest)
+		if (problems) {
+			throw new Error(`Invalid manifest: ${problems}`)
+		}
+
 		spinner.text = 'Uploading package...'
 		// upload package
 		await upload(fileName, tempPath, manifest, options)

deno.lock

@@ -16,3 +16,4 @@ export {
 	JSONBigIntReplacer,
 	JSONBigIntReviver,
 } from './src/utils.ts'
+export { parseArkiveManifest } from './src/arkiver/manifest-validator.ts'

mod.ts

@@ -19,6 +19,7 @@ import {
 	mongoose,
 } from '../deps.ts'
 import { getChainObjFromChainName } from '../utils.ts'
+import { parseArkiveManifest } from './manifest-validator.ts'
 
 export const manifestVersion = 'v1'
 
@@ -78,6 +79,11 @@ export class Manifest<TName extends string = ''> {
 	}
 
 	public build() {
+		const { problems } = parseArkiveManifest.manifest(this.manifest)
+		if (problems) {
+			throw new Error(`Invalid manifest: ${problems}`)
+		}
+		console.log(this.manifest)
 		return this.manifest
 	}
 }

src/arkiver/manifest-builder.ts

@@ -0,0 +1,47 @@
+import { supportedChains } from '../chains.ts'
+import { scope } from '../deps.ts'
+
+export const parseArkiveManifest = scope({
+	manifest: {
+		name: 'string',
+		'version?': /^v\d+$/,
+		dataSources: Object.fromEntries(
+			Object.keys(supportedChains).map((chain) => [`${chain}?`, 'dataSource']),
+		) as Record<`${keyof typeof supportedChains}?`, 'dataSource'>,
+		entities: 'entity[]',
+	},
+	dataSource: {
+		options: 'chainOptions',
+		'contracts?': 'contract[]',
+		'blockHandlers?': 'blockHandler[]',
+	},
+	entity: {
+		model: 'any',
+		list: 'boolean',
+		name: 'string',
+	},
+	chainOptions: {
+		blockRange: 'bigint',
+		rpcUrl: 'string',
+	},
+	contract: {
+		id: 'string',
+		abi: 'any[]',
+		sources: 'source[]',
+		events: 'eventSource[]',
+	},
+	blockHandler: {
+		handler: 'Function',
+		startBlockHeight: 'bigint|"live"',
+		blockInterval: 'bigint',
+		name: 'string',
+	},
+	source: {
+		address: /^0x[a-fA-F0-9]{40}$/,
+		startBlockHeight: 'bigint',
+	},
+	eventSource: {
+		name: 'string',
+		handler: 'Function',
+	},
+}).compile()

src/arkiver/manifest-validator.ts

@@ -3,6 +3,7 @@ export {
 	type Block,
 	createPublicClient,
 	decodeEventLog,
+	type DecodeEventLogReturnType,
 	encodeEventTopics,
 	getContract,
 	type GetContractReturnType,
@@ -11,7 +12,6 @@ export {
 	type Log,
 	type PublicClient,
 	type RpcLog,
-	type DecodeEventLogReturnType
 } from 'npm:viem'
 export {
 	type Abi,
@@ -33,3 +33,4 @@ export {
 	ConsoleHandler,
 } from 'https://deno.land/std@0.181.0/log/handlers.ts'
 export { crypto } from 'https://deno.land/std@0.186.0/crypto/mod.ts'
+export { scope } from 'npm:arktype'