> For the complete documentation index, see [llms.txt](https://docs.sigmaidentity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sigmaidentity.com/sigma-library.md).

# Sigma Library

{% hint style="success" %}
A Go version of this library is available at [github.com/bitcoinschema/go-sigma](https://github.com/bitcoinschema/go-sigma)
{% endhint %}

### Library Usage

To use the Sigma Protocol library, follow the instructions below:

1. Install the library and peer dependency using npm / yarn / bun:

```bash
bun add sigma-protocol @bsv/sdk
```

2. You can use the `verify` method to check a signature:

```javascript
import { Sigma } from "sigma-protocol";
```

3. Use the `sign` function to sign your data:

```javascript
const outputScriptAsm = `OP_0 OP_RETURN ${Buffer.from(
  "pushdata1",
  "utf-8"
).toString("hex")} ${Buffer.from("pushdata2", "utf-8").toString("hex")}`;

const script = Script.from_asm_string(outputScriptAsm);

const tx = new Transaction(1, 0);
const txOut = new TxOut(BigInt(0), script);
tx.add_output(txOut);

const sigma = new Sigma(tx);

const { signedTx } = sigma.sign(privateKey);
```

4. Use the `verify` method to verify the signature:

```javascript
const sigma = new Sigma(tx);

const isValid = sigma.verify()

console.log("Signature is valid:", isValid);
```

You can select a transaction output, and sigma instance to target. If you do not specify a target, the first output and first sigma instance will be assumed.

Here we target output index 1:

```javascript
const sigma = new Sigma(tx, 1);
```

Here we target output index 1, sigma instance 2:

```javascript
// this means there are 2 signatures on a single output
// this is typical when a user signs, and then a 
// platform signs covering the user signature
const sigma = new Sigma(tx, 1);
```

Once an instance is targeted, you can use verify like normal:

```javascript
  const isValid = sigma.verify()
  console.log("Signature is valid:", isValid);
```

If you sign a tx and the sign it a again the signature will be replaced. However, you can add additional signatures by incrementing the sigma instance number before signing.

```javascript
  const sigma = new Sigma(tx, 1, 2);
  sigma.sign(privateKey);
```

### Remote Signatures

This library supports using a remove key server such as starfish or tokenpass. use the `sigmaInstance.remoteSign(keyHost)` method to sign the message buffer using a remove key service instead of passing in a private key. This will take a second parameter, `authTokenHeader` object which will be forwarded as a header to the key server. This is useful if you need a signing server in the cloud.

```javascript
  const sigma = new Sigma(tx, 1, 2);
  sigma.remoteSign("http://localhost:21000", "authToken");
```

### Building the Library:

To build the Sigma Protocol library yourself, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/BitcoinSchema/sigma.git
```

2. Navigate to the project directory and install dependencies:

```bash
cd sigma
yarn
```

3. Build the library:

```bash
yarn build
```

The compiled JavaScript files will be output to the `./dist` directory.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sigmaidentity.com/sigma-library.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.