Opinionation

dinaricrypto · Jun 15, 2023 · 9d3878f · 9d3878f
1 parent b9e88de
commit 9d3878f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/src/issuer/IOrderBridge.sol b/src/issuer/IOrderBridge.sol
@@ -5,6 +5,7 @@ pragma solidity ^0.8.19;
 /// @author Dinari (https://github.com/dinaricrypto/sbt-contracts/blob/main/src/issuer/IOrderBridge.sol)
 /// This interface provides a standard Order type and order lifecycle events
 /// Orders are requested on-chain, processed off-chain, then fulfillment is submitted for on-chain settlement
+/// Bridge operators have a consistent interface for processing orders and submitting fulfillment
 interface IOrderBridge {
     /// ------------------ Types ------------------ ///
 

diff --git a/src/issuer/OrderProcessor.sol b/src/issuer/OrderProcessor.sol
@@ -17,6 +17,8 @@ import {IOrderFees} from "./IOrderFees.sol";
 /// Orders are submitted by users and filled by operators
 /// Handling of fees is left to the inheriting contract
 /// Each inheritor can craft a unique order processing flow
+/// It is recommended that implementations offer a single process for all orders
+/// This maintains clarity for users and for interpreting contract token balances
 /// TODO: Fee contract required and specified here, but not used. Should fee contract be specified in inheritor?
 abstract contract OrderProcessor is
     Initializable,