[feat] proposal bot to batch submit proposals

scripts/proposal-bot/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+	"singleQuote": true,
+	"printWidth": 80,
+	"semi": true,
+	"tabWidth": 2
+}

scripts/proposal-bot/README.md

@@ -0,0 +1,16 @@
+## Prepare tests:
+
+1. Run `cd scripts/proposal-bot`
+2. Run `yarn install`
+3. Install [ts-node](https://typestrong.org/ts-node/)
+
+# Run tests:
+
+From terminal 1:
+
+1. Run `./scripts/run-standalone.sh`
+2. Wait until Keygen completes
+
+From terminal 2:
+
+1. Run `ts-node ./src/submitProposals.ts` for anchor proposal tests

scripts/proposal-bot/package.json

@@ -0,0 +1,59 @@
+{
+	"name": "dkg-proposal-bot",
+	"version": "0.0.1",
+	"description": "proposal bot for dkg-substrate",
+	"main": "index.js",
+	"scripts": {
+		"script": "ts-node",
+		"format": "prettier --write '**/*.{ts,js,json,yml}'"
+	},
+	"author": "",
+	"license": "ISC",
+	"resolutions": {
+		"@webb-tools/api": "0.1.4-124",
+		"@webb-tools/api-derive": "0.1.4-124",
+		"@webb-tools/sdk-core": "0.1.4-124",
+		"@webb-tools/test-utils": "0.1.4-124",
+		"@webb-tools/dkg-substrate-types": "^0.0.5",
+		"@webb-tools/evm-test-utils": "0.5.39",
+		"@polkadot/api": "10.4.1",
+		"@polkadot/keyring": "10.1.5",
+		"@polkadot/networks": "10.1.5",
+		"@polkadot/types": "9.2.3",
+		"@polkadot/util": "10.1.5",
+		"@polkadot/util-crypto": "10.1.5"
+	},
+	"dependencies": {
+		"@polkadot/api": "^10.4.1",
+		"@polkadot/util": "^10.1.5",
+		"@types/chai": "^4.3.0",
+		"@types/mocha": "^9.1.0",
+		"@webb-tools/api": "0.1.4-124",
+		"@webb-tools/api-derive": "0.1.4-124",
+		"@webb-tools/dkg-substrate-types": "^0.0.5",
+		"@webb-tools/protocol-solidity": "0.5.39",
+		"@webb-tools/vbridge": "^0.5.39",
+		"@webb-tools/sdk-core": "0.1.4-124",
+		"@webb-tools/test-utils": "0.1.4-124",
+		"@webb-tools/evm-test-utils": "0.5.39",
+		"chai": "^4.3.6",
+		"ecpair": "^1.0.0",
+		"ethers": "^5.5.4",
+		"ganache": "7.4.1",
+		"mocha": "10.0.0",
+		"ora": "5",
+		"ts-node": "10.8.0",
+		"typescript": "4.5.4"
+	},
+	"engines": {
+		"node": "18.x.x"
+	},
+	"devDependencies": {
+		"husky": "^7.0.4",
+		"lint-staged": "^12.1.7",
+		"prettier": "2.5.1"
+	},
+	"lint-staged": {
+		"**/*": "prettier --write --ignore-unknown"
+	}
+}

scripts/proposal-bot/scripts/submitProposals.ts

@@ -0,0 +1,138 @@
+#!/usr/bin/env -S deno run -A --unstable
+/**
+The script connects to a Polkadot node, creates and submits batches of proposals, 
+and periodically prints debugging information about the proposal status.
+*/
+import { ApiPromise, WsProvider, Keyring } from '@polkadot/api';
+import { assert, u8aToHex } from '@polkadot/util';
+import {
+	ProposalHeader,
+	ResourceId,
+	ChainType,
+	AnchorUpdateProposal,
+} from '@webb-tools/sdk-core';
+
+// Number of proposals to send in one batch
+const PROPOSALS_TO_SEND_IN_ONE_BATCH = 10;
+// Node URL for the API connection
+const NODE_URL = "wss://tangle-standalone-archive.webb.tools";
+// Private key of the signer account
+const SIGNER_PVT_KEY = "//Alice";
+// Delay between proposal submission
+const DELAY_IN_MS = 5000;
+
+async function run() {
+	// Create an instance of the Polkadot API
+	const api = await ApiPromise.create({
+		provider: new WsProvider(NODE_URL),
+	});
+	await api.isReady;
+
+	// Create a keyring instance to manage accounts
+	const keyring = new Keyring({ type: 'sr25519' });
+
+	// Get the signer account from the private key
+	const sudoAccount = keyring.addFromUri(SIGNER_PVT_KEY);
+
+	// Create a resource ID for the main contract
+	const resourceId = ResourceId.newFromContractAddress(
+		'0xd30c8839c1145609e564b986f667b273ddcb8496',
+		ChainType.EVM,
+		1337
+	);
+
+	// Create a header for the proposal with a given nonce
+	const createHeader = (nonce: number) =>
+		new ProposalHeader(resourceId, Buffer.from('0x00000000', 'hex'), nonce);
+
+	// Create a resource ID for the source contract
+	const srcResourceId = ResourceId.newFromContractAddress(
+		'0xe69a847cd5bc0c9480ada0b339d7f0a8cac2b667',
+		ChainType.EVM,
+		1338
+	);
+
+	// Print resource IDs
+	console.log('Resource ID: ', resourceId.toString());
+	console.log('Source Resource ID: ', srcResourceId.toString());
+
+	// Fetch account nonce as a starting nonce for the proposals
+	const accountNonce = await api.rpc.system.accountNextIndex(
+		sudoAccount.address
+	);
+	let nonce = accountNonce.toNumber();
+
+	// Send a batch of proposals every block
+	while (true) {
+		let calls = [];
+
+		for (let i = 0; i < PROPOSALS_TO_SEND_IN_ONE_BATCH; i++) {
+			// Create the header for the proposal
+			const proposalHeader = createHeader(nonce);
+
+			// Ensure the proposal header has the correct length
+			assert(
+				proposalHeader.toU8a().length === 40,
+				`Proposal header should be 40 bytes, instead it is ${proposalHeader.toString().length} bytes`
+			);
+
+			// Create the anchor update proposal data structure
+			const anchorUpdateProposal: AnchorUpdateProposal = new AnchorUpdateProposal(
+				proposalHeader,
+				'0x0000000000000000000000000000000000000000000000000000000000000000',
+				srcResourceId
+			);
+
+			// Print the proposal bytes
+			console.log('Proposal Bytes:', u8aToHex(anchorUpdateProposal.toU8a()));
+
+			// Ensure the anchor update proposal has the correct length
+			assert(
+				anchorUpdateProposal.toU8a().length === 104,
+				`Anchor update proposal should be 104 bytes, instead it is ${anchorUpdateProposal.toString().length} bytes`
+			);
+
+			// Create the proposal kind and data
+			const kind = api.createType(
+				'WebbProposalsProposalProposalKind',
+				'AnchorUpdate'
+			);
+			const prop = api.createType('WebbProposalsProposal', {
+				Unsigned: {
+					kind,
+					data: u8aToHex(anchorUpdateProposal.toU8a()),
+				},
+			});
+
+			// Submit the unsigned proposal to the chain
+			const call = api.tx.dkgProposalHandler.forceSubmitUnsignedProposal(
+				prop.toU8a()
+			);
+
+			calls.push(call);
+		}
+
+		// Create a batch call with all the proposals
+		let batch_call = api.tx.utility.batch(calls);
+
+		// Sign and send the transaction as one batch
+		await new Promise(async (resolve, reject) => {
+			const unsub = await api.tx.sudo
+				.sudo(batch_call)
+				.signAndSend(sudoAccount, (result) => {
+					if (result.isFinalized || result.isInBlock || result.isError) {
+						unsub();
+						console.log(result.txHash.toHex(), "is", result.status.type);
+						resolve(result.isFinalized);
+					}
+				});
+		});
+
+		nonce += 1;
+
+		console.log("Waiting for ", DELAY_IN_MS);
+		await new Promise(resolve => setTimeout(resolve, DELAY_IN_MS));
+	}
+}
+
+run();

scripts/proposal-bot/tsconfig.json

@@ -0,0 +1,101 @@
+{
+	"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": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		// "jsx": "preserve",                                /* 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": "commonjs" /* Specify what module code is generated. */,
+		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
+		"moduleResolution": "node" /* 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": [],                                      /* 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": true,                                  /* 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. */
+	}
+}