Skip to content

Commit

Permalink
Merge pull request #6 from nervina-labs/fix/bitcoin-deps
Browse files Browse the repository at this point in the history
fix: bitcoin deps
  • Loading branch information
yuche authored Jun 10, 2024
2 parents 8fadeba + aca6daf commit 745ea2d
Show file tree
Hide file tree
Showing 9 changed files with 89 additions and 21 deletions.
5 changes: 0 additions & 5 deletions .changeset/beige-beans-fly.md

This file was deleted.

1 change: 1 addition & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"bumpVersionsWithWorkspaceProtocolOnly": true,
"ignore": ["*-demo"]
}
5 changes: 5 additions & 0 deletions .changeset/rude-steaks-refuse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@joyid/common': minor
---

Open source @joyid/common
13 changes: 0 additions & 13 deletions .changeset/small-onions-accept.md

This file was deleted.

5 changes: 5 additions & 0 deletions .changeset/tame-carrots-joke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@joyid/bitcoin': patch
---

fix wrong denpendency
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Nervina Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# JoyID JavaScript SDK

This is monorepo for JoyID JavaScript SDK.

## Overview

In order to interact with [JoyID App](https://app.joy.id) we provide different packages to meet different requirements.

* [`@joyid/ckb`](./packages/ckb/): SDK for manipulating [Nervos CKB](https://www.nervos.org/) assets, including transferring CKB/mNFT/CoTA NFT, signing Raw Transaction, etc.
* [`@joyid/bitcoin`](./packages/bitcoin/): UniSat SDK compatible with [Bitcoin](https://bitcoin.org/).
* [`@joyid/evm`](./packages//evm/): SDK for manipulating [EVM-compatible blockchains](https://blog.thirdweb.com/evm-compatible-blockchains-and-ethereum-virtual-machine/) assets.
* [`@joyid/nostr`](./packages//nostr/): [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) implementation for [Nostr](https://nostr.com/) protocol.
* [`@joyid/ethers`](./packages/ethers/): [Ethers.js](https://docs.ethers.io/v5/) implementation for JoyID EVM SDK.
* [`@joyid/wagmi`](./packages/wagmi/): [Wagmi](https://wagmi.io/) implementation for JoyID EVM SDK.
* [`@joyid/rainbowkit`](./packages/rainbowkit/): [RainbowKit](https://www.rainbowkit.com/) implementation for JoyID EVM SDK.
* [`@joyid/ethereum-provider`](./packages/ethereum-provider/): [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) implementation for JoyID EVM SDK.

You can choose the appropriate SDK package according to your application scenario and follow the instructions in the documentation for installation and use. If you need technical support, feel free to contact us in [Discord](https://discord.com/invite/77MyakRKVB).

## Examples

We provide examples for each package in the `examples` directory. Every example is a standalone project that demonstrates how to use the SDK in a specific scenario. You can run the examples by running the following commands:

```bash
pnpm run dev
```

There are six examples in the `examples` directory:

* [`CKB Demo`](./examples/ckb/): Example for `@joyid/ckb` SDK.
* [`Bitcoin Demo`](./examples/bitcoin/): Example for `@joyid/bitcoin` SDK.
* [`EVM Demo`](./examples/evm/): Example for `@joyid/evm` SDK.
* [`Wagmi Demo`](./examples/wagmi/): Example for `@joyid/wagmi` SDK.
* [`RainbowKit Demo`](./examples/rainbowkit/): Example for `@joyid/rainbowkit` SDK.
* [`nostr Demo`](./examples/nostr/): Example for `@joyid/nostr` SDK.

## Development

### Installation

```bash
npm i -g pnpm
pnpm install
```

### Build

```bash
pnpm build
```

## Contributing

We welcome contributions from the community. If you want to contribute to JoyID JavaScript SDK, please read the [Contributing Guide](./CONTRIBUTING.md) first.
2 changes: 1 addition & 1 deletion packages/bitcoin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@
"dist"
],
"dependencies": {
"@joyid/evm": "workspace:*"
"@joyid/common": "workspace:*"
}
}
4 changes: 2 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 745ea2d

Please sign in to comment.