eosio-abi2ts

eosio-abi2ts

Command line tool to generate TypeScript type definitions from EOSIO ABI files.

Installation

npm install -g eosio-abi2ts

or

yarn global add eosio-abi2ts

Usage

$ eosio-abi2ts -h
usage: eosio-abi2ts [-h] [-v] [-i INPUT] [-p PREFIX] [-n INDENT] [-t] [-e]
                    [-a | -c | -s]
                    [output]

Positional arguments:
  output                Output file to write to instead of stdout.

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -i INPUT, --input INPUT
                        Read ABI JSON from file instead of stdin.
  -p PREFIX, --prefix PREFIX
                        Prefix to add to every type.
  -n INDENT, --indent INDENT
                        How many spaces or tabs to indend with.
  -t, --use-tabs        Use tabs instead of spaces for indentation.
  -e, --export          Whether to export interfaces and types.
  -a, --pascal-case     Format types using PascalCase (default).
  -c, --camel-case      Format types using camelCase.
  -s, --snake-case      Format types using snake_case.

Example

$ cleos get abi eosio.token | eosio-abi2ts
// Generated by eosio-abi2ts 1.0.0 - eosio::abi/1.0

type Asset = string
type Name = string
type Symbol = string
type AccountName = Name

interface Transfer {
    from: AccountName
    to: AccountName
    quantity: Asset
    memo: string
}

interface Create {
    issuer: AccountName
    maximum_supply: Asset
}

interface Issue {
    to: AccountName
    quantity: Asset
    memo: string
}

interface Retire {
    quantity: Asset
    memo: string
}

interface Close {
    owner: AccountName
    symbol: Symbol
}

interface Account {
    balance: Asset
}

interface CurrencyStats {
    supply: Asset
    max_supply: Asset
    issuer: AccountName
}