Skip to main content
Version: Next

tx.txbuilder.addretirepool

Home > @blaze-cardano/tx > TxBuilder > addRetirePool

TxBuilder.addRetirePool() method

Adds a Pool Retirement certificate.

Retires a stake pool at the provided epoch.

Signature:

addRetirePool(poolId: PoolId, epoch: EpochNo): TxBuilder;

Parameters

Parameter

Type

Description

poolId

PoolId

The pool identifier.

epoch

EpochNo

The epoch in which the pool retires.

Returns:

TxBuilder

{TxBuilder} The updated transaction builder.