Class RecipientNotAllowedError

Error thrown when the send recipient is not configured on the lock.

Hierarchy

LockError
- RecipientNotAllowedError

Index

Constructors

Properties

code lockId message recipient stack? prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new RecipientNotAllowedError(recipient: AccountAddress, lockId: LockId): RecipientNotAllowedError
Parameters
- recipient: AccountAddress
  
  The recipient not allowed by the lock configuration.
- lockId: LockId
  
  The lock whose recipients list was checked.
Returns RecipientNotAllowedError
Overrides LockError.constructor
- Defined in packages/sdk/src/plt/Lock.ts:134

Properties

`Readonly` code

code: RECIPIENT_NOT_ALLOWED = LockErrorCode.RECIPIENT_NOT_ALLOWED

`Readonly` lockId

lockId: LockId

The lock whose recipients list was checked.

message

message: string

`Readonly` recipient

recipient: AccountAddress

The recipient not allowed by the lock configuration.

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

name

get name(): string
Returns string
Inherited from LockError.name
- Defined in packages/sdk/src/plt/Lock.ts:57

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from LockError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc