Class RadixTransferrableTokensParticle

A particle which represents an amount of consumable and consuming, tranferable fungible tokens owned by some key owner and stored in an account.

Hierarchy

RadixParticle
- RadixTransferrableTokensParticle

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RadixTransferrableTokensParticle(amount: BN, granularity: BN, address: RadixAddress, nonce: number, tokenReference: RRI, tokenPermissions: RadixTokenPermissions, planck?: number): RadixTransferrableTokensParticle

Overrides RadixParticle.constructor
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:51
Parameters
- amount: BN
- granularity: BN
- address: RadixAddress
- nonce: number
- tokenReference: RRI
- tokenPermissions: RadixTokenPermissions
- Optional planck: number
Returns RadixTransferrableTokensParticle

Properties

address

address: RadixAddress

amount

amount: RadixUInt256

granularity

granularity: RadixUInt256

nonce

nonce: number

permissions

permissions: RadixTokenPermissions

planck

planck: number

tokenDefinitionReference

tokenDefinitionReference: RRI

version

version: number = 100

Static SERIALIZER

SERIALIZER: string = ""

Accessors

destinations

get destinations(): RadixEUID[]
set destinations(destinations: RadixEUID[]): void

Inherited from RadixParticle.destinations
- Defined in modules/atommodel/particles/RadixParticle.ts:29
Returns RadixEUID[]
Inherited from RadixParticle.destinations
- Defined in modules/atommodel/particles/RadixParticle.ts:33
Parameters
- destinations: RadixEUID[]
Returns void

serializer

get serializer(): string
set serializer(_: string): void

Inherited from RadixSerializableObject.serializer
- Defined in modules/atommodel/RadixSerializableObject.ts:33
Returns string
Inherited from RadixSerializableObject.serializer
- Defined in modules/atommodel/RadixSerializableObject.ts:37
Parameters
- _: string
Returns void

Methods

encodeCBOR

encodeCBOR(encoder: any): boolean

Implementation of RadixConsumable.encodeCBOR

Inherited from RadixSerializableObject.encodeCBOR
- Defined in modules/atommodel/RadixSerializableObject.ts:61
Parameters
- encoder: any
Returns boolean

getAddress

getAddress(): RadixAddress

- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:79
Returns RadixAddress

getAddresses

getAddresses(): RadixAddress[]

Implementation of RadixConsumable.getAddresses

Overrides RadixParticle.getAddresses
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:83
Returns RadixAddress[]

getAmount

getAmount(): BN

Implementation of RadixConsumable.getAmount
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:107
Returns BN

getDestinations

getDestinations(): RadixEUID[]

Implementation of RadixConsumable.getDestinations

Inherited from RadixParticle.getDestinations
- Defined in modules/atommodel/particles/RadixParticle.ts:23
Returns RadixEUID[]

getGranularity

getGranularity(): BN

Implementation of RadixConsumable.getGranularity
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:111
Returns BN

getHash

getHash(): Buffer

Implementation of RadixConsumable.getHash

Inherited from RadixSerializableObject.getHash
- Defined in modules/atommodel/RadixSerializableObject.ts:81
Returns Buffer

getHid

getHid(): RadixEUID

Implementation of RadixConsumable.getHid

Inherited from RadixParticle.getHid
- Defined in modules/atommodel/particles/RadixParticle.ts:15
Returns RadixEUID

getHidString

getHidString(): string

Implementation of RadixConsumable.getHidString

Inherited from RadixParticle.getHidString
- Defined in modules/atommodel/particles/RadixParticle.ts:19
Returns string

getNonce

getNonce(): number

- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:95
Returns number

getOwner

getOwner(): RadixAddress

Implementation of RadixConsumable.getOwner
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:103
Returns RadixAddress

getPlanck

getPlanck(): number

- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:91
Returns number

getSize

getSize(): number

Implementation of RadixConsumable.getSize

Inherited from RadixSerializableObject.getSize
- Defined in modules/atommodel/RadixSerializableObject.ts:85
Returns number

getTokenDefinitionReference

getTokenDefinitionReference(): RRI

Implementation of RadixConsumable.getTokenDefinitionReference
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:99
Returns RRI

getTokenPermissions

getTokenPermissions(): RadixTokenPermissions

Implementation of RadixConsumable.getTokenPermissions
- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:115
Returns RadixTokenPermissions

getType

getType(): RadixFungibleType

- Defined in modules/atommodel/particles/tokens/RadixTransferrableTokensParticle.ts:87
Returns RadixFungibleType

toDSON

toDSON(): Buffer

Implementation of RadixConsumable.toDSON

Inherited from RadixSerializableObject.toDSON
- Defined in modules/atommodel/RadixSerializableObject.ts:57
Returns Buffer

toJSON

toJSON(): object

Implementation of RadixConsumable.toJSON

Inherited from RadixSerializableObject.toJSON
- Defined in modules/atommodel/RadixSerializableObject.ts:41
Returns object
- serializer: string

Static fromJSON

fromJSON(json?: object): any

Implementation of RadixConsumable.fromJSON

Inherited from RadixSerializableObject.fromJSON
- Defined in modules/atommodel/RadixSerializableObject.ts:15
Parameters
- Optional json: object
Returns any

Generated using TypeDoc