1sat

1Sat SDK

Build apps on 1Sat Ordinals — BSV's protocol for NFTs, fungible tokens (BSV20/21), and on-chain data.

Fastest Start

Run the CLI immediately (no install):

bunx @1sat/cli

Add Agent Skills for Claude Code:

claude plugin install 1sat@b-open-io

# CLI tool usage and commands
npx skills add b-open-io/1sat-sdk --skill 1sat-cli

# Unified BSV indexing API (api.1sat.app)
npx skills add b-open-io/1sat-sdk --skill 1sat-stack

# Wallet popup + React hooks for browser dApps
npx skills add b-open-io/1sat-sdk --skill dapp-connect

# Ordinals marketplace (list/buy/cancel OrdLock listings)
npx skills add b-open-io/1sat-sdk --skill ordinals-marketplace

# BSV21 fungible token operations
npx skills add b-open-io/1sat-sdk --skill token-operations

# Transaction building with BRC-100 actions
npx skills add b-open-io/1sat-sdk --skill transaction-building

# Wallet setup (BRC-100, storage, sync)
npx skills add b-open-io/1sat-sdk --skill wallet-setup

# Mint and inscribe ordinals/NFTs
npx skills add b-open-io/1sat-sdk --skill wallet-create-ordinals

# Time-lock BSV until block height
npx skills add b-open-io/1sat-sdk --skill timelock

# Sweep/import from external WIF
npx skills add b-open-io/1sat-sdk --skill sweep-import

# OpNS on-chain name registration
npx skills add b-open-io/1sat-sdk --skill opns-names

# Extract inscribed media from blockchain
npx skills add b-open-io/1sat-sdk --skill extract-blockchain-media

Install packages for your app:

# Browser dApps — wallet popup connection
bun add @1sat/connect

# React apps
bun add @1sat/react

# Server / scripts — direct key access
bun add @1sat/actions @1sat/client @1sat/types

# Bitcoin script templates
bun add @1sat/templates

# Full BRC-100 wallet engine
bun add @1sat/wallet-browser  # or @1sat/wallet-node

What's in the Box

• Connect — Wallet popup connection (1sat.market) with extension auto-detection
• Ordinals — Inscribe, transfer, and list NFTs
• Tokens — Full support for BSV20 (tick) and BSV21 (origin) standards
• Marketplace — Create, purchase, and cancel OrdLock listings
• Signing — BSM message signing and Sigma protocol for data attestation
• Builder — Low-level transaction builder for custom flows
• Actions — Self-describing wallet operations for agents and tooling
• Wallet Engine — Full BRC-100 wallet with indexers, sync, and backup
• CLI — Terminal wallet with 30+ commands

Quick Start

Browser dApp

import { createOneSat } from '@1sat/connect'
import { Utils } from '@bsv/sdk'

const { toArray, toBase64 } = Utils

const onesat = createOneSat({
  appName: 'My dApp',
})

// Connect — opens wallet popup if no extension is installed
try {
  const { paymentAddress, ordinalAddress } = await onesat.connect()
  console.log('Connected:', paymentAddress)
} catch (err) {
  if (err instanceof UserRejectedError) {
    console.log('User closed the popup')
  }
}

// Inscribe
await onesat.inscribe({
  dataB64: toBase64(toArray('Hello, Ordinals!', 'utf8')),
  contentType: 'text/plain',
})

// Transfer ordinals
await onesat.sendOrdinals({
  outpoints: ['txid_vout'],
  destination: 'recipient-address',
})

// Transfer tokens
await onesat.transferToken({
  tokenId: 'token-origin',
  amount: '100',
  destinationAddress: 'recipient-address',
})

React

import { OneSatProvider, ConnectButton, useOneSatContext, useBalance } from '@1sat/react'

function App() {
  return (
    <OneSatProvider appName="My dApp">
      <ConnectButton />
      <WalletInfo />
    </OneSatProvider>
  )
}

function WalletInfo() {
  const { isConnected, paymentAddress } = useOneSatContext()
  const { satoshis, isLoading } = useBalance()

  if (!isConnected) return null

  return (
    <div>
      <p>Address: {paymentAddress}</p>
      <p>Balance: {satoshis} sats</p>
    </div>
  )
}

Server-Side / Scripts

For backends or scripts where you control the keys directly:

import { createOrdinals, fetchPayUtxos } from '@1sat/actions'
import { ArcadeClient } from '@1sat/client'
import { ONESAT_MAINNET_URL } from '@1sat/types'
import { PrivateKey, Utils } from '@bsv/sdk'

const { toArray, toBase64 } = Utils

// SERVER SIDE ONLY — never expose private keys in client code
const privateKey = PrivateKey.fromWif(process.env.WALLET_WIF!)
const address = privateKey.toAddress().toString()

// Fetch UTXOs from indexer
const utxos = await fetchPayUtxos(address)

// Create an inscription
const result = await createOrdinals({
  utxos,
  destinations: [{
    address,
    inscription: {
      dataB64: toBase64(toArray('Hello, Ordinals!', 'utf8')),
      contentType: 'text/plain',
    },
  }],
  paymentPk: privateKey,
  changeAddress: address,
})