> For the complete documentation index, see [llms.txt](https://docs.stacks.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stacks.co/reference/stacks.js/stacks-connect/methods/signpsbt.md).

# signPsbt

Requests the connected wallet to sign a Partially Signed Bitcoin Transaction (PSBT).

***

### Usage

```ts
import { request } from '@stacks/connect';

const result = await request('signPsbt', {
  psbt: 'cHNidP8BAH0...base64-encoded-psbt',
  signInputs: [
    {
      index: 0,
      address: 'bc1q...address',
    },
  ],
  broadcast: true,
  network: 'mainnet',
});

console.log('Signed PSBT:', result.psbt);
console.log('Transaction ID:', result.txid);
```

```ts
import { request } from '@stacks/connect';

// Sign specific inputs by index only
const result = await request('signPsbt', {
  psbt: 'cHNidP8BAH0...base64-encoded-psbt',
  signInputs: [0, 2],
  broadcast: false,
});

console.log('Signed PSBT (base64):', result.psbt);
```

```ts
import { request } from '@stacks/connect';

// With sighash options
const result = await request('signPsbt', {
  psbt: 'cHNidP8BAH0...base64-encoded-psbt',
  signInputs: [
    {
      index: 0,
      address: 'bc1q...address',
      allowedSighash: ['ALL'],
    },
  ],
  allowedSighash: ['ALL', 'ANYONECANPAY'],
});
```

#### Notes

* The `psbt` must be a **base64-encoded** PSBT string.
* The `signInputs` parameter supports two formats: an array of input indices (`number[]`), or an array of `SignInputsByAddress` objects for more granular control.
* Provider overrides automatically transform the `signInputs` format and PSBT encoding to match each wallet's expected schema (e.g. Xverse uses a record-based format, Leather uses hex encoding).
* When `broadcast` is `true`, the wallet broadcasts the transaction after signing and returns the `txid`.
* To spend a Bitcoin Staking bond lockup through a wallet, build the transaction with [`buildReclaim`](/reference/stacks.js/stacks-bitcoin-staking/reclaim/buildreclaim.md), pass `tx.toPSBT()` base64-encoded as `psbt` with `broadcast: false`, and complete it with [`finalizeReclaim`](/reference/stacks.js/stacks-bitcoin-staking/reclaim/finalizereclaim.md), which assembles the lockup's `OP_IF`/`OP_ELSE` witness. With the default unlock bytes (`<staker public key> OP_CHECKSIG`), the lockup script is the miniscript policy `wsh(and_v(v:or_i(after(<unlock height>),and_v(v:sha256(<staker hash>),pk(<early-unlock key>))),pk(<staker public key>)))`. Pass it as `descriptor`: Leather signs the input when the staker public key is the account's Native SegWit key.

[**Reference Link**](https://github.com/stx-labs/connect/blob/v8.2.7/packages/connect/src/methods.ts#L194-L208)

***

### Signature

```ts
function request(
  'signPsbt',
  params: SignPsbtParams
): Promise<SignPsbtResult>
```

***

### Returns

`SignPsbtResult`

```ts
interface SignPsbtResult {
  txid?: string;
  psbt: string;
}
```

| Property | Type                | Description                                      |
| -------- | ------------------- | ------------------------------------------------ |
| `txid`   | `string` (optional) | The transaction ID, if the PSBT was broadcasted. |
| `psbt`   | `string`            | The signed PSBT (base64-encoded).                |

***

### Parameters

#### psbt (required)

* **Type**: `string`

The base64-encoded PSBT to be signed.

#### signInputs (optional)

* **Type**: `number[] | SignInputsByAddress[]`

Specifies which inputs to sign. Can be:

* An array of input indices (`number[]`): signs the inputs at those positions.
* An array of `SignInputsByAddress` objects for more control:

```ts
interface SignInputsByAddress {
  index: number;
  address: string;
  publicKey?: string;
  allowedSighash?: Sighash[];
}
```

| Property         | Type                   | Description                                  |
| ---------------- | ---------------------- | -------------------------------------------- |
| `index`          | `number`               | The input index to sign.                     |
| `address`        | `string`               | The address that owns this input.            |
| `publicKey`      | `string` (optional)    | The public key for signing.                  |
| `allowedSighash` | `Sighash[]` (optional) | Allowed signature hash types for this input. |

#### broadcast (optional)

* **Type**: `boolean`

Whether the wallet should broadcast the transaction after signing.

#### network (optional)

* **Type**: `NetworkString`

The network to use (e.g. `'mainnet'`, `'testnet'`).

#### allowedSighash (optional, experimental)

* **Type**: `Sighash[]`

```ts
type Sighash = 'ALL' | 'NONE' | 'SINGLE' | 'ANYONECANPAY';
```

Global allowed signature hash types. This may be renamed in the future as wallets adopt SIPs/WBIPs.

#### descriptor (optional, experimental)

* **Type**: `string`

A `wsh(...)` output descriptor for the P2WSH miniscript policy of the input being signed. Leather-specific; not part of a SIP or WBIP. Available from `@stacks/connect` 8.2.7. Leather accepts it from browser extension 6.103.1; see Leather's [signPsbt](https://leather.gitbook.io/developers/bitcoin-methods/signpsbt) page for which keys and inputs it signs.

How `request()` handles it per provider ([`request.ts`](https://github.com/stx-labs/connect/blob/v8.2.7/packages/connect/src/request.ts#L455-L515) at v8.2.7):

| Provider                      | What the override does with `descriptor`                                                                                                                                        |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Leather                       | Forwarded as `descriptor` next to `hex`, `signAtIndex`, `allowedSighash`, `broadcast` and `network`                                                                             |
| Xverse-like (Xverse, Fordefi) | Dropped when `signInputs` is set, because the override rebuilds the params from `psbt`, `signInputs` and `broadcast` only. Passed through unchanged when `signInputs` is absent |
| Any other provider            | Passed through unchanged                                                                                                                                                        |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stacks.co/reference/stacks.js/stacks-connect/methods/signpsbt.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.