BrandedEther

Type Aliases

BrandedEther

BrandedEther = EtherType

Defined in: src/primitives/Denomination/EtherType.ts:12

EtherType

EtherType = string & object

Defined in: src/primitives/Denomination/EtherType.ts:9 Branded Ether type - represents Ethereum amounts in ether (10^18 wei) Uses string to support decimal values like “1.5” or “0.001” For whole number wei amounts, use WeiType (bigint)

Type Declaration

[brand]

readonly [brand]: "Ether"

Variables

Ether

const Ether: object

Defined in: src/primitives/Denomination/ether-index.ts:19

Type Declaration

from()

from: (value) => EtherType

Create Ether from bigint, number, or string Ether is a string type to support decimal values like “1.5” or “0.001”

Parameters

value

Value to convert (bigint, number, or string) string | number | bigint

Returns

EtherType Ether amount as branded string

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If value is not a valid number

Example

const ether1 = Ether.from(1n);        // "1"
const ether2 = Ether.from(1.5);       // "1.5"
const ether3 = Ether.from("1.5");     // "1.5"
const ether4 = Ether.from("0.001");   // "0.001"

fromGwei()

fromGwei: (gwei) => EtherType

Convert Gwei to Ether Converts gwei string to ether string (divides by 10^9). Alias for Gwei.toEther().

Parameters

gwei

GweiType Amount in Gwei (string)

Returns

EtherType Amount in Ether (string)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const ether1 = Ether.fromGwei(Gwei.from("1000000000")); // "1"
const ether2 = Ether.fromGwei(Gwei.from("1500000000")); // "1.5"

fromWei()

fromWei: (wei) => EtherType

Convert Wei to Ether Converts bigint wei to decimal string ether value. Alias for Wei.toEther().

Parameters

wei

WeiType Amount in Wei (bigint)

Returns

EtherType Amount in Ether (string with decimal precision)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const ether1 = Ether.fromWei(Wei.from(1000000000000000000n)); // "1"
const ether2 = Ether.fromWei(Wei.from(1500000000000000000n)); // "1.5"

toGwei()

toGwei: (ether) => GweiType

Convert Ether to Gwei Converts ether string to gwei string (multiplies by 10^9).

Parameters

ether

EtherType Amount in Ether (string)

Returns

GweiType Amount in Gwei (string)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const gwei1 = Ether.toGwei(Ether.from("1"));   // "1000000000"
const gwei2 = Ether.toGwei(Ether.from("1.5")); // "1500000000"
const gwei3 = Ether.toGwei(Ether.from("0.000000001")); // "1"

toU256()

toU256: (ether) => Type

Convert Ether to Uint256 (in Wei) Converts ether string to wei bigint, then returns as Uint256.

Parameters

ether

EtherType Amount in Ether (string)

Returns

Type Uint256 value in Wei

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If ether value has more than 18 decimal places

Example

const u256_1 = Ether.toU256(Ether.from("1"));   // 1000000000000000000n
const u256_2 = Ether.toU256(Ether.from("1.5")); // 1500000000000000000n

toWei()

toWei: (ether) => WeiType

Convert Ether to Wei Parses decimal string and converts to bigint wei value.

Parameters

ether

EtherType Amount in Ether (string, supports decimals like “1.5”)

Returns

WeiType Amount in Wei (bigint)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If ether value has more than 18 decimal places

Example

const wei1 = Ether.toWei(Ether.from("1"));     // 1000000000000000000n
const wei2 = Ether.toWei(Ether.from("1.5"));   // 1500000000000000000n
const wei3 = Ether.toWei(Ether.from("0.001")); // 1000000000000000n

GWEI_PER_ETHER

const GWEI_PER_ETHER: 1000000000n = 1_000_000_000n

Defined in: src/primitives/Denomination/ether-constants.ts:15 Number of Gwei in one Ether (10^9)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

WEI_PER_ETHER

const WEI_PER_ETHER: 1000000000000000000n = 1_000_000_000_000_000_000n

Defined in: src/primitives/Denomination/ether-constants.ts:7 Number of Wei in one Ether (10^18)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Functions

from()

from(value): EtherType

Defined in: src/primitives/Denomination/ether-from.ts:21 Create Ether from bigint, number, or string Ether is a string type to support decimal values like “1.5” or “0.001”

Parameters

value

Value to convert (bigint, number, or string) string | number | bigint

Returns

EtherType Ether amount as branded string

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If value is not a valid number

Example

const ether1 = Ether.from(1n);        // "1"
const ether2 = Ether.from(1.5);       // "1.5"
const ether3 = Ether.from("1.5");     // "1.5"
const ether4 = Ether.from("0.001");   // "0.001"

fromGwei()

fromGwei(gwei): EtherType

Defined in: src/primitives/Denomination/ether-fromGwei.ts:22 Convert Gwei to Ether Converts gwei string to ether string (divides by 10^9). Alias for Gwei.toEther().

Parameters

gwei

GweiType Amount in Gwei (string)

Returns

EtherType Amount in Ether (string)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const ether1 = Ether.fromGwei(Gwei.from("1000000000")); // "1"
const ether2 = Ether.fromGwei(Gwei.from("1500000000")); // "1.5"

fromWei()

fromWei(wei): EtherType

Defined in: src/primitives/Denomination/ether-fromWei.ts:22 Convert Wei to Ether Converts bigint wei to decimal string ether value. Alias for Wei.toEther().

Parameters

wei

WeiType Amount in Wei (bigint)

Returns

EtherType Amount in Ether (string with decimal precision)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const ether1 = Ether.fromWei(Wei.from(1000000000000000000n)); // "1"
const ether2 = Ether.fromWei(Wei.from(1500000000000000000n)); // "1.5"

toGwei()

toGwei(ether): GweiType

Defined in: src/primitives/Denomination/ether-toGwei.ts:23 Convert Ether to Gwei Converts ether string to gwei string (multiplies by 10^9).

Parameters

ether

EtherType Amount in Ether (string)

Returns

GweiType Amount in Gwei (string)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

Example

const gwei1 = Ether.toGwei(Ether.from("1"));   // "1000000000"
const gwei2 = Ether.toGwei(Ether.from("1.5")); // "1500000000"
const gwei3 = Ether.toGwei(Ether.from("0.000000001")); // "1"

toU256()

toU256(ether): Type

Defined in: src/primitives/Denomination/ether-toU256.ts:21 Convert Ether to Uint256 (in Wei) Converts ether string to wei bigint, then returns as Uint256.

Parameters

ether

EtherType Amount in Ether (string)

Returns

Type Uint256 value in Wei

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If ether value has more than 18 decimal places

Example

const u256_1 = Ether.toU256(Ether.from("1"));   // 1000000000000000000n
const u256_2 = Ether.toU256(Ether.from("1.5")); // 1500000000000000000n

toWei()

toWei(ether): WeiType

Defined in: src/primitives/Denomination/ether-toWei.ts:23 Convert Ether to Wei Parses decimal string and converts to bigint wei value.

Parameters

ether

EtherType Amount in Ether (string, supports decimals like “1.5”)

Returns

WeiType Amount in Wei (bigint)

See

https://voltaire.tevm.sh/primitives/denomination for Denomination documentation

Since

0.0.0

Throws

If ether value has more than 18 decimal places

Example

const wei1 = Ether.toWei(Ether.from("1"));     // 1000000000000000000n
const wei2 = Ether.toWei(Ether.from("1.5"));   // 1500000000000000000n
const wei3 = Ether.toWei(Ether.from("0.001")); // 1000000000000000n

Overview

Getting Started

Core Concepts

Skills

JSONRPCProvider

Contract

Primitives

Cryptography

EVM

Utils

Guides

Examples

Swift

Zig

Developer Documentation

Generated API (TypeDoc)

​BrandedEther

​Type Aliases

​BrandedEther

​EtherType

​Type Declaration

[brand]

​Variables

​Ether

​Type Declaration

from()

Parameters

value

Returns

See

Since

Throws

Example

fromGwei()

Parameters

gwei

Returns

See

Since

Throws

Example

fromWei()

Parameters

wei

Returns

See

Since

Throws

Example

toGwei()

Parameters

ether

Returns

See

Since

Throws

Example

toU256()

Parameters

ether

Returns

See

Since

Throws

Example

toWei()

Parameters

ether

Returns

See

Since

Throws

Example

​GWEI_PER_ETHER

​See

​Since

​WEI_PER_ETHER

​See

​Since

​Functions

BrandedEther

Type Aliases

BrandedEther

EtherType

Type Declaration

Variables

Ether

Type Declaration

GWEI_PER_ETHER

See

Since

WEI_PER_ETHER

See

Since

Functions

from()

Parameters

Returns

See

Since

Throws

Example

fromGwei()

Parameters

Returns

See

Since

Throws

Example

fromWei()

Parameters

Returns

See

Since

Throws

Example

toGwei()

Parameters

Returns

See

Since

Throws

Example

toU256()

Parameters

Returns

See

Since

Throws

Example

toWei()

Parameters

Returns

See

Since

Throws

Example