Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Committer

Interface for interacting with the PoolComitter. Can be used standalone, but is always initialised within a Pool The constructor is private so must be instantiated with Committer.Create

Hierarchy

  • Committer

Index

Constructors

Properties

Constructors

Private constructor

  • Returns Committer

Properties

Optional _contract

_contract?: PoolCommitter

address

address: string

burningFee

burningFee: BigNumber

commit

commit: (type: CommitEnum, amount: number | BigNumber, payForClaim: boolean, fromAggregateBalances: boolean) => Promise<ContractTransaction> = ...

Type declaration

    • (type: CommitEnum, amount: number | BigNumber, payForClaim: boolean, fromAggregateBalances: boolean): Promise<ContractTransaction>

    • Submits a commit

      Parameters

      • type: CommitEnum

        1 of 4 commit types. These values are (0, 1, 2, 3) => (shortMint, shortBurn, longMint, longBurn)

      • amount: number | BigNumber

        either a number or BigNumber representing the amount of tokens

      • payForClaim: boolean
      • fromAggregateBalances: boolean

        is true when the user wants to pay from balances yet to be claimed, false if they want to use the balances within their wallet to be committed if burning, or the amount of quote token to use to mint new tokens

      Returns Promise<ContractTransaction>

connect

connect: (provider: Provider | Signer) => void = ...

Type declaration

    • (provider: Provider | Signer): void

    • Replaces the provider and connects the contract instance

      Parameters

      • provider: Provider | Signer

        The new provider to connect to

      Returns void

fetchAllShadowPools

fetchAllShadowPools: () => Promise<{ pendingLong: PendingAmounts; pendingShort: PendingAmounts }> = ...

Type declaration

    • Updates all shadow pool balances. Calls {@linkcode Committer.fetchShadowPool} for each of the commit types. As such this will also set the internal state of the Class

      Returns Promise<{ pendingLong: PendingAmounts; pendingShort: PendingAmounts }>

      all refetched shadow pool balances

Private init

init: (commitInfo: IPoolCommitter) => Promise<void> = ...

Type declaration

mintingFee

mintingFee: BigNumber

multicallProvider

multicallProvider: undefined | Signer | MulticallProvider

pendingLong

pendingLong: PendingAmounts

pendingShort

pendingShort: PendingAmounts

provider

provider: undefined | Provider | Signer

settlementTokenDecimals

settlementTokenDecimals: number

Static Create

Create: (committerInfo: IPoolCommitter) => Promise<Committer> = ...

Type declaration

Static CreateDefault

CreateDefault: () => Committer = ...

Type declaration

Generated using TypeDoc