The Interledger Knowledge Base is a centralized repository consolidating comprehensive documentation from various Interledger ecosystem projects. This repository serves as a single source of truth for developers, researchers, and enthusiasts to access detailed guides, specifications, and implementation details about Interledger technologies without navigating multiple project repositories.
The knowledge base includes full documentation for key Interledger components, making it easier to understand and contribute to the ecosystem.
This repository contains the following documentation files:
Full documentation for the Open Payments API, an open API standard implemented by account servicing entities (e.g., banks, digital wallet providers) to facilitate interoperability in payments for use cases like Web Monetization, tipping, eCommerce, P2P transfers, subscriptions, and invoice payments. Includes wallet address server, resource server, authorization server (GNAP), SDKs, and integration guides.
Comprehensive guide to Web Monetization, covering protocol specifications, implementation details for websites and content creators, browser integration, monetization flows, developer tutorials, and best practices. Includes guides for monetizing pages, receiving/sending payments, references for APIs and events, and resources like libraries and wallets.
Detailed documentation for Rafiki, the Interledger Account Servicing Entity (ASE) implementation. Covers architecture and components (Backend, Auth, Frontend, Localenv), setup and development workflows, GraphQL API, Open Payments integration, accounting logic, testing, deployment, and extension guides.
Complete guide to Payment Pointers, standardized identifiers for payment accounts supporting Interledger payments. Explains syntax (starting with $), structure, registration, discovery mechanisms, security considerations, flow for resolving to SPSP endpoints, and IANA considerations.
-
Browse Documentation: Start by exploring the markdown files directly in this repository. Each file is self-contained and includes detailed explanations, code examples, and references.
-
Search and Reference: Use the repository's search functionality to find specific topics across all documents.
-
Contribute Updates: If you notice outdated information or want to add new content, refer to the contributing guidelines below.
-
Link to Originals: For the latest code, issues, or active development, visit the original project repositories linked below.
For source code, issue tracking, and active development:
This knowledge base is maintained to reflect the latest developments in the Interledger ecosystem. To contribute:
- Fork this repository.
- Update the relevant markdown files with accurate, up-to-date information.
- Submit a pull request with a clear description of changes.
Please ensure all contributions are based on official project documentation and specifications.
TBD
For more information about the Interledger Protocol, visit interledger.org.