Module: ordinals
Interfaces
Functions
createInscription
▸ createInscription(contentType, content): Inscription
Create an inscription.
Parameters
| Name | Type |
|---|---|
contentType | string |
content | Buffer |
Returns
Defined in
ordinals/commit.ts:26
createTextInscription
▸ createTextInscription(text): Inscription
Create a basic text inscription.
Parameters
| Name | Type |
|---|---|
text | string |
Returns
Defined in
ordinals/commit.ts:16
inscribeData
▸ inscribeData(signer, toAddress, feeRate, inscription, postage?): Promise\<Transaction>
Inscribe some data on Bitcoin using the remote signer.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
signer | RemoteSigner | undefined | Implementation to interact with Bitcoin and sign the PSBT. |
toAddress | string | undefined | The address to receive the inscription. |
feeRate | number | undefined | Fee rate of the Bitcoin network (satoshi / byte). |
inscription | Inscription | undefined | Data to inscribe in the witness of the reveal transaction. |
postage | number | 10000 | Amount of postage to include in the inscription. |
Returns
Promise\<Transaction>
Promise which resolves to the reveal transaction.
Defined in
ordinals/index.ts:54