Class Embers

Class which can be used to interact with the Embers (MBRS) token contract

Hierarchy

Embers

Implements

Index

Constructors

constructor

Properties

token

Methods

Constructors

constructor

new Embers(provider: Provider): Embers

- Defined in pyropets/Embers.ts:13
Parameters
- provider: Provider
Returns Embers

Properties

Private token

token: MetrixContract

Methods

allowance

allowance(owner: string, spender: string): Promise<bigint>

Implementation of IERC20Metadata.allowance
- Defined in pyropets/Embers.ts:22
Returns the remaining number of tokens that spender will be allowed to spend on behalf of owner through transferFrom. This is zero by default. This value changes when approve or transferFrom are called.

Parameters
- owner: string
- spender: string
Returns Promise<bigint>

approve

approve(spender: string, amount: bigint): Promise<Transaction>

Implementation of IERC20Metadata.approve
- Defined in pyropets/Embers.ts:34
Sets amount as the allowance of spender over the caller's tokens.

Emits an {Approval} event.

Parameters
- spender: string
- amount: bigint
Returns Promise<Transaction>

balanceOf

balanceOf(owner: string): Promise<bigint>

Implementation of IERC20Metadata.balanceOf
- Defined in pyropets/Embers.ts:50
Returns the amount of tokens owned by account.

Parameters
- owner: string
Returns Promise<bigint>

base

base(): Promise<string>

- Defined in pyropets/Embers.ts:62
Returns the address of the PyroCore contract

Returns Promise<string>

burn

burn(amount: bigint): Promise<Transaction>

- Defined in pyropets/Embers.ts:71
Permanently destroy MBRS tokens from the transaction sender's account

Parameters
- amount: bigint
  
  the amount of MBRS tokens to burn
Returns Promise<Transaction>

burnFrom

burnFrom(account: string, amount: bigint): Promise<Transaction>

- Defined in pyropets/Embers.ts:91
Permanently destroy MBRS tokens from the specified account

Parameters
- account: string
  
  the account to burn the MBRS tokens
- amount: bigint
  
  the amount of MBRS tokens to burn
Returns Promise<Transaction>

createEmbers

createEmbers(): Promise<Transaction>

- Defined in pyropets/Embers.ts:110
Create MBRS tokens by burning MRX

Returns Promise<Transaction>

decimals

decimals(): Promise<number>

Implementation of IERC20Metadata.decimals
- Defined in pyropets/Embers.ts:123
Returns the decimals places of the token.

Returns Promise<number>

decreaseAllowance

decreaseAllowance(spender: string, amount: bigint): Promise<Transaction>

Implementation of ERC20.decreaseAllowance
- Defined in pyropets/Embers.ts:132
Atomically decreases the allowance granted to spender by the caller.
This is an alternative to approve that can be used as a mitigation for problems described in approve.

Emits an {Approval} event indicating the updated allowance.

Requirements:
- spender cannot be the zero address.
- spender must have allowance for the caller of at least amount.
Parameters
- spender: string
- amount: bigint
Returns Promise<Transaction>

increaseAllowance

increaseAllowance(spender: string, amount: bigint): Promise<Transaction>

Implementation of ERC20.increaseAllowance
- Defined in pyropets/Embers.ts:151
Atomically increases the allowance granted to spender by the caller.
This is an alternative to approve that can be used as a mitigation for problems described in approve.

Emits an {Approval} event indicating the updated allowance.

Requirements:
- spender cannot be the zero address.
Parameters
- spender: string
- amount: bigint
Returns Promise<Transaction>

minBurn

minBurn(): Promise<bigint>

- Defined in pyropets/Embers.ts:173
Returns the minimum amount of MBRS which can be burned

Returns Promise<bigint>

mint

mint(): Promise<Transaction>

- Defined in pyropets/Embers.ts:185
Create MBRS tokens by burning MRX

Returns Promise<Transaction>

name

name(): Promise<string>

Implementation of IERC20Metadata.name
- Defined in pyropets/Embers.ts:198
Returns the name of the token.

Returns Promise<string>

symbol

symbol(): Promise<string>

Implementation of IERC20Metadata.symbol
- Defined in pyropets/Embers.ts:203
Returns the symbol of the token.

Returns Promise<string>

totalSupply

totalSupply(): Promise<bigint>

Implementation of IERC20Metadata.totalSupply
- Defined in pyropets/Embers.ts:208
Returns the amount of tokens in existence.

Returns Promise<bigint>

transfer

transfer(recipient: string, amount: bigint): Promise<Transaction>

Implementation of IERC20Metadata.transfer
- Defined in pyropets/Embers.ts:217
Moves amount tokens from the caller's account to recipient.

Emits a {Transfer} event.

Parameters
- recipient: string
- amount: bigint
Returns Promise<Transaction>

transferFrom

transferFrom(sender: string, recipient: string, amount: bigint): Promise<Transaction>

Implementation of IERC20Metadata.transferFrom
- Defined in pyropets/Embers.ts:233
Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance.

Emits a {Transfer} event.

Parameters
- sender: string
- recipient: string
- amount: bigint
Returns Promise<Transaction>

Generated using TypeDoc