> 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-bitcoin-staking/build/buildstakeupdate.md).

# buildStakeUpdate

Builds an unsigned contract call to pox-5 `stake-update`, which changes the sender's active STX-only stake. One call can extend the lock, add STX and switch signer-manager.

***

### Usage

```ts
import {
  buildStakeUpdate,
  fetchEligibleStakeUpdate,
  fetchStakerInfo,
} from '@stacks/bitcoin-staking';
import {
  Pc,
  TransactionSigner,
  broadcastTransaction,
  fetchNonce,
  privateKeyToAddress,
  privateKeyToPublic,
  publicKeyToHex,
} from '@stacks/transactions';

const network = 'mainnet';
const privateKey = process.env.STAKER_KEY!;
const staker = privateKeyToAddress(privateKey, network);

const info = await fetchStakerInfo({ address: staker, network });
if (!info.staked) throw new Error('no active STX-only stake');
const current = info.details.signer;

const cyclesToExtend = 3;
const amountIncrease = 500_000n; // 0.5 STX in micro-STX

const check = await fetchEligibleStakeUpdate({
  staker,
  signerManager: current,
  oldSignerManager: current,
  cyclesToExtend,
  amountIncrease,
  network,
});
if (!check.ok) throw new Error(`stake-update would fail: ${check.reasons}`);

const tx = await buildStakeUpdate({
  signerManager: current, // same signer-manager: no switch
  oldSignerManager: current,
  cyclesToExtend,
  amountIncrease,
  publicKey: publicKeyToHex(privateKeyToPublic(privateKey)),
  fee: 10_000n, // micro-STX
  nonce: await fetchNonce({ address: staker, network }),
  network,
  postConditions: [Pc.principal(staker).willSendEq(amountIncrease).ustxToLock()],
});

new TransactionSigner(tx).signOrigin(privateKey);
const result = await broadcastTransaction({ transaction: tx, network });
```

#### Notes

* Changes apply from the next reward cycle. The current cycle keeps the old amount and signer-manager ([pox-5.clar L1088-L1173](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L1088-L1173)).
* pox-5 recomputes the remaining lock from the next cycle, `unlock-cycle - current-cycle - 1`, and requires it to be 1 to 96 (`ERR_INVALID_NUM_CYCLES (u20)`). In the stake's final locked cycle that value is 0, so a call that does not extend fails with u20: extend in the same call.
* Send it during the reward phase of any cycle, which excludes its last `prepareCycleLength` Bitcoin blocks (100 on mainnet), the prepare phase. In the prepare phase it fails with `ERR_STAKE_IN_PREPARE_PHASE (u47)`.
* Fails with `ERR_NOT_STAKING (u27)` without an active STX-only stake, and `ERR_INVALID_OLD_SIGNER_MANAGER (u36)` when `oldSignerManager` is not the recorded signer-manager.
* `signerManager` must be registered (`ERR_SIGNER_NOT_FOUND (u23)`) with an active signer key grant (`ERR_SIGNER_KEY_GRANT_NOT_FOUND (u17)`), even when it is unchanged. Its `validate-stake!` can reject the update with its own error code.
* The sender's unlocked balance must cover `amountIncrease` (`ERR_INSUFFICIENT_STX (u8)`). Locked STX does not count here, unlike in `stake`.
* [fetchEligibleStakeUpdate](/reference/stacks.js/stacks-bitcoin-staking/eligibility/fetcheligiblestakeupdate.md) dry-runs every check except the signer-manager's `validate-stake!`.
* Attach a staking post condition for `amountIncrease` with `ustxToLock()`, as in the Usage example. Without it, the default `deny` mode aborts a top-up with `abort_by_post_condition`.
* A txid from [broadcastTransaction](/reference/stacks.js/stacks-transactions/network/broadcasttransaction.md) confirms submission only. The call can still fail on-chain: read the mined transaction's result and pass an `(err uN)` to [parsePox5Error](/reference/stacks.js/stacks-bitcoin-staking/errors/parsepox5error.md).

[**Reference Link**](https://github.com/stx-labs/stacks.js/blob/6101c99efe5a9616ce7e16cef68e28fd10676e7e/packages/bitcoin-staking/src/build.ts#L481-L550)

***

### Signature

```ts
function buildStakeUpdate(
  args: {
    signerManager: string;
    oldSignerManager: string;
    cyclesToExtend?: number;
    amountIncrease?: IntegerType;
    signerCalldata?: Uint8Array | string;
  } & TxParams
): Promise<StacksTransactionWire>;
```

The transaction fields come from [TxParams](/reference/stacks.js/stacks-bitcoin-staking/types/txparams.md).

***

### Returns

`Promise<StacksTransactionWire>`

Resolves to an unsigned [StacksTransactionWire](/reference/stacks.js/stacks-transactions/signing/stackstransactionwire.md) that calls pox-5 `stake-update`. Sign it with [TransactionSigner](/reference/stacks.js/stacks-transactions/signing/transactionsigner.md), then send it with [broadcastTransaction](/reference/stacks.js/stacks-transactions/network/broadcasttransaction.md).

***

### Parameters

#### args.signerManager (required)

* **Type**: `string`

Contract principal of the signer-manager to use from the next cycle. Pass the current one to keep it.

#### args.oldSignerManager (required)

* **Type**: `string`

Contract principal of the signer-manager recorded for the stake now. [fetchStakerInfo](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchstakerinfo.md) returns it as `details.signer`.

#### args.cyclesToExtend (optional)

* **Type**: `number`

Reward cycles to add to the lock. Defaults to `0`.

#### args.amountIncrease (optional)

* **Type**: `IntegerType`

STX to add to the lock, in micro-STX. Defaults to `0n`.

#### args.signerCalldata (optional)

* **Type**: `Uint8Array | string`

Up to 500 bytes, as bytes or hex, that pox-5 forwards unread to the signer-manager's `validate-stake!`. Omitted, the contract receives `none`. [buildSignerCalldata](/reference/stacks.js/stacks-bitcoin-staking/signer/buildsignercalldata.md) encodes an L1 BTC payout election for signer-managers that read that format.

#### args.fee (required)

* **Type**: `IntegerType`

Transaction fee in micro-STX.

#### args.nonce (required)

* **Type**: `IntegerType`

Nonce of the origin account. Read it with [fetchNonce](/reference/stacks.js/stacks-transactions/network/fetchnonce.md).

#### args.network (required)

* **Type**: `StacksNetworkName | StacksNetwork`

A name such as `'mainnet'` or `'testnet'`, or a [StacksNetwork](/reference/stacks.js/stacks-network/network/stacksnetwork.md) object. Sets the contract address (the network's boot address, `SP000000000000000000002Q6VF78` on mainnet) and the transaction version and chain ID.

#### args.publicKey (required for a single-sig origin)

* **Type**: `string`

Hex public key of the account that signs the transaction.

#### args.publicKeys and args.numSignatures (required for a multisig origin)

* **Type**: `PublicKey[]` and `number`

Pass these instead of `publicKey` to build for an M-of-N multisig origin. This package defaults `useNonSequentialMultiSig` to `true`; pass `false` for the sequential hash mode. Pass `address` to check the key order against the multisig address.

#### args.postConditions (optional)

* **Type**: `PostCondition[]`

[Post conditions](/reference/stacks.js/stacks-transactions/types/postcondition.md) to attach. The builder adds none.

#### args.postConditionMode (optional)

* **Type**: `PostConditionModeName`

`'allow'`, `'deny'` or `'originator'`. Defaults to `'deny'`.


---

# 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-bitcoin-staking/build/buildstakeupdate.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.
