Skip to content

The Typescript SDK for building dapps on Alephium

License

LGPL-3.0, Unknown licenses found

Licenses found

LGPL-3.0
LICENSE
Unknown
license-header.js
Notifications You must be signed in to change notification settings

alephium/alephium-web3

Repository files navigation

Alephium Web3

Github CI NPM code style: prettier

A Typescript library for building decentralized applications on Alephium.

Getting started

You could run the following command to scaffold a skeleton project for smart contract development:

npx @alephium/cli init <project-dir> [-t (base | react | nextjs)]

Please read the documentation for more.

Packages

There are a few packages in this repository:

  1. @alephium/cli is the CLI tool for dApp development.
  2. @alephium/web3 is the core and base package for all dApp development.
  3. @alephium/web3-wallet contains wallet related functions.
  4. @alephium/web3-test contains test related functions.
  5. @alephium/web3-react contains react components to help authenticate and interact with the Alephium blockchain
  6. @alephium/get-extension-wallet contains functions to get the extension wallet object
  7. @alephium/walletconnect contains Alephium's WalletConnect implementation

Development

Please refer to package.json.