Class NotAllowedError

Error type indicating an attempt transfer funds to/from an account which is either not on the token allow list, or is on the token deny list

Hierarchy

TokenError
- NotAllowedError

Index

Constructors

Properties

code message receiver stack? prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new NotAllowedError(receiver: TokenHolderAccount): NotAllowedError
Constructs a new NotAllowedError.
Parameters
- receiver: TokenHolderAccount
  
  The account address of the receiver.
Returns NotAllowedError
Overrides TokenError.constructor
- Defined in packages/sdk/src/plt/Token.ts:137

Properties

`Readonly` code

code: NOT_ALLOWED = TokenErrorCode.NOT_ALLOWED

message

message: string

`Readonly` receiver

receiver: TokenHolderAccount

The account address of the receiver.

`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
Gets the name of the error, including its code.

Returns
The name of the error.

Returns string
Inherited from TokenError.name
- Defined in packages/sdk/src/plt/Token.ts:84

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 TokenError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc