Skip to content

Repository for Boson Protocol SDK and libraries to interact with smart contracts

License

Notifications You must be signed in to change notification settings

bosonprotocol/core-components

Repository files navigation

banner

Core Components of the Boson Protocol

Build Status codecov

🛠️ Tools for building on top of the Boson Protocol.

Getting started

Components

The core components can be found in the packages folder of this monorepo.

Component Release Description
common JS lib with common types, interfaces and utilities shared by the core components in this repository.
core-sdk JS lib that facilitates interaction with the Boson Protocol contracts, subgraph and IPFS metadata storage
eth-connect-sdk JS lib that exports implementation of Web3LibAdapter and contract abstractions targeting eth-connect.
ethers-sdk JS lib that exports implementation of Web3LibAdapter and contract abstractions targeting ethers.
ipfs-storage JS lib that exports implementation of MetadataStorage for handling offer metadata on IPFS.
metadata Package which contains supported metadata types and tools.
react-kit React toolkit with smart components and hooks.
subgraph Schemas and mappings of the Boson Protocol subgraph on The Graph.

Contributing

We welcome contributions! Until now, Boson Protocol has been largely worked on by a small dedicated team. However, the ultimate goal is for all of the Boson Protocol repositories to be fully owned by the community and contributors. Issues, pull requests, suggestions, and any sort of involvement are more than welcome.

If you have noticed a bug, please report it via our Bug Bounty program.

Questions and feedback are always welcome, we will use them to improve our offering.

All PRs must pass all tests before being merged.

By being in this community, you agree to the Code of Conduct. Take a look at it, if you haven't already.