Garden SDK

The Garden SDK is a set of typescript packages that allow you to bridge Bitcoin to EVM-based chains. It is an abstraction over the Garden APIs, allowing developers to easily integrate Garden components into their dApps.

Packages

• @gardenfi/utils : Provides shared utility functions.
• @gardenfi/wallet-connectors : Provides wallet adapters for Bitcoin wallet connectivity.
• @gardenfi/orderbook : Allows you to create orders and listen to them.
• @gardenfi/core : Allows you to interact with orders once you setup your wallets.
• @gardenfi/react-hooks :React context and hooks for integrating Garden SDK with your UI.

Docs

Check out our docs to learn more about Garden and how to build on it.

Dependency Graph

@gardenfi/utils
   └── @gardenfi/wallet-connectors
         └── @gardenfi/orderbook
               └── @gardenfi/core
                     └── @gardenfi/react-hooks

Getting Started

This repository utilizes a Yarn workspace. To begin setting up the environment, follow these steps:

# fork and clone the repository
git clone https://github.com/your-username/garden.js.git
cd garden.js

# install dependencies
yarn

#build the project
yarn build

#build a specific package
yarn workspace @gardenfi/<package_name> build

#start development server
yarn dev

Usage

To integrate the Garden SDK packages into your project based on your requirement, use the following command:

yarn add @gardenfi/<package_name>

Contributing

Make a contribution

• Follow a consistent branch naming convention:

  Type	Purpose	Example
  feat/	Introducing a new feature	feat/add-wallet-modal
  fix/	Bug fix or patch	fix/order-expiry-bug
  chore/	Minor update, refactor, or cleanup	chore/update-readme

  Test your updates locally to ensure everything works as expected.

• Commit and push changes

  git add .
  git commit -m "<COMMIT_MSG>"
  git push origin "<YOUR_BRANCH_NAME>"

• open a Pull Request to the main branch and fill in a clear description of your changes.

Contribution Tips

• Keep PRs small and focused.
• Follow existing code style and conventions.
• Add meaningful commit messages and PR titles.
• Include screenshots or demos if applicable.