Skip to main content

Smart contracts

Documentation for the contracts that make up Boson Protocol

📄️ Setup

Developer Setup

📄️ Architecture

Contract Architecture

📄️ Tasks

Development Tasks

📄️ Domain

Entity Relationship Diagram

📄️ Audits

To maintain the security of Boson Protocol smart contracts at the highest level, the contracts are continuously audited by specialists in this field. You can find a list of public audit reports in our Github.

📄️ Happy Path Exchange

Entity Relationships

📄️ Protocol limit estimation

Certain actions in the protocol require looping over dynamic size arrays. To avoid hitting the block gas limit, special protocol limits were introduced which revert the transaction before the loop even starts. Values for these limits are then determined through estimation process, described here.

📄️ Local development

Running against a Local Node

📄️ Sequences

Happy Path Exchange

📄️ Contributor Covenant Code of Conduct

Our Pledge

📄️ AccountHandlerFacet

View Source: contracts/protocol/facets/AccountHandlerFacet.sol

📄️ Address

View Source: contracts/extlibs/Address.sol

📄️ BosonClientBeacon

View Source: contracts/protocol/clients/proxy/BosonClientBeacon.sol

📄️ BosonTypes

View Source: contracts/domain/BosonTypes.sol

📄️ BuyerBase

View Source: contracts/protocol/bases/BuyerBase.sol

📄️ DAIAliases

View Source: contracts/interfaces/DAIAliases.sol

📄️ DiamondCutFacet

View Source: contracts/diamond/facets/DiamondCutFacet.sol

📄️ DiamondLib

View Source: contracts/diamond/DiamondLib.sol

📄️ DiamondLoupeFacet

View Source: contracts/diamond/facets/DiamondLoupeFacet.sol

📄️ DisputeBase

View Source: contracts/protocol/bases/DisputeBase.sol

📄️ DisputeHandlerFacet

View Source: contracts/protocol/facets/DisputeHandlerFacet.sol

📄️ DisputeResolverHandlerFacet

View Source: contracts/protocol/facets/DisputeResolverHandlerFacet.sol

📄️ ExchangeHandlerFacet

View Source: contracts/protocol/facets/ExchangeHandlerFacet.sol

📄️ FundsHandlerFacet

View Source: contracts/protocol/facets/FundsHandlerFacet.sol

📄️ FundsLib

View Source: contracts/protocol/libs/FundsLib.sol

📄️ GroupBase

View Source: contracts/protocol/bases/GroupBase.sol

📄️ GroupHandlerFacet

View Source: contracts/protocol/facets/GroupHandlerFacet.sol

📄️ IAccessControl

View Source: contracts/interfaces/IAccessControl.sol

📄️ IBosonAccountEvents

View Source: contracts/interfaces/events/IBosonAccountEvents.sol

📄️ IBosonAccountHandler

View Source: contracts/interfaces/handlers/IBosonAccountHandler.sol

📄️ IBosonBundleEvents

View Source: contracts/interfaces/events/IBosonBundleEvents.sol

📄️ IBosonBundleHandler

View Source: contracts/interfaces/handlers/IBosonBundleHandler.sol

📄️ IBosonConfigEvents

View Source: contracts/interfaces/events/IBosonConfigEvents.sol

📄️ IBosonConfigHandler

View Source: contracts/interfaces/handlers/IBosonConfigHandler.sol

📄️ IBosonDisputeEvents

View Source: contracts/interfaces/events/IBosonDisputeEvents.sol

📄️ IBosonDisputeHandler

View Source: contracts/interfaces/handlers/IBosonDisputeHandler.sol

📄️ IBosonExchangeEvents

View Source: contracts/interfaces/events/IBosonExchangeEvents.sol

📄️ IBosonExchangeHandler

View Source: contracts/interfaces/handlers/IBosonExchangeHandler.sol

📄️ IBosonFundsEvents

View Source: contracts/interfaces/events/IBosonFundsEvents.sol

📄️ IBosonFundsHandler

View Source: contracts/interfaces/handlers/IBosonFundsHandler.sol

📄️ IBosonFundsLibEvents

View Source: contracts/interfaces/events/IBosonFundsEvents.sol

📄️ IBosonGroupEvents

View Source: contracts/interfaces/events/IBosonGroupEvents.sol

📄️ IBosonGroupHandler

View Source: contracts/interfaces/handlers/IBosonGroupHandler.sol

📄️ IBosonMetaTransactionsEvents

View Source: contracts/interfaces/events/IBosonMetaTransactionsEvents.sol

📄️ IBosonMetaTransactionsHandler

View Source: contracts/interfaces/handlers/IBosonMetaTransactionsHandler.sol

📄️ IBosonOfferEvents

View Source: contracts/interfaces/events/IBosonOfferEvents.sol

📄️ IBosonOfferHandler

View Source: contracts/interfaces/handlers/IBosonOfferHandler.sol

📄️ IBosonOrchestrationHandler

View Source: contracts/interfaces/handlers/IBosonOrchestrationHandler.sol

📄️ IBosonPauseEvents

View Source: contracts/interfaces/events/IBosonPauseEvents.sol

📄️ IBosonPauseHandler

View Source: contracts/interfaces/handlers/IBosonPauseHandler.sol

📄️ IBosonProtocolInitializationEvents

View Source: contracts/interfaces/events/IBosonProtocolInitializationEvents.sol

📄️ IBosonProtocolInitializationHandler

View Source: contracts/interfaces/handlers/IBosonProtocolInitializationHandler.sol

📄️ IBosonTwinEvents

View Source: contracts/interfaces/events/IBosonTwinEvents.sol

📄️ IBosonTwinHandler

View Source: contracts/interfaces/handlers/IBosonTwinHandler.sol

📄️ IBosonVoucher

View Source: contracts/interfaces/clients/IBosonVoucher.sol

📄️ IClientExternalAddresses

View Source: contracts/interfaces/clients/IClientExternalAddresses.sol

📄️ IClientExternalAddressesEvents

View Source: contracts/interfaces/events/IClientExternalAddressesEvents.sol

📄️ IDiamondCut

View Source: contracts/interfaces/diamond/IDiamondCut.sol

📄️ IDiamondLoupe

View Source: contracts/interfaces/diamond/IDiamondLoupe.sol

📄️ IERC1155

View Source: contracts/interfaces/IERC1155.sol

📄️ IERC165

View Source: contracts/interfaces/IERC165.sol

📄️ IERC165Extended

View Source: contracts/interfaces/diamond/IERC165Extended.sol

📄️ IERC20

View Source: contracts/interfaces/IERC20.sol

📄️ IERC20Metadata

View Source: contracts/interfaces/IERC20Metadata.sol

📄️ IERC2981

View Source: contracts/interfaces/IERC2981.sol

📄️ IERC721

View Source: contracts/interfaces/IERC721.sol

📄️ IInitializableVoucherClone

View Source: contracts/interfaces/IInitializableVoucherClone.sol

📄️ ITwinToken

View Source: contracts/interfaces/ITwinToken.sol

📄️ TwinBase

View Source: contracts/protocol/bases/TwinBase.sol

📄️ TwinHandlerFacet

View Source: contracts/protocol/facets/TwinHandlerFacet.sol