open-index/open-npm huggingface dataset:
npm package: @nubit/goldinals-core-js
Description: A TypeScript/javascript implementation of Goldinals Core.
Author: Nubit Team
Latest version: 0.5.2

# goldinals-core-js

The core implementation of the **Goldinals protocol** in JavaScript
(TypeScript), designed for constructing Goldinals transactions in a JavaScript
runtime, particularly for wallet signing purposes.

**Goldinals protocol** is a trust-minimized fungible token standard for Bitcoin,
proposed by the Nubit Team. You can find the **Goldinals whitepaper** here:
[Link](https://www.nubit.org/Goldinals.pdf).

## Current Status

The protocol is in **active developing and internal testing**. Please note that
**breaking changes may occur** as development progresses.

The codebase is not open-sourced at this moment. Only the preview version is
provided via npm.

## Supported Operations

The current implementation supports the following core opcodes:

- `Deploy`
- `Mint`
- `Transfer`

This library provides a foundation for developers to work with Goldinals
transactions, enabling wallet integrations and protocol extensions.

## Supported Address Type Signatures

The current implementation supports the following address type signatures:

- `Taproot`
- `P2PKH`
- `P2WPKH`
- `P2SH-P2WPKH`

# Get Started

```bash
npm install @nubit/goldinals-core-js
```

## Wallet Supports:

This library facilitates the construction of **Partially Signed Bitcoin
Transactions (PSBTs)** for submission to the Bitcoin.

To sign PSBTs, we recommend using the library
[@scure/btc-signer](https://www.npmjs.com/package/@scure/btc-signer).

Below is a list of wallets known to support PSBT signing:

| Wallet Name | Method to Get Public Key                                                                       | Public Key Type               |
| ----------- | ---------------------------------------------------------------------------------------------- | ----------------------------- |
| Unisat      | [Link](https://docs.unisat.io/dev/unisat-developer-center/unisat-wallet#getpublickey)          | 33-byte Compressed Public Key |
| OKX         | [Link](https://www.okx.com/web3/build/docs/sdks/chains/bitcoin/provider-fractal#getpublickey)  | 33-byte Compressed Public Key |
| Xverse      | [Link](https://docs.xverse.app/sats-connect/getaccount#getaccount-result-account-is-connected) | 33-byte Compressed Public Key |

## Examples:

Please check [examples](https://github.com/RiemaLabs/goldinals-core-js-examples).