Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: updated sdk README #237

Merged
merged 4 commits into from
May 14, 2024
Merged

Chore: updated sdk README #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b9e2ca2
updated sdk README
bvotteler May 8, 2024
9de2467
chore: add package-lock.json
bvotteler May 8, 2024
257b8a1
chore: update getting started guide with missing parameter in forge s…
bvotteler May 8, 2024
c8466f2
Merge branch 'master' into chore-update-readme
nud3l May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/docs/build/getting-started/helloworld.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,9 @@ export USDT_ADDRESS=0xF58de5056b7057D74f957e75bFfe865F571c3fB6
export RPC_URL=https://testnet.rpc.gobob.xyz
export VERIFIER_URL=https://testnet-explorer.gobob.xyz/api?

forge script script/HelloBitcoin.sol --rpc-url=$RPC_URL --broadcast --verify --verifier blockscout --verifier-url=$VERIFIER_URL
forge script script/HelloBitcoin.sol --rpc-url=$RPC_URL --broadcast \
--verify --verifier blockscout --verifier-url=$VERIFIER_URL \
--priority-gas-price 1
```

The output in the terminal should look similar to this:
Expand Down
54 changes: 50 additions & 4 deletions sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,64 @@ The BOB SDK helps you interact with BOB and Bitcoin, including Ordinals, BRC20,
- [Website](https://www.gobob.xyz/)
- [Docs](https://docs.gobob.xyz/)

## Installation
## Using the sdk in your project
Install `@gobob/bob-sdk` with your package manager of choice.

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

## Test
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 [email protected]: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
```

### 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.
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)

Loading