Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TokenWrapper

Hierarchy

  • BaseContract
    • TokenWrapper

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TokenWrapper(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): TokenWrapper

  • Parameters

    • addressOrName: string
    • contractInterface: ContractInterface
    • Optional signerOrProvider: Signer | Provider

    Returns TokenWrapper

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

  • [eventTag: string]: (...args: any[]) => void
      • (...args: any[]): void

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: { DEFAULT_ADMIN_ROLE: any; MINTER_ROLE: any; PAUSER_ROLE: any; allowance: any; approve: any; balanceOf: any; burn: any; burnFrom: any; decimals: any; decreaseAllowance: any; feeRecipient: any; getAmountToWrap: any; getFeeFromAmount: any; getRoleAdmin: any; getRoleMember: any; getRoleMemberCount: any; grantRole: any; hasRole: any; increaseAllowance: any; mint: any; name: any; pause: any; paused: any; renounceRole: any; revokeRole: any; setFee: any; supportsInterface: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unpause: any; unwrap: any; unwrapAndSendTo: any; unwrapFor: any; wrap: any; wrapFor: any; wrapForAndSendTo: any }

Type declaration

  • DEFAULT_ADMIN_ROLE:function
    • DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<string>
  • MINTER_ROLE:function
    • MINTER_ROLE(overrides?: CallOverrides): Promise<string>
  • PAUSER_ROLE:function
    • PAUSER_ROLE(overrides?: CallOverrides): Promise<string>
  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
  • burn:function
    • burn(amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • burnFrom:function
    • burnFrom(account: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<number>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • feeRecipient:function
    • feeRecipient(overrides?: CallOverrides): Promise<string>
  • getAmountToWrap:function
    • getAmountToWrap(_deposit: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
  • getFeeFromAmount:function
    • getFeeFromAmount(_amountToWrap: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>
  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>
  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>
  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>
  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • mint:function
    • mint(to: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • name:function
    • name(overrides?: CallOverrides): Promise<string>
  • pause:function
    • pause(overrides?: CallOverrides): Promise<void>
  • paused:function
    • paused(overrides?: CallOverrides): Promise<boolean>
  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>
  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<void>
  • setFee:function
    • setFee(_feePercentage: BigNumberish, _nonce: BigNumberish, overrides?: CallOverrides): Promise<void>
  • supportsInterface:function
    • supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<string>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<BigNumber>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • unpause:function
    • unpause(overrides?: CallOverrides): Promise<void>
  • unwrap:function
    • unwrap(tokenAddress: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • unwrapAndSendTo:function
    • unwrapAndSendTo(tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: CallOverrides): Promise<void>
  • unwrapFor:function
    • unwrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • wrap:function
    • wrap(tokenAddress: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • wrapFor:function
    • wrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>
  • wrapForAndSendTo:function
    • wrapForAndSendTo(sender: string, tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: CallOverrides): Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { DEFAULT_ADMIN_ROLE: any; MINTER_ROLE: any; PAUSER_ROLE: any; allowance: any; approve: any; balanceOf: any; burn: any; burnFrom: any; decimals: any; decreaseAllowance: any; feeRecipient: any; getAmountToWrap: any; getFeeFromAmount: any; getRoleAdmin: any; getRoleMember: any; getRoleMemberCount: any; grantRole: any; hasRole: any; increaseAllowance: any; mint: any; name: any; pause: any; paused: any; renounceRole: any; revokeRole: any; setFee: any; supportsInterface: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unpause: any; unwrap: any; unwrapAndSendTo: any; unwrapFor: any; wrap: any; wrapFor: any; wrapForAndSendTo: any }

Type declaration

  • DEFAULT_ADMIN_ROLE:function
    • DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<BigNumber>
  • MINTER_ROLE:function
    • MINTER_ROLE(overrides?: CallOverrides): Promise<BigNumber>
  • PAUSER_ROLE:function
    • PAUSER_ROLE(overrides?: CallOverrides): Promise<BigNumber>
  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
  • burn:function
    • burn(amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • burnFrom:function
    • burnFrom(account: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<BigNumber>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • feeRecipient:function
    • feeRecipient(overrides?: CallOverrides): Promise<BigNumber>
  • getAmountToWrap:function
    • getAmountToWrap(_deposit: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
  • getFeeFromAmount:function
    • getFeeFromAmount(_amountToWrap: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>
  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<BigNumber>
  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • mint:function
    • mint(to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • name:function
    • name(overrides?: CallOverrides): Promise<BigNumber>
  • pause:function
    • pause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • paused:function
    • paused(overrides?: CallOverrides): Promise<BigNumber>
  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • setFee:function
    • setFee(_feePercentage: BigNumberish, _nonce: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • supportsInterface:function
    • supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<BigNumber>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<BigNumber>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • unpause:function
    • unpause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • unwrap:function
    • unwrap(tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • unwrapAndSendTo:function
    • unwrapAndSendTo(tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • unwrapFor:function
    • unwrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • wrap:function
    • wrap(tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • wrapFor:function
    • wrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<BigNumber>
  • wrapForAndSendTo:function
    • wrapForAndSendTo(sender: string, tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • recipient: string
      • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

filters

filters: { Approval: any; Approval(address,address,uint256): any; Paused: any; Paused(address): any; RoleAdminChanged: any; RoleAdminChanged(bytes32,bytes32,bytes32): any; RoleGranted: any; RoleGranted(bytes32,address,address): any; RoleRevoked: any; RoleRevoked(bytes32,address,address): any; Transfer: any; Transfer(address,address,uint256): any; Unpaused: any; Unpaused(address): any }

Type declaration

  • Approval:function
    • Approval(owner?: string, spender?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

    • Parameters

      • Optional owner: string
      • Optional spender: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

  • Approval(address,address,uint256):function
    • Approval(address,address,uint256)(owner?: string, spender?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

    • Parameters

      • Optional owner: string
      • Optional spender: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

  • Paused:function
    • Paused(account?: null): TypedEventFilter<[string], { account: string }>
  • Paused(address):function
    • Paused(address)(account?: null): TypedEventFilter<[string], { account: string }>
  • RoleAdminChanged:function
    • RoleAdminChanged(role?: BytesLike, previousAdminRole?: BytesLike, newAdminRole?: BytesLike): TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional previousAdminRole: BytesLike
      • Optional newAdminRole: BytesLike

      Returns TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

  • RoleAdminChanged(bytes32,bytes32,bytes32):function
    • RoleAdminChanged(bytes32,bytes32,bytes32)(role?: BytesLike, previousAdminRole?: BytesLike, newAdminRole?: BytesLike): TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional previousAdminRole: BytesLike
      • Optional newAdminRole: BytesLike

      Returns TypedEventFilter<[string, string, string], { newAdminRole: string; previousAdminRole: string; role: string }>

  • RoleGranted:function
    • RoleGranted(role?: BytesLike, account?: string, sender?: string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional account: string
      • Optional sender: string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • RoleGranted(bytes32,address,address):function
    • RoleGranted(bytes32,address,address)(role?: BytesLike, account?: string, sender?: string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional account: string
      • Optional sender: string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • RoleRevoked:function
    • RoleRevoked(role?: BytesLike, account?: string, sender?: string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional account: string
      • Optional sender: string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • RoleRevoked(bytes32,address,address):function
    • RoleRevoked(bytes32,address,address)(role?: BytesLike, account?: string, sender?: string): TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

    • Parameters

      • Optional role: BytesLike
      • Optional account: string
      • Optional sender: string

      Returns TypedEventFilter<[string, string, string], { account: string; role: string; sender: string }>

  • Transfer:function
    • Transfer(from?: string, to?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

    • Parameters

      • Optional from: string
      • Optional to: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

  • Transfer(address,address,uint256):function
    • Transfer(address,address,uint256)(from?: string, to?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

    • Parameters

      • Optional from: string
      • Optional to: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

  • Unpaused:function
    • Unpaused(account?: null): TypedEventFilter<[string], { account: string }>
  • Unpaused(address):function
    • Unpaused(address)(account?: null): TypedEventFilter<[string], { account: string }>

functions

functions: { DEFAULT_ADMIN_ROLE: any; MINTER_ROLE: any; PAUSER_ROLE: any; allowance: any; approve: any; balanceOf: any; burn: any; burnFrom: any; decimals: any; decreaseAllowance: any; feeRecipient: any; getAmountToWrap: any; getFeeFromAmount: any; getRoleAdmin: any; getRoleMember: any; getRoleMemberCount: any; grantRole: any; hasRole: any; increaseAllowance: any; mint: any; name: any; pause: any; paused: any; renounceRole: any; revokeRole: any; setFee: any; supportsInterface: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unpause: any; unwrap: any; unwrapAndSendTo: any; unwrapFor: any; wrap: any; wrapFor: any; wrapForAndSendTo: any }

Type declaration

  • DEFAULT_ADMIN_ROLE:function
    • DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<[string]>
  • MINTER_ROLE:function
    • MINTER_ROLE(overrides?: CallOverrides): Promise<[string]>
  • PAUSER_ROLE:function
    • PAUSER_ROLE(overrides?: CallOverrides): Promise<[string]>
  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<[BigNumber]>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<[BigNumber]>
  • burn:function
    • burn(amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • burnFrom:function
    • burnFrom(account: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<[number]>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • feeRecipient:function
    • feeRecipient(overrides?: CallOverrides): Promise<[string]>
  • getAmountToWrap:function
    • getAmountToWrap(_deposit: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>
  • getFeeFromAmount:function
    • getFeeFromAmount(_amountToWrap: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber]>
  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<[string]>
  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<[string]>
  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<[BigNumber]>
  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<[boolean]>
  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • mint:function
    • mint(to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • name:function
    • name(overrides?: CallOverrides): Promise<[string]>
  • pause:function
    • pause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • paused:function
    • paused(overrides?: CallOverrides): Promise<[boolean]>
  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • setFee:function
    • setFee(_feePercentage: BigNumberish, _nonce: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • supportsInterface:function
    • supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<[boolean]>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<[string]>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<[BigNumber]>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • unpause:function
    • unpause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • unwrap:function
    • unwrap(tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • unwrapAndSendTo:function
    • unwrapAndSendTo(tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • tokenAddress: string
      • amount: BigNumberish
      • recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • unwrapFor:function
    • unwrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • wrap:function
    • wrap(tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
  • wrapFor:function
    • wrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • wrapForAndSendTo:function
    • wrapForAndSendTo(sender: string, tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • recipient: string
      • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

interface

interface: TokenWrapperInterface

populateTransaction

populateTransaction: { DEFAULT_ADMIN_ROLE: any; MINTER_ROLE: any; PAUSER_ROLE: any; allowance: any; approve: any; balanceOf: any; burn: any; burnFrom: any; decimals: any; decreaseAllowance: any; feeRecipient: any; getAmountToWrap: any; getFeeFromAmount: any; getRoleAdmin: any; getRoleMember: any; getRoleMemberCount: any; grantRole: any; hasRole: any; increaseAllowance: any; mint: any; name: any; pause: any; paused: any; renounceRole: any; revokeRole: any; setFee: any; supportsInterface: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unpause: any; unwrap: any; unwrapAndSendTo: any; unwrapFor: any; wrap: any; wrapFor: any; wrapForAndSendTo: any }

Type declaration

  • DEFAULT_ADMIN_ROLE:function
    • DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • MINTER_ROLE:function
    • MINTER_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • PAUSER_ROLE:function
    • PAUSER_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • burn:function
    • burn(amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • burnFrom:function
    • burnFrom(account: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • feeRecipient:function
    • feeRecipient(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • getAmountToWrap:function
    • getAmountToWrap(_deposit: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • getFeeFromAmount:function
    • getFeeFromAmount(_amountToWrap: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • getRoleAdmin:function
    • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • getRoleMember:function
    • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • getRoleMemberCount:function
    • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • grantRole:function
    • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • hasRole:function
    • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • mint:function
    • mint(to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • name:function
    • name(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • pause:function
    • pause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • paused:function
    • paused(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • renounceRole:function
    • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • revokeRole:function
    • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • setFee:function
    • setFee(_feePercentage: BigNumberish, _nonce: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • supportsInterface:function
    • supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • unpause:function
    • unpause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • unwrap:function
    • unwrap(tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • unwrapAndSendTo:function
    • unwrapAndSendTo(tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • tokenAddress: string
      • amount: BigNumberish
      • recipient: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • unwrapFor:function
    • unwrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • wrap:function
    • wrap(tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
  • wrapFor:function
    • wrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • wrapForAndSendTo:function
    • wrapForAndSendTo(sender: string, tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • sender: string
      • tokenAddress: string
      • amount: BigNumberish
      • recipient: string
      • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

DEFAULT_ADMIN_ROLE

  • DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<string>

MINTER_ROLE

  • MINTER_ROLE(overrides?: CallOverrides): Promise<string>

PAUSER_ROLE

  • PAUSER_ROLE(overrides?: CallOverrides): Promise<string>

_checkRunningEvents

  • _checkRunningEvents(runningEvent: RunningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?: BlockTag): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

  • Parameters

    • runningEvent: RunningEvent
    • log: Log
    • listener: Listener

    Returns Event

allowance

  • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>

approve

  • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

attach

balanceOf

  • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>

burn

  • burn(amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

burnFrom

  • burnFrom(account: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

connect

  • connect(signerOrProvider: string | Signer | Provider): TokenWrapper

decimals

  • decimals(overrides?: CallOverrides): Promise<number>

decreaseAllowance

  • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

deployed

emit

  • emit(eventName: string | EventFilter, ...args: any[]): boolean

  • Parameters

    • eventName: string | EventFilter
    • Rest ...args: any[]

    Returns boolean

fallback

  • fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

feeRecipient

  • feeRecipient(overrides?: CallOverrides): Promise<string>

getAmountToWrap

  • getAmountToWrap(_deposit: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

getFeeFromAmount

  • getFeeFromAmount(_amountToWrap: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>

getRoleAdmin

  • getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>

getRoleMember

  • getRoleMember(role: BytesLike, index: BigNumberish, overrides?: CallOverrides): Promise<string>

getRoleMemberCount

  • getRoleMemberCount(role: BytesLike, overrides?: CallOverrides): Promise<BigNumber>

grantRole

  • grantRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

hasRole

  • hasRole(role: BytesLike, account: string, overrides?: CallOverrides): Promise<boolean>

increaseAllowance

  • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

listenerCount

  • listenerCount(eventName?: string | EventFilter): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

listeners

  • listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
  • listeners(eventName?: string): Listener[]

mint

  • mint(to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

name

  • name(overrides?: CallOverrides): Promise<string>

off

  • off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): TokenWrapper
  • off(eventName: string, listener: Listener): TokenWrapper

on

  • on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): TokenWrapper
  • on(eventName: string, listener: Listener): TokenWrapper

once

  • once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): TokenWrapper
  • once(eventName: string, listener: Listener): TokenWrapper

pause

  • pause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

paused

  • paused(overrides?: CallOverrides): Promise<boolean>

queryFilter

  • queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • event: TypedEventFilter<EventArgsArray, EventArgsObject>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

removeAllListeners

  • removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): TokenWrapper
  • removeAllListeners(eventName?: string): TokenWrapper

removeListener

  • removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): TokenWrapper
  • removeListener(eventName: string, listener: Listener): TokenWrapper

renounceRole

  • renounceRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

revokeRole

  • revokeRole(role: BytesLike, account: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

setFee

  • setFee(_feePercentage: BigNumberish, _nonce: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

supportsInterface

  • supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>

symbol

  • symbol(overrides?: CallOverrides): Promise<string>

totalSupply

  • totalSupply(overrides?: CallOverrides): Promise<BigNumber>

transfer

  • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

transferFrom

  • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

unpause

  • unpause(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

unwrap

  • unwrap(tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

unwrapAndSendTo

  • unwrapAndSendTo(tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • tokenAddress: string
    • amount: BigNumberish
    • recipient: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

unwrapFor

  • unwrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • sender: string
    • tokenAddress: string
    • amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

wrap

  • wrap(tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

wrapFor

  • wrapFor(sender: string, tokenAddress: string, amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • sender: string
    • tokenAddress: string
    • amount: BigNumberish
    • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

wrapForAndSendTo

  • wrapForAndSendTo(sender: string, tokenAddress: string, amount: BigNumberish, recipient: string, overrides?: PayableOverrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • sender: string
    • tokenAddress: string
    • amount: BigNumberish
    • recipient: string
    • Optional overrides: PayableOverrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

Static getContractAddress

  • getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

  • Parameters

    • transaction: { from: string; nonce: BigNumberish }
      • from: string
      • nonce: BigNumberish

    Returns string

Static getInterface

  • getInterface(contractInterface: ContractInterface): Interface

  • Parameters

    • contractInterface: ContractInterface

    Returns Interface

Static isIndexed

  • isIndexed(value: any): value is Indexed

  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc