This page is the index for everything in the DigiDollar Toolkit: the code you run, the guides you read, and the real-world case study behind it. If you're not sure where to begin, start with the table below — it points you to the right doc for who you are and what you're trying to do.
New to DigiDollar? In one sentence: DigiDollar is a US-dollar unit that settles on the DigiByte blockchain, where
1 DigiDollar = $1.00by definition. This toolkit is the open-source code for accepting it as payment, non-custodially, with your own DigiByte Core wallet.
| I am… | and I want to… | Read this |
|---|---|---|
| A merchant | accept DigiDollar / DGB payments on my site | README.md → guides/ACCEPTING_DIGIDOLLAR_AND_DGB.md → examples/demo-merchant/ |
| A developer | integrate the payment library into my backend | packages/crypto-payments/README.md → ARCHITECTURE.md → examples/demo-merchant/ |
| Curious | just understand what DigiDollar is | WHAT_IS_DIGIDOLLAR.md → FAQ.md |
| Security-minded | know it won't lose customer funds | SECURITY.md → the five facts in README.md |
| Skeptical | see it actually running in production | HOW_BLOCKINDEX_INTEGRATED.md → the live checkout → run examples/demo-merchant/ yourself |
- README.md — the front door: what the toolkit is, the five DigiDollar facts you must not skip, quickstart, and the push vs. pull models.
- WHAT_IS_DIGIDOLLAR.md — plain-English introduction to DigiDollar and DigiByte for someone who has never heard of either.
- ARCHITECTURE.md — how the toolkit works internally: address derivation, chain watching, the invoice state machine, and where each piece runs.
- HOW_BLOCKINDEX_INTEGRATED.md — the production case study: how BlockIndex.AI uses this exact toolkit to sell its $350 lifetime membership.
- SECURITY.md — the threat model and safe-operation rules: hot-wallet hygiene, sweeping to cold storage, and protecting the address pool.
- FAQ.md — quick answers to the most common merchant and developer questions.
- RESOURCES.md — the master "where to learn more" reference: every external DigiByte and DigiDollar doc, worth a bookmark.
- DOCUMENTATION.md — this file: the index and map you're reading now.
- guides/ACCEPTING_DIGIDOLLAR_AND_DGB.md — the node-operator + integrator playbook: configure DigiByte Core, mint receive addresses, and wire detection end to end.
- guides/walletnotify-reference/ — the push
model (recommended):
walletnotify/blocknotifyscripts that POST verified payments to your backend, plus the DD address-pool refill cron. See its README. - guides/watcher-reference/ — the pull model: a co-located worker that polls the node and posts to the same ingest endpoint. See its README.
- packages/crypto-payments/ —
@blockindex/crypto-payments, the MIT TypeScript library at the heart of the toolkit: quoting, address derivation, chain watchers, pricing, the invoice state machine, and a DigiByte Core RPC client. Pure JS (@scure/@noble), ESM — runs in Node, Deno, and the browser.- packages/crypto-payments/README.md — the library's own API docs and usage examples.
- packages/crypto-payments/CHANGELOG.md — version history (currently 0.1.0, the first public release).
- examples/demo-merchant/ — a runnable reference merchant
in ~300 lines of Node built-ins: a
POST /invoice/GET /invoice/:id/POST /ingestbackend plus a one-page polling checkout. Boots with no node (mock mode); its README has a full testnet walkthrough.
For DigiByte Core's protocol docs, the DigiDollar white paper, the oracle system, integration guides for wallets/exchanges/miners, and the community channels — see RESOURCES.md.