Soltsice

Solidity & TypeScript Integration, Configuration and Examples

Install

npm install soltsice --save

Quick Start Guide

You need to have Node and Typescript compilers installed.

npm install

npm run build:contracts

npm run soltsice

npm run testrpc

truffle migrate

truffle test

Usage

Soltsice allows to generate TypeScript files for Ethereum contracts with the command:

soltsice ./artifacts ./types

All .json artifacts from truffle compile in the folder artifacts will be transformed into TypeScript classes in types with a single index.ts file with all exports.

Every TypeScript contract class inherits SoltsiceContract, which is a wrapper over Truffle-contract with methods generated from ABI. If some functionality is not yet supported by Soltsice, you may use SoltsiceContract._instance : Promise<any> field to access untyped Truffle-contract instance.

You could import generated types as:

import { W3 } from "soltsice";
import { BigNumber } from "bignumber.js";
import { StandardToken } from "./types";

// default wrapper for web3: either window['web3'] if present,
// or http provider connected to localhost: 8545, if not running on https 
let w3: W3 = new W3());

// null for ctor params for newly deployed contracts
let st: StandardToken = new StandardToken("address of deployed contract", null, w3);

// note that typings are optional in variable definitions, TypeScript infers types
let supply: Promise<BigNumber> = st.totalSupply();

supply.then(value => {
    console.log("TOTAL SUPPLY", value.dividedBy(1e18).toFormat(0));
});

See a standalone minimal example here.

Type inference & intellisense

The purpose of this library is to have peace of mind and type safety when working with rapidly changing Solidity ABI. TypeScript wrappers over contracts allow to use powerful intellisense feature of code editors.

Methods with signatures

Typed Constructor

Workflow

Edit Solidity contracts, run truffle compile, run tests on Truffle stack (solidity or js)
Run Soltsice command soltsice ./src ./dest, all TypeScript contracts will be updated, any API changes will block subsequent TS compilation (except for rare edge cases such as multiple return parameters which are returned as an array and we use any TS type for them)
Adjust React components & stores to the changes.

Contributing

Some functionality such as Solidity libraries is not supported yet. Contributors are welcome!

License

MIT

carte7000 / Soltsice