@armada/sdk

Appearance

@armada/sdk / core / UnshieldNoteERC20

Class: UnshieldNoteERC20 ​

Defined in: vendor/railgun-engine/dist/note/erc20/unshield-note-erc20.d.ts:2

Extends ​

  • UnshieldNote

Constructors ​

Constructor ​

new UnshieldNoteERC20(toAddress, value, tokenAddress, allowOverride?): UnshieldNoteERC20

Defined in: vendor/railgun-engine/dist/note/erc20/unshield-note-erc20.d.ts:3

Parameters ​

toAddress ​

string

value ​

bigint

tokenAddress ​

string

allowOverride? ​

boolean

Returns ​

UnshieldNoteERC20

Overrides ​

UnshieldNote.constructor

Properties ​

toAddress ​

readonly toAddress: string

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:5

Inherited from ​

UnshieldNote.toAddress

value ​

readonly value: bigint

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:6

Inherited from ​

UnshieldNote.value

tokenData ​

readonly tokenData: TokenData

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:7

Inherited from ​

UnshieldNote.tokenData

hash ​

readonly hash: bigint

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:8

Inherited from ​

UnshieldNote.hash

allowOverride ​

readonly allowOverride: boolean

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:9

Inherited from ​

UnshieldNote.allowOverride

Accessors ​

unshieldData ​

Get Signature ​

get unshieldData(): UnshieldData

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:18

Returns ​

UnshieldData

Inherited from ​

UnshieldNote.unshieldData

npk ​

Get Signature ​

get npk(): string

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:19

Returns ​

string

Inherited from ​

UnshieldNote.npk

notePublicKey ​

Get Signature ​

get notePublicKey(): bigint

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:20

Returns ​

bigint

Inherited from ​

UnshieldNote.notePublicKey

hashHex ​

Get Signature ​

get hashHex(): string

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:21

Returns ​

string

Inherited from ​

UnshieldNote.hashHex

preImage ​

Get Signature ​

get preImage(): CommitmentPreimageStruct

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:27

Returns ​

CommitmentPreimageStruct

Inherited from ​

UnshieldNote.preImage

Methods ​

empty() ​

static empty(): UnshieldNote

Defined in: vendor/railgun-engine/dist/note/erc20/unshield-note-erc20.d.ts:4

Returns ​

UnshieldNote

serialize() ​

serialize(prefix?): object

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:22

Parameters ​

prefix? ​

boolean

Returns ​

object

npk ​

npk: string

token ​

token: TokenData

value ​

value: string

Inherited from ​

UnshieldNote.serialize

getAmountFeeFromValue() ​

static getAmountFeeFromValue(value, feeBasisPoints): object

Defined in: vendor/railgun-engine/dist/note/unshield-note.d.ts:28

Parameters ​

value ​

bigint

feeBasisPoints ​

bigint

Returns ​

object

amount ​

amount: bigint

fee ​

fee: bigint

Inherited from ​

UnshieldNote.getAmountFeeFromValue