[BUG]: Missing SDK API documentation and incomplete developer-facing usage guide in StablePay README
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- documentation
Direzione di ricerca
Start with stablepay-sdk/README.md and inspect the SDK entry exports and stablepay-sdk/src/widget/* to identify the public API and supported options. Then document installation, a minimal integration, and the listed components and transaction callbacks; done means the README lets a developer understand how to consume the SDK without treating internal files as its API.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Bug Description
The current stablepay-sdk README provides a high-level overview of the StablePay widget architecture and clearly documents internal file structure (Widget, PayButton, NetworkDropdown, etc.).
However, it does not provide a proper SDK-level API reference or integration guide for developers using the package.
While the README explains what files exist, it does not explain:
*What the actual public SDK API is
*How developers are expected to import and use StablePay in a project
*What configuration options are available
*What events, callbacks, or props are supported
*Which parts of stablepay-sdk/src are public vs internal implementation
As a result, the README functions more like a codebase overview, not SDK documentation.
Why is this a problem?
This creates confusion for developers and integrators because:
*There is no clear “Getting Started” usage example
*No documented entry point (index exports or SDK initialization flow)
*No explanation of how to use:
->Widget
->PayButton
->network selection flow
->transaction lifecycle callbacks
*Developers must manually inspect the source code to understand usage
*Internal components are documented, but not how to actually consume the SDK
This increases onboarding time and reduces SDK usability.
Steps to Reproduce
Steps to Reproduce
- In stablepay-sdk/README.md
- In the “Code Structure Overview” section
- Look for:
->installation instructions
->import examples
->SDK usage snippets
->configuration API - Notice that none of the above exist
- Compare with actual code in stablepay-sdk/src and entry exports
- Observe missing developer-facing API documentation
Affected Area
->Package: stablepay-sdk
->File: stablepay-sdk/README.md
->Source: stablepay-sdk/src/widget/* and SDK entry exports
Expected Behavior
The README should include a proper SDK documentation section such as:
*Installation guide (npm/yarn/pnpm)
*Basic usage example (minimum working widget integration)
*Public API reference:
->Widget
->PayButton
->NetworkDropdown
->TokenDropdown
->transaction callbacks/events
*Configuration options (props, network config, payment settings)
*Example integration flow (merchant checkout use case)
*Clear distinction between:
*public SDK exports
*internal implementation files
Actual Behavior
The README currently:
*Focuses on repository structure instead of SDK usage
*Lists internal widget file breakdown
*Does not explain how to actually integrate or use StablePay in a project
*Lacks API reference or developer onboarding guide
Logs and Screenshots
No logs apply.
Environment Details
->Area: stablepay-sdk
->File: README.md
->Repro: As of Mar 27, 2026
->Impact: SDK users and maintainers
Impact
Medium - Feature works but has issues
Code of Conduct
- I have joined the Discord server and will post updates there
- I have searched existing issues to avoid duplicates
- Lingua principale
- JavaScript
- Stelle
- 16
- Fork
- 29
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di StabilityNexus/StablePay
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
StabilityNexus/StablePay#64 · 1 commento ·
-
[BUG]: `stablepay-sdk` README documents an unrelated thirdweb app instead of the actual SDK APIApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
StabilityNexus/StablePay#102 ·
-
[FEATURE]: Centralize transaction initialization and quote fetching to avoid duplicate RPC calls in the widgetForse di nuovo libera @CaptainLevi2k04 l’ha presa 81 giorni fa e non c’è nessuna pull request aperta. Apertaenhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
StabilityNexus/StablePay#101 · 1 commento ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100
StabilityNexus/StablePay#96 · 1 commento ·
-
Bug: Missing import causes `calculateFutureScPrice` to fail at runtimeForse già presa @Rav1Chauhan l’ha presa 272 giorni fa. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 20/100
StabilityNexus/StablePay#85 · 1 commento ·
Tutte le issue di StabilityNexus/StablePay
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 62/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 82/100
Leonxlnx/taste-skill#216 ·
I maintainer di solito rispondono entro 1 giorno
-
Docs: 11 broken linksAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
all-contributors/cli#690 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno