# BOB SDK

The BOB SDK helps you interact with BOB and Bitcoin, including Ordinals, BRC20, Runes, and more.

## Learn more

- [Website](https://www.gobob.xyz/)
- [Docs](https://docs.gobob.xyz/)

## Using the sdk in your project

Install `@gobob/bob-sdk` with your package manager of choice.

```shell
pnpm i @gobob/bob-sdk
```

or

```shell
yarn add @gobob/bob-sdk
```

or

```shell
npm i @gobob/bob-sdk
```

## Building BOB SDK

### Clone the repository

Clone the repository and change to the `sdk` subfolder.

```shell
git clone git@github.com:bob-collective/bob.git
cd bob/sdk
```

### Install dependencies

We use `pnpm` in the examples below. But the steps below should also work when using `yarn` or `npm` instead.

```shell
pnpm i

openapi-generator-cli generate --skip-validate-spec \
    -i https://gateway-api-staging.gobob.xyz/api-doc.json \
    -g typescript-fetch \
    -o ./src/gateway/generated-client
```

### Build

```shell
pnpm build
```

### Test

```shell
pnpm test
```

## Contributing

BOB is an open-source project. We welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.  
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Set up git so you can [sign your commits](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) (Alternative link: [GitHub: Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits))  
   Unsigned PRs cannot be merged, so do not skip this step.
2. Fork the Project
3. Create your Feature Branch (git checkout -b yourname/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin yourname/AmazingFeature)
6. Open a Pull Request with a description of feature you are adding

If you are searching for a place to start or would like to discuss features, reach out to us:

- [Discord](https://discord.com/invite/gobob)