sct

Smart Contract development and debugging toolkit

Usage no npm install needed!

<script type="module">
  import sct from 'https://cdn.skypack.dev/sct';
</script>

README

Smart Contract Toolkit

Help you better learn, develop and debug Smart Contract.

NPM version NPM downloads License

Build Coverage david deps david devDeps

✨ Features

  • ⚙️ Support CLI to quickly view output
  • 📦 Support import library to your project
  • 🛡️ Support Typescript

📦 Install

Using npm:

$ npm install sct -g # If you use CLI feautre
$ npm install sct --save

Or, using yarn:

$ yarn global add sct
$ yarn add sct

🔨 Usage

📦 Using library

import { convert } from 'sct'
// es5
// const { convert } = require('sct')

convert.stringToBytes('Welcome to use sct') // 0x57656c636f6d6520746f2075736520736374

Or, import on demand

import { stringToBytes } from 'sct/lib/convert'
// es5
// const { stringToBytes } = require('sct/lib/convert')

stringToBytes('Welcome to use sct') // 0x57656c636f6d6520746f2075736520736374

The full documentation is a available in here.

⚙️ Using CLI

$ sct convert

? What do you want to run? stringToBytes
? inputData: Welcome to use sct
? Do you need extra args? No
Convert function "stringToBytes" output:
0x57656c636f6d6520746f2075736520736374

Or, run specify function

$ sct convert -r stringToBytes

? inputData: Welcome to use sct
? Do you need extra args? No
Convert function "stringToBytes" output:
0x57656c636f6d6520746f2075736520736374

See more, please you use sct -h

✂️ Development

Folders

├── bin           # CLI code
├── src           # source code
├── test          # test code
├── docs.md       # documentation in markdown
└── package.json

Local development

Fork and git clone

$ npm install
$ npm run dev
$ npm link
$ sct convert # Or other

Then check output

Test Case and Lint

Lint source code

$ npm run lint

Run test case

$ npm test

📢 About the version number

Because package name sct was transferred to me by NPM team, there was already version 2.0.0 before, and the previous version has nothing to do with this open source project, so the package version started from 3.0.0.