@aldea/compiler / "aldea/lock" / Lock
Class: Lock
"aldea/lock".Lock
Lock API
Never instantiated directly - only accessed via jig, eg: jig.$lock.
Table of contents
Constructors
Properties
Methods
- assertType
- change
- changeToAddressLock
- changeToJigLock
- changeToPublicLock
- freeze
- getAddressOrFail
- getOriginOrFail
- unlock
Constructors
constructor
• new Lock(origin, type, data): Lock
Parameters
| Name | Type |
|---|---|
origin | ArrayBuffer |
type | LockType |
data | ArrayBuffer |
Returns
Defined in
index.d.ts:27
Properties
data
• data: ArrayBuffer
Defined in
index.d.ts:26
origin
• Readonly origin: ArrayBuffer
Defined in
index.d.ts:24
type
• type: LockType
Defined in
index.d.ts:25
Methods
assertType
▸ assertType(type): void
Parameters
| Name | Type |
|---|---|
type | LockType |
Returns
void
Defined in
index.d.ts:28
change
▸ change(type, data?): void
Parameters
| Name | Type |
|---|---|
type | LockType |
data? | ArrayBuffer |
Returns
void
Defined in
index.d.ts:29
changeToAddressLock
▸ changeToAddressLock(pubkeyHash): void
Parameters
| Name | Type |
|---|---|
pubkeyHash | ArrayBuffer |
Returns
void
Defined in
index.d.ts:30
changeToJigLock
▸ changeToJigLock(): void
Returns
void
Defined in
index.d.ts:31
changeToPublicLock
▸ changeToPublicLock(): void
Returns
void
Defined in
index.d.ts:32
freeze
▸ freeze(): void
Returns
void
Defined in
index.d.ts:36
getAddressOrFail
▸ getAddressOrFail(): ArrayBuffer
Returns
ArrayBuffer
Defined in
index.d.ts:33
getOriginOrFail
▸ getOriginOrFail(): ArrayBuffer
Returns
ArrayBuffer
Defined in
index.d.ts:34
unlock
▸ unlock(): void
Returns
void
Defined in
index.d.ts:35