Class LockBuilder

Builder for lock spending conditions.

Remarks

The v5 name for P2PKBuilder: adopt it (with addMainPubkey and requireMainSignatures) and the v5 upgrade keeps these call sites compiling.

Index

Constructors

Methods

addHashlock addLockPubkey addMainPubkey addRefundPubkey addTag addTags blindKeys lockUntil requireLockSignatures requireMainSignatures requireRefundSignatures sigAll toOptions fromOptions

Constructors

constructor

new LockBuilder(): LockBuilder
Returns LockBuilder

Methods

addHashlock

addHashlock(hashlock: string): LockBuilder
Converts a P2PK output into a NUT-14 HTLC kind output.
Parameters
- hashlock: string
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:101

addLockPubkey

addLockPubkey(pk: string | string[]): LockBuilder
Parameters
- pk: string | string[]
Returns LockBuilder
Deprecated
Use addMainPubkey. Removed in v5.
- Defined in src/wallet/P2PKBuilder.ts:38

addMainPubkey

addMainPubkey(pk: string | string[]): LockBuilder
Parameters
- pk: string | string[]
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:29

addRefundPubkey

addRefundPubkey(pk: string | string[]): LockBuilder
Parameters
- pk: string | string[]
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:42

addTag

addTag(key: string, values?: string | string[]): LockBuilder
Parameters
- key: string
- Optionalvalues: string | string[]
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:76

addTags

addTags(tags: P2PKTag[]): LockBuilder
Parameters
- tags: P2PKTag[]
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:83

blindKeys

blindKeys(): LockBuilder
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:88

lockUntil

lockUntil(when: number | Date): LockBuilder
Parameters
- when: number | Date
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:48

requireLockSignatures

requireLockSignatures(n: number): LockBuilder
Parameters
- n: number
Returns LockBuilder
Deprecated
Use requireMainSignatures. Removed in v5.
- Defined in src/wallet/P2PKBuilder.ts:63

requireMainSignatures

requireMainSignatures(n: number): LockBuilder
Parameters
- n: number
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:53

requireRefundSignatures

requireRefundSignatures(n: number): LockBuilder
Parameters
- n: number
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:67

sigAll

sigAll(): LockBuilder
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:93

toOptions

toOptions(): P2PKOptions
Returns P2PKOptions
- Defined in src/wallet/P2PKBuilder.ts:106

`Static`fromOptions

fromOptions(opts: P2PKOptions): LockBuilder
Parameters
- opts: P2PKOptions
Returns LockBuilder
- Defined in src/wallet/P2PKBuilder.ts:145