Skip to main content

Module: ordinals

Interfaces

Functions

inscribeText

inscribeText(signer, toAddress, feeRate, text, postage?): Promise\<Transaction>

Inscribe some text data on Bitcoin using the remote signer.

Parameters

NameTypeDefault valueDescription
signerRemoteSignerundefinedImplementation to interact with Bitcoin and sign the PSBT.
toAddressstringundefinedThe address to receive the inscription.
feeRatenumberundefinedFee rate of the Bitcoin network (satoshi / byte).
textstringundefinedData to inscribe in the witness of the reveal transaction.
postagenumber10000Amount of postage to include in the inscription.

Returns

Promise\<Transaction>

Promise which resolves to the reveal transaction.

Defined in

ordinals/index.ts:54