Skip to content

Latest commit

 

History

History
310 lines (182 loc) · 9.46 KB

wethhelper.md

File metadata and controls

310 lines (182 loc) · 9.46 KB
Raw

Wrapped Ether Helper › Globals › WethHelper

Class: WethHelper

WethHelper (Wrapper Ether helper) is a class that abstracts the process of wrapping and unwrapping Ether using the canonical WETH (WETH9) contract.

It also provides methods for checking balances (ETH and WETH) and setting proxy allowances for interacting with the 0x contract system.

All numerical values are expected as BigNumbers, and all units for balances and allowances are returned as, and expected in base units (wei).

Methods are provided to convert between base units (wei) and ether.

Hierarchy

  • WethHelper

Index

Constructors

Methods

Constructors

constructor

+ new WethHelper(provider: SupportedProvider, txDefaults: Partial‹TxData›): WethHelper

Defined in weth_helper.ts:31

Create a new WethHelper instance with a configured provider and optional transaction defaults.

Parameters:

Name Type Default Description
provider SupportedProvider - A configured Ethereum JSONRPC provider instance.
txDefaults Partial‹TxData› {} Optional defaults to use for all transactions.

Returns: WethHelper

Methods

fromBaseUnits

▸ fromBaseUnits(value: number | string | BigNumber, decimals: number): BigNumber

Defined in weth_helper.ts:265

Convert a "base-unit" value (accurate representation) to "unit" (user) representation used to display values to users.

Parameters:

Name Type Default Description
value number | string | BigNumber - The value (as a number, string, or BigNumber) to convert.
decimals number 18 Optionally specify the number of decimals in a unit (default: 18).

Returns: BigNumber

A BigNumber representing the value converted to "full" units.

getCoinbase

▸ getCoinbase(): Promise‹string›

Defined in weth_helper.ts:58

Get the user's 0-index address (used if not overridden with TxData) for transaction calls.

In web3 browsers, the coinbase is the configured address.

Returns: Promise‹string›

A promise that resolves to the user's coinbase address.

getEtherBalance

▸ getEtherBalance(address?: string): Promise‹BigNumber›

Defined in weth_helper.ts:142

Fetch the Ether balance of an account (in base units).

If no address parameter is defined, the detected coinbase is used.

Parameters:

Name Type Description
address? string A user's Ethereum address to check the balance for.

Returns: Promise‹BigNumber›

A promise that resolves to the user's ETH balance in base units (wei) as a BigNumber.

getNetworkId

▸ getNetworkId(): Promise‹number›

Defined in weth_helper.ts:68

Get the detected Ethereum network ID (1 for mainnet, 3 for ropsten, etc.)

Returns: Promise‹number›

A promise that resolves to the network ID as a number.

getProxyAllowance

▸ getProxyAllowance(owner?: string): Promise‹BigNumber›

Defined in weth_helper.ts:188

Get the current 0x ERC-20 asset proxy allowance for the wrapped ether token for the detected network (returns a BigNumber value in base units).

Parameters:

Name Type Description
owner? string The address to check WETH proxy allowance for (defaults to coinbase).

Returns: Promise‹BigNumber›

A promise that resolves to a BigNumber representing the current WETH asset proxy allowance.

getWethAddress

▸ getWethAddress(): Promise‹string›

Defined in weth_helper.ts:79

Fetch the address for the canonical wrapped ether (wETH) contract for the detected Ethereum network.

Returns: Promise‹string›

A promise that resolves to the wETH token address.

getWethBalance

▸ getWethBalance(address?: string): Promise‹BigNumber›

Defined in weth_helper.ts:165

Fetch the wrapped-Ether (WETH) balance of an account (in base units).

If no address parameter is defined, the detected coinbase is used.

Parameters:

Name Type Description
address? string A user's Ethereum address to check the balance for.

Returns: Promise‹BigNumber›

A promise that resolves to the user's WETH balance in base units (wei) as a BigNumber.

setProxyAllowance

▸ setProxyAllowance(amount: BigNumber, txDefaults?: Partial‹TxData›): Promise‹string›

Defined in weth_helper.ts:215

Set an arbitrary spender allowance value for the 0x ERC-20 proxy contract for the wrapped-ether (WETH) token for trading in the 0x ecosystem.

If a specific allowance is not needed, it is recommended to instead set an "unlimited" allowance which will decrease the cost of trading.

Parameters:

Name Type Description
amount BigNumber The amount of tokens to allow the proxy contract to spend (in base units).
txDefaults? Partial‹TxData› Optional transaction data: gas limit, gas price, and from address.

Returns: Promise‹string›

A promise that resolves to the submitted transaction hash (ID).

setUnlimitedProxyAllowance

▸ setUnlimitedProxyAllowance(txDefaults?: Partial‹TxData›): Promise‹string›

Defined in weth_helper.ts:237

Set an "unlimited" (maximum unit256) ERC-20 proxy allowance for WETH for trading within the 0x ecosystem.

Parameters:

Name Type Description
txDefaults? Partial‹TxData› Optional transaction data: gas limit, gas price, and from address.

Returns: Promise‹string›

A promise that resolves to the submitted transaction hash (ID).

toBaseUnits

▸ toBaseUnits(value: number | string | BigNumber, decimals: number): BigNumber

Defined in weth_helper.ts:249

Convert a "unit" value (user representation) to base-unit (wei) representation used in contract logic.

Parameters:

Name Type Default Description
value number | string | BigNumber - The value (as a number, string, or BigNumber) to convert.
decimals number 18 Optionally specify the number of decimals in a unit (default: 18).

Returns: BigNumber

A BigNumber representing the value converted to "base" units.

unwrap

▸ unwrap(amount: BigNumber, txDefaults?: Partial‹TxData›): Promise‹string›

Defined in weth_helper.ts:120

Generate ETH by "un-wrapping" WETH: submitting a transaction to request a withdrawal from the WETH contract.

Will send the transaction from the configured/detected coinbase address unless overridden with txDefaults (second parameter).

Parameters:

Name Type Description
amount BigNumber The amount of Ether to un-wrap in base units (wei).
txDefaults? Partial‹TxData› Optional transaction data: gas limit, gas price, and from address.

Returns: Promise‹string›

A promise that resolves to the submitted transaction hash (ID).

wrap

▸ wrap(amount: BigNumber, txDefaults?: Partial‹TxData›): Promise‹string›

Defined in weth_helper.ts:95

Generate WETH by "wrapping" Ether: submitting it to the WETH contract using the deposit method.

Will send the transaction from the configured/detected coinbase address unless overridden with txDefaults (second parameter).

Parameters:

Name Type Description
amount BigNumber The amount of Ether to wrap in base units (wei).
txDefaults? Partial‹TxData› Optional transaction data: gas limit, gas price, and from address.

Returns: Promise‹string›

A promise that resolves to the submitted transaction hash (ID).