https://github.com/midl-xyz/midl-js

MIDL Javascript SDK. Build Web3 apps on Bitcoin and MIDL with ease.
https://github.com/midl-xyz/midl-js

bitcoin bitcoin-api dapp hooks midl react typescript web3

Last synced: 3 months ago
JSON representation

MIDL Javascript SDK. Build Web3 apps on Bitcoin and MIDL with ease.

• Host: GitHub
• URL: https://github.com/midl-xyz/midl-js
• Owner: midl-xyz
• License: mit
• Created: 2024-07-25T09:42:04.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-02-10T12:12:52.000Z (4 months ago)
• Last Synced: 2026-02-10T15:42:49.370Z (4 months ago)
• Topics: bitcoin, bitcoin-api, dapp, hooks, midl, react, typescript, web3
• Language: TypeScript
• Homepage: https://js.midl.xyz/
• Size: 17.5 MB
• Stars: 36
• Watchers: 3
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/@midl/core)](https://www.npmjs.com/package/@midl/core)

[![npm downloads](https://img.shields.io/npm/dm/@midl/core)](https://www.npmjs.com/package/@midl/core)

[![codecov](https://codecov.io/gh/midl-xyz/midl-js/graph/badge.svg?token=TVJ2PAA1ZA)](https://codecov.io/gh/midl-xyz/midl-js)

[![license](https://img.shields.io/github/license/midl-xyz/midl-js)](LICENSE)

[![issues](https://img.shields.io/github/issues/midl-xyz/midl-js)](https://github.com/midl-xyz/midl-js/issues)

[![prs](https://img.shields.io/github/issues-pr/midl-xyz/midl-js)](https://github.com/midl-xyz/midl-js/pulls)






  

    

      

      

    

  





 Build Web3 dApps on Bitcoin and MIDL with TypeScript and React.



---

### Features

- **Connect to any Bitcoin network** (mainnet, testnet, regtest, etc.)

- **Publish transactions** to the Bitcoin network

- **Sign PSBTs**

- **Sign messages** using BIP322 and ECDSA

- **Transfer Runes**

- **Etch runes** on the blockchain

### Documentation

For detailed documentation, please visit our [documentation site](https://js.midl.xyz).

### Development

To contribute to the MIDL JS library, you can clone the repository and run the following commands:

```bash

# Install dependencies

pnpm install

# Build the project

pnpm build:packages

# Run tests

pnpm test:packages

```

#### Documentation

To contribute to the documentation, you can edit the Markdown files in the `apps/docs` directory. The documentation is built using [VitePress](https://vitepress.dev/).

Run the following command to start the documentation server:

```bash

pnpm docs:dev

```