Skip to content

Commit

Permalink
docs(adapters): adds docs for adapters
Browse files Browse the repository at this point in the history
Signed-off-by: Bryan Cole <[email protected]>
  • Loading branch information
ColePBryan committed Jul 7, 2023
1 parent 6f81622 commit e689ac1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions tap_core/src/adapters/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
// Copyright 2023-, Semiotic AI, Inc.
// SPDX-License-Identifier: Apache-2.0

//! The adapters module provides interfaces that allow flexibility in storing and verifying TAP components.
//!
//! Each adapter should be defined by the user of the library based on their specific storage and verification requirements. This modular design
//! allows for easy integration with various storage solutions and verification procedures, thereby making the library adaptable to a wide range
//! of use cases.
//!
//! The following adapters are defined:
//! - `collateral_adapter`: An interface for checking and updating collateral availability.
//! - `rav_storage_adapter`: An interface for storing and retrieving/replacing RAVs.
//! - `receipt_checks_adapter`: An interface for verifying TAP receipts.
//! - `receipt_storage_adapter`: An interface for storing, retrieving, updating, and removing TAP receipts.
//!
//! In addition, this module also includes mock implementations of each adapter for testing and example purposes.
pub mod collateral_adapter;
pub mod rav_storage_adapter;
pub mod receipt_checks_adapter;
Expand Down

0 comments on commit e689ac1

Please sign in to comment.