dethcrypto / truffle-typechain-example

Example how to use Truffle suite with Typescript and Typechain

truffle-typechain-example

Deprecated. We moved examples to TypeChain repo: https://github.com/ethereum-ts/TypeChain/tree/master/examples

Example how to use Truffle suite with Typescript and Typechain

Usage:

Just run yarn generate to compile smartcontracts and generate initial TS wrappers for contracts. Then yarn test

Everytime you change contracts you need to run yarn generate.

Setup

1. Install truffle-typings. — yarn add --dev truffle-typings
2. Tweak truffle.js:

require("ts-node/register");

module.exports = {
  // this is required by truffle to find any ts test files
  test_file_extension_regexp: /.*\.ts$/,
};

3. Install typechain — yarn add --dev typechain

4. Add generate script in your package.json:

"scripts": {
    "generate": "truffle compile && typechain --target truffle './build/**/*.json'",
    "prepare": "yarn generate",
  }

5. Everytime you change contracts you need to run yarn generate.

6. Your migration functions should be typed as: Truffle.Migration and you sometimes need to make sure that they are treated as modules by tsc by adding: export {};.

7. If you run tests with truffle test you might need to tweak your tsconfig.json, otherwise you get missing import errors like Cannot find name 'artifacts'. An example config is provided in this project.

8. It's done! 🔥 Make sure to use .ts extension for everything

truffle-typechain-example's Issues

Can we use typechain in an Angular application

Hi,
Do you know if we can use TypeChain to generate the SmartContract from the ABI and use it in an Angular application ?
If yes, could you please provide an example ?

Truffle(@next) does not find any migrations with .ts extension

It can be configured with https://github.com/trufflesuite/truffle/blob/46fc7bdb9fde7cc3fa99b94fef04b1d6c04c38f7/packages/truffle-migrate/index.js#L30 but I have not figured out how to set it

No longer required to modify Truffle config to find .ts files

In the truffle-typechain-example README it says,

// this is required by truffle to find any ts test files
test_file_extension_regexp: /.*\.ts$/,

But from the Truffle docs, Truffle now supports tests saved as a .ts TypeScript file. (Source)

So I think that Tweak truffle.js step can be removed that from the README, right?