Design Documents

We are trying to give developers and system administrators the best tools to develop on Cardano using the blockfrost API.

Document	Details	Status
Services	Documents the service architecture	WIP
Models	Documents the models architecture	WIP
Extensions	Documents the extensions architecture	WIP
Template	A template for documenting design for a technical problem	Archived

Non-Goals

• We are not a validation library for the Cardano blockchain. Our services support basic validation for Transactions and TxMetadata and we will reject invalid data if we detect it. Other then that, we will transmit your payload "as-is" to blockfrost.
• We are not a serialization library for the Cardano blockchain. Our models support serialization to and from JSON through System.Text.Json and are comliant with the blockfrost OpenApi Specification.
• We are not a cryptography library. You can not create wallets and addresses with our SDK. Unless blockfrost.io provides this capability in the future, then we might look into it... jk, we will definately support it if the API allows it.
• We are not hiding any secrets. blockfrost/blockfrost-dotnet is licensed under the Apache License 2. Download, clone, fork and modify our code and use it for your projects. We encourage you've to create a PR if you think you improved the SDK.

Proposed Design

We try to build a testable, maintainable and extensible SDK and follow IoC.principles wherever possible.

System Architecture

See the design documents for Services, Models, Extensions

Interface/API Definitions

See the design documents for Services

Data Model

See the design documents for Models