Skip to content

Typesafe React hooks for seamless ink! smart contract interactions, powered by https://dedot.dev!

License

Notifications You must be signed in to change notification settings

dedotdev/typink

Repository files navigation

typink-bg 2

Typink

A comprehensive toolkit for ink! dApps development, powered by Dedot!

Version Unit test E2E test License Chat on Telegram


Features

  • ✅ Fully typesafe react hooks at contract messages & events level
  • ✅ Choose your favorite wallet connector (Built-in Typink Connector, SubConnect, Talisman Connect, or build your own connector ...)
  • ✅ Start a new project from scratch in seconds with create-typink cli.
  • ✅ Multi-chain supports, lazily initialize when in-use.
  • ⏳ ... and more to come

Quick look

typink-suggestions

Getting started

Start a new project from scratch via create-typink cli

Typink comes with a cli to help you start a new project from scratch faster & easier, to create a new project, run the below command:

npx create-typink@latest

Important

The create-typink cli requires NodeJS version >= v20 to work properly, make sure to check your NodeJS version.

Following the instructions, the cli will help you generate a starter & working project ready for you to start integrate your own contracts and build your own logic:

new-typink-project

Important

Please note that yarn is the current default package manager for the start project, make sure to install yarn on your machine to streamline the development process.

Migrate from existing projects?

Install typink & dedot packages:

# via npm
npm i typink dedot

# via yarn
yarn add typink dedot

# via pnpm
pnpm add typink dedot

Typink heavily uses Typescript to enable & ensure type-safety, so we recommend using Typescript for your Dapp project. Typink will also work with plain Javascript, but you don't get the auto-completion & suggestions when interacting with your ink! contracts.

Documentation

Check out Typink documentation on our website: https://typink.dev

Example Dapps

License

MIT

Acknowledgements

Funded by W3F