cerc-io/watcher-ts
16
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2025-01-08 12:28:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add watcher generation mode none (#92)

Browse Source
This commit is contained in:
prathamesh0 2021-12-23 11:29:09 +05:30 committed by nabarun
parent 8b5d408f77
commit 44e18fee48
3 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/codegen/README.md
View File

@ -21,7 +21,7 @@
* Run the following command to generate a watcher from a contract file: * Run the following command to generate a watcher from a contract file:
```bash ```bash
yarn codegen --input-files <input-file-paths> --contract-names <contract-names> --output-folder [output-folder] --mode [eth_call | storage | all] --flatten [true | false] --kind [lazy | active] --port [server-port] --subgraph-path [subgraph-build-path] yarn codegen --input-files <input-file-paths> --contract-names <contract-names> --output-folder [output-folder] --mode [eth_call | storage | all | none] --flatten [true | false] --kind [lazy | active] --port [server-port] --subgraph-path [subgraph-build-path]
``` ```
* `input-files`(alias: `i`): Input contract file path(s) or URL(s) (required). * `input-files`(alias: `i`): Input contract file path(s) or URL(s) (required).
@ -63,10 +63,10 @@
This will create a folder called `demo-erc20-watcher` containing the generated code at the specified path. Follow the steps in [Run Generated Watcher](#run-generated-watcher) to setup and run the generated watcher. This will create a folder called `demo-erc20-watcher` containing the generated code at the specified path. Follow the steps in [Run Generated Watcher](#run-generated-watcher) to setup and run the generated watcher.
Generate code for `Eden` contracts in `storage` mode, `active` kind: Generate code for `Eden` contracts in `none` mode, `active` kind:
```bash ```bash
yarn codegen --input-files ~/vulcanize/governance/contracts/EdenNetwork.sol ~/vulcanize/governance/contracts/MerkleDistributor.sol ~/vulcanize/governance/contracts/DistributorGovernance.sol --contract-names EdenNetwork MerkleDistributor DistributorGovernance --output-folder ../demo-eden-watcher --mode storage --kind active --subgraph-path ~/vulcanize/eden-data/packages/subgraph/build yarn codegen --input-files ~/vulcanize/governance/contracts/EdenNetwork.sol ~/vulcanize/governance/contracts/MerkleDistributor.sol ~/vulcanize/governance/contracts/DistributorGovernance.sol --contract-names EdenNetwork MerkleDistributor DistributorGovernance --output-folder ../demo-eden-watcher --mode none --kind active --subgraph-path ~/vulcanize/eden-data/packages/subgraph/build
``` ```
## Run Generated Watcher ## Run Generated Watcher

36
packages/codegen/src/generate-code.ts
View File

@ -14,7 +14,7 @@ import { flatten } from '@poanet/solidity-flattener';
import { parse, visit } from '@solidity-parser/parser'; import { parse, visit } from '@solidity-parser/parser';
import { KIND_ACTIVE, KIND_LAZY } from '@vulcanize/util'; import { KIND_ACTIVE, KIND_LAZY } from '@vulcanize/util';
import { MODE_ETH_CALL, MODE_STORAGE, MODE_ALL } from './utils/constants'; import { MODE_ETH_CALL, MODE_STORAGE, MODE_ALL, MODE_NONE } from './utils/constants';
import { Visitor } from './visitor'; import { Visitor } from './visitor';
import { exportServer } from './server'; import { exportServer } from './server';
import { exportConfig } from './config'; import { exportConfig } from './config';
@ -58,7 +58,7 @@ const main = async (): Promise<void> => {
describe: 'Code generation mode.', describe: 'Code generation mode.',
type: 'string', type: 'string',
default: MODE_ALL, default: MODE_ALL,
choices: [MODE_ETH_CALL, MODE_STORAGE, MODE_ALL] choices: [MODE_ETH_CALL, MODE_STORAGE, MODE_ALL, MODE_NONE]
}) })
.option('kind', { .option('kind', {
alias: 'k', alias: 'k',
@ -113,6 +113,20 @@ const main = async (): Promise<void> => {
}; };
function parseAndVisit (contractStrings: string[], visitor: Visitor, mode: string) { function parseAndVisit (contractStrings: string[], visitor: Visitor, mode: string) {
const eventDefinitionVisitor = visitor.eventDefinitionVisitor.bind(visitor);
let functionDefinitionVisitor;
let stateVariableDeclarationVisitor;
// Visit function definitions only if mode is MODE_ETH_CALL | MODE_ALL.
if ([MODE_ALL, MODE_ETH_CALL].includes(mode)) {
functionDefinitionVisitor = visitor.functionDefinitionVisitor.bind(visitor);
}
// Visit state variable declarations only if mode is MODE_STORAGE | MODE_ALL.
if ([MODE_ALL, MODE_STORAGE].includes(mode)) {
stateVariableDeclarationVisitor = visitor.stateVariableDeclarationVisitor.bind(visitor);
}
for (const contractString of contractStrings) { for (const contractString of contractStrings) {
// Get the abstract syntax tree for the flattened contract. // Get the abstract syntax tree for the flattened contract.
const ast = parse(contractString); const ast = parse(contractString);
@ -120,19 +134,11 @@ function parseAndVisit (contractStrings: string[], visitor: Visitor, mode: strin
// Filter out library nodes. // Filter out library nodes.
ast.children = ast.children.filter(child => !(child.type === 'ContractDefinition' && child.kind === 'library')); ast.children = ast.children.filter(child => !(child.type === 'ContractDefinition' && child.kind === 'library'));
if ([MODE_ALL, MODE_ETH_CALL].includes(mode)) { visit(ast, {
visit(ast, { FunctionDefinition: functionDefinitionVisitor,
FunctionDefinition: visitor.functionDefinitionVisitor.bind(visitor), StateVariableDeclaration: stateVariableDeclarationVisitor,
EventDefinition: visitor.eventDefinitionVisitor.bind(visitor) EventDefinition: eventDefinitionVisitor
}); });
}
if ([MODE_ALL, MODE_STORAGE].includes(mode)) {
visit(ast, {
StateVariableDeclaration: visitor.stateVariableDeclarationVisitor.bind(visitor),
EventDefinition: visitor.eventDefinitionVisitor.bind(visitor)
});
}
} }
} }

1
packages/codegen/src/utils/constants.ts
View File

@ -5,3 +5,4 @@
export const MODE_ETH_CALL = 'eth_call'; export const MODE_ETH_CALL = 'eth_call';
export const MODE_STORAGE = 'storage'; export const MODE_STORAGE = 'storage';
export const MODE_ALL = 'all'; export const MODE_ALL = 'all';
export const MODE_NONE = 'none';