Skip to main content

Interface: RemoteSigner

ordinals.RemoteSigner

Methods

getNetwork

getNetwork(): Promise\<Network>

Get the configured Bitcoin network.

Returns

Promise\<Network>

A promise that resolves to the current network.

Defined in

ordinals/signer.ts:27


getPublicKey

getPublicKey(): Promise\<string>

Get the configured public key of the signer.

Returns

Promise\<string>

A promise that resolves to the hex encoded public key.

Defined in

ordinals/signer.ts:33


getTransaction

getTransaction(txId): Promise\<Transaction>

Get the transaction based on its ID.

Parameters

NameTypeDescription
txIdstringThe transaction ID to fetch.

Returns

Promise\<Transaction>

A promise that resolves to the hex encoded transaction.

Defined in

ordinals/signer.ts:48


sendToAddress

sendToAddress(toAddress, amount): Promise\<string>

Send an amount of Satoshis to the recipient.

Parameters

NameTypeDescription
toAddressstringThe address of the recipient.
amountnumberThe Satoshis the recipient should receive.

Returns

Promise\<string>

A promise that resolves to the transaction ID.

Defined in

ordinals/signer.ts:41


signInput

signInput(inputIndex, psbt): Promise\<Psbt>

Sign the PSBT at the specified input index.

Parameters

NameTypeDescription
inputIndexnumberThe input index to sign for.
psbtPsbtThe PSBT containing that input.

Returns

Promise\<Psbt>

A promise that resolves to the signed PSBT.

Defined in

ordinals/signer.ts:56