Sablier Bob

Background

This package contains the following protocols:

• Sablier Bob: Price-gated vaults that unlock deposited tokens based on a target price set. If a vault is configured with an adapter, the protocol will automatically stake the tokens and earn yield on behalf of the users.

• Sablier Escrow: A peer-to-peer token swap protocol that allows users to swap ERC-20 tokens with each other.

Install

Node.js

This is the recommended approach.

Install Bob using your favorite package manager, e.g. with Bun:

bun add @sablier/bob

Git Submodules

This installation method is not recommended, but it is available for those who prefer it.

Install the monorepo and its dependencies using Forge:

forge install sablier-labs/evm-monorepo@[email protected] OpenZeppelin/[email protected] PaulRBerg/[email protected] smartcontractkit/[email protected] 

Then, add the following remappings in remappings.txt:

@chainlink/contracts/=lib/chainlink/contracts-evm/
@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
@prb/math/=lib/prb-math/
@sablier/evm-utils/=lib/evm-monorepo/utils/
@sablier/bob/=lib/evm-monorepo/bob/

Branching Tree Technique

You may notice that some test files are accompanied by .tree files. This is because we are using Branching Tree Technique and Bulloak.

Deployments

The list of all deployment addresses can be found here.

Security

The codebase has undergone rigorous audits by leading security experts from Cantina, as well as independent auditors. For a comprehensive list of all audits conducted, please click here.

For any security-related concerns, please refer to the SECURITY policy. This repository is subject to a bug bounty program per the terms outlined in the aforementioned policy.

Contributing

Feel free to dive in! Open an issue, start a discussion or submit a PR. For any informal concerns or feedback, please join our Discord server.

For guidance on how to create PRs, see the CONTRIBUTING guide.

License

See LICENSE.md.