Erc20TokenBalance

Used to manage a ERC20 token balance

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Erc20TokenBalance(params: Params & UniqueIdentifiers): Erc20TokenBalance

Defined in src/entities/Erc20TokenBalance.ts:84

Create an ERC20 Token balance instance

Parameters:

Name

Type

params

Returns: Erc20TokenBalance

Properties

balance

balance: BigNumber

Defined in src/entities/Erc20TokenBalance.ts:84

total number of tokens belonging to token holder

tokenAddress

tokenAddress: string

Defined in src/entities/Erc20TokenBalance.ts:74

address of the ERC20 token

tokenSymbol

tokenSymbol: string | null

Defined in src/entities/Erc20TokenBalance.ts:69

uid

uid: string

Overrides Entity.uid

Defined in src/entities/Erc20TokenBalance.ts:67

unique generated identifier for an ERC20 token balance

walletAddress

walletAddress: string

Defined in src/entities/Erc20TokenBalance.ts:79

wallet address of the token holder

Methods

_refresh

_refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/Erc20TokenBalance.ts:122

Hydrate the entity

Parameters:

Name

Type

params

Partial‹Params

Returns: void

toPojo

toPojo(): object

Overrides Entity.toPojo

Defined in src/entities/Erc20TokenBalance.ts:107

Convert entity to a POJO (Plain Old Javascript Object)

Returns: object

  • balance: BigNumber

  • tokenAddress: string

  • tokenSymbol: null | string

  • uid: string

  • walletAddress: string

Static generateId

generateId(__namedParameters: object): string

Defined in src/entities/Erc20TokenBalance.ts:39

Generate the ERC20 Token Balance's UUID from its identifying properties

Parameters:

__namedParameters: object

Name

Type

tokenAddress

string

walletAddress

string

Returns: string

Static unserialize

unserialize(serialized: any): UniqueIdentifiers

Defined in src/entities/Erc20TokenBalance.ts:51

Unserialize a serialized erc20 token balance

Parameters:

Name

Type

Description

serialized

any

string with erc20 token balance entity information

Returns: UniqueIdentifiers

Last updated