Skip to content

horuslabsio/starkzap

 
 

Repository files navigation

Starkzap — Bitcoin in your app in minutes

Twitter post - 3 (1)

Bring Bitcoin, stablecoins, and DeFi to any web or mobile app via Starknet in minutes. One TypeScript SDK: wallets, tokens, staking, and gasless transactions — with a clean API and great UX. Starknet’s account abstraction lets you hide blockchain complexity (no seed phrases, optional gasless flows). Works on web (React, Vite, etc.), iOS & Android (React Native, Expo), and Node.js backends.

Full documentation: docs.starknet.io/build/starkzap

Curated list of projects using Starkzap: awesome-starkzap

Starkzap Debugging Group: telegram chat


Installation

npm install starkzap

Peer dependencies (installed automatically with starkzap):

For specific integrations, you may need:

The package is published on npm as starkzap; use npm install starkzap and from "starkzap" when not developing from this repo.


Quick Start

import {
  StarkSDK,
  StarkSigner,
  OnboardStrategy,
  Amount,
  fromAddress,
  sepoliaTokens,
} from "starkzap";

const sdk = new StarkSDK({ network: "sepolia" });

const { wallet } = await sdk.onboard({
  strategy: OnboardStrategy.Signer,
  account: { signer: new StarkSigner("0xYOUR_PRIVATE_KEY") },
  deploy: "if_needed",
});

const STRK = sepoliaTokens.STRK;
const balance = await wallet.balanceOf(STRK);
console.log(balance.toFormatted()); // "150.25 STRK"

const tx = await wallet.transfer(STRK, [
  { to: fromAddress("0xRECIPIENT"), amount: Amount.parse("10", STRK) },
]);
await tx.wait();

For onboarding flows (Privy, Cartridge, etc.) and more examples, see the Quick Start guide.


Documentation

All guides and API reference live on the Starknet docs site. We recommend starting with Quick Start.


Examples

The repo includes web, mobile, and server examples in examples/. See the Examples docs for run instructions and details.


Contributors✨

Thanks goes to these wonderful people (emoji key):

</tr>
0xLucqs
0xLucas

💻
micbakos
micbakos

💻
0xsisyfos
0xsisyfos

💻
Akashneelesh
Akashneelesh

💻
Abdel @ StarkWare
Abdel @ StarkWare

💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!


Contributing

npm install
npm run typecheck
npm test
npm run test:integration   # requires starknet-devnet
npm run lint
npm run prettier
npm run build

Token and validator presets can be regenerated with npm run generate:tokens, npm run generate:tokens:sepolia, npm run generate:validators, and npm run generate:validators:sepolia.


License

MIT — 0xLucqs

About

Starknet SDK for seamless wallet integration

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 79.8%
  • MDX 18.9%
  • Other 1.3%