diff options
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/abi-gen/README.md | 7 | ||||
| -rw-r--r-- | packages/abi-gen/src/index.ts | 7 |
2 files changed, 4 insertions, 10 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md index f1f8bd08f..b3e996269 100644 --- a/packages/abi-gen/README.md +++ b/packages/abi-gen/README.md @@ -1,6 +1,6 @@ # ABI Gen -This package allows you to generate contract wrappers in any language from ABI files. +This package allows you to generate TypeScript contract wrappers from ABI files. It's heavily inspired by [Geth abigen](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) but takes a different approach. You can write your custom handlebars templates which will allow you to seamlessly integrate the generated code into your existing codebase with existing conventions. @@ -18,10 +18,9 @@ Options: --abiGlob Glob pattern to search for ABI JSON files [string] [required] --templates Folder where to search for templates [string] [required] --output Folder where to put the output files [string] [required] - --fileExtension The extension of the output file [string] [required] ``` ## ABI files -You're required to pass a [glob](https://en.wikipedia.org/wiki/Glob_(programming) template where your abi files are located. +You're required to pass a [glob](https://en.wikipedia.org/wiki/Glob_(programming)) template where your abi files are located. TL;DR - here is the example from 0x.js. `--abiGlob 'src/artifacts/@(Exchange|Token|TokenTransferProxy|EtherToken|TokenRegistry).json` @@ -34,7 +33,7 @@ The best way to get started is to copy [0x.js templates](https://github.com/0xPr We use [handlebars](handlebarsjs.com) template engine under the hood. You need to have a master template called `contract.mustache`. it will be used to generate each contract wrapper. Although - you don't need and probably shouldn't write all your logic in a single template file. You can write [partial templates](http://handlebarsjs.com/partials.html) and as long as they are within a partials folder - they will be registered and available. ## Which data/context do I get in my templates? -For now you don't get much on top of methods abi and a contract name because it was enough for our use-case, but if you need something else - create a PR. +For now you don't get much on top of methods abi, some usefull helpers and a contract name because it was enough for our use-case, but if you need something else - create a PR. [Type definition](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen/src/types.ts) of what we pass to a render method. ## Output files Output files will be generated within an output folder with names converted to camel case and taken from abi file names. If you already have some files in that folder they will be overwritten. diff --git a/packages/abi-gen/src/index.ts b/packages/abi-gen/src/index.ts index 12b78f96f..19d289e49 100644 --- a/packages/abi-gen/src/index.ts +++ b/packages/abi-gen/src/index.ts @@ -33,16 +33,11 @@ const args = yargs type: 'string', demand: true, }) - .option('fileExtension', { - describe: 'The extension of the output file', - type: 'string', - demand: true, - }) .argv; function writeOutputFile(name: string, renderedTsCode: string): void { const fileName = toSnakeCase(name); - const filePath = `${args.output}/${fileName}.${args.fileExtension}`; + const filePath = `${args.output}/${fileName}.ts`; fs.writeFileSync(filePath, renderedTsCode); utils.log(`Created: ${chalk.bold(filePath)}`); } |