Token

Defined in: packages/iso-filecoin/src/token.js:70

Class to work with different Filecoin denominations.

See

https://docs.filecoin.io/basics/assets/the-fil-token/#denomonations

Constructors

Constructor

new Token(val): Token

Defined in: packages/iso-filecoin/src/token.js:76

Parameters

Parameter	Type
val	Value

Returns

Token

Methods

abs()

abs(): Token

Defined in: packages/iso-filecoin/src/token.js:144

Returns

Token

---

add()

add(val): Token

Defined in: packages/iso-filecoin/src/token.js:151

Parameters

Parameter	Type
val	Value

Returns

Token

---

div()

div(val): Token

Defined in: packages/iso-filecoin/src/token.js:140

Parameters

Parameter	Type
val	Value

Returns

Token

---

mul()

mul(val): Token

Defined in: packages/iso-filecoin/src/token.js:133

Parameters

Parameter	Type
val	Value

Returns

Token

---

sub()

sub(val): Token

Defined in: packages/iso-filecoin/src/token.js:158

Parameters

Parameter	Type
val	Value

Returns

Token

---

toAttoFIL()

toAttoFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:197

Returns

Token

---

toBigInt()

toBigInt(): bigint

Defined in: packages/iso-filecoin/src/token.js:229

Returns

bigint

---

toBytes()

toBytes(): Uint8Array<ArrayBuffer>

Defined in: packages/iso-filecoin/src/token.js:233

Returns

Uint8Array<ArrayBuffer>

---

toFemtoFIL()

toFemtoFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:205

Returns

Token

---

toFIL()

toFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:225

Returns

Token

---

toFormat()

toFormat(options?): string

Defined in: packages/iso-filecoin/src/token.js:177

Format the number using the given options.

Parameters

Parameter	Type
options?	FormatOptions

Returns

string

See

https://mikemcl.github.io/bignumber.js/#toFor

---

toMicroFIL()

toMicroFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:217

Returns

Token

---

toMilliFIL()

toMilliFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:221

Returns

Token

---

toNanoFIL()

toNanoFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:213

Returns

Token

---

toPicoFIL()

toPicoFIL(): Token

Defined in: packages/iso-filecoin/src/token.js:209

Returns

Token

---

toString()

toString(base?): string

Defined in: packages/iso-filecoin/src/token.js:167

Serialize the number to a string using the given base.

Parameters

Parameter	Type	Default value
base?	number	10

Returns

string

---

fromAttoFIL()

static fromAttoFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:84

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromFemtoFIL()

static fromFemtoFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:91

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromFIL()

static fromFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:126

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromMicroFIL()

static fromMicroFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:112

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromMilliFIL()

static fromMilliFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:119

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromNanoFIL()

static fromNanoFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:105

Parameters

Parameter	Type
val	Value

Returns

Token

---

fromPicoFIL()

static fromPicoFIL(val): Token

Defined in: packages/iso-filecoin/src/token.js:98

Parameters

Parameter	Type
val	Value

Returns

Token

Properties

[symbol]

[symbol]: boolean = true

Defined in: packages/iso-filecoin/src/token.js:72

---

val

val: BigNumber

Defined in: packages/iso-filecoin/src/token.js:78