-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from nervina-labs/fix/bitcoin-deps
fix: bitcoin deps
- Loading branch information
Showing
9 changed files
with
89 additions
and
21 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@joyid/common': minor | ||
--- | ||
|
||
Open source @joyid/common |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@joyid/bitcoin': patch | ||
--- | ||
|
||
fix wrong denpendency |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,6 +33,6 @@ | |
"dist" | ||
], | ||
"dependencies": { | ||
"@joyid/evm": "workspace:*" | ||
"@joyid/common": "workspace:*" | ||
} | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.