Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AddressDriverTxFactory

A factory for creating AddressDriver contract transactions.

Hierarchy

  • AddressDriverTxFactory

Implements

  • IAddressDriverTxFactory

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private #driver

#driver: AddressDriver

Private #driverAddress

#driverAddress: string

Private #signer

#signer: Signer

Accessors

driverAddress

  • get driverAddress(): string

signer

  • get signer(): undefined | Signer

Methods

collect

  • collect(erc20: PromiseOrValue<string>, transferTo: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>

  • Parameters

    • erc20: PromiseOrValue<string>
    • transferTo: PromiseOrValue<string>
    • overrides: Overrides & { from?: PromiseOrValue<string> } = {}

    Returns Promise<PopulatedTransaction>

emitUserMetadata

  • emitUserMetadata(userMetadata: UserMetadataStruct[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>

  • Parameters

    • userMetadata: UserMetadataStruct[]
    • overrides: Overrides & { from?: PromiseOrValue<string> } = {}

    Returns Promise<PopulatedTransaction>

give

  • give(receiver: PromiseOrValue<BigNumberish>, erc20: PromiseOrValue<string>, amt: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>

  • Parameters

    • receiver: PromiseOrValue<BigNumberish>
    • erc20: PromiseOrValue<string>
    • amt: PromiseOrValue<BigNumberish>
    • overrides: Overrides & { from?: PromiseOrValue<string> } = {}

    Returns Promise<PopulatedTransaction>

setDrips

  • setDrips(erc20: PromiseOrValue<string>, currReceivers: DripsReceiverStruct[], balanceDelta: PromiseOrValue<BigNumberish>, newReceivers: DripsReceiverStruct[], maxEndHint1: PromiseOrValue<BigNumberish>, maxEndHint2: PromiseOrValue<BigNumberish>, transferTo: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>

  • Parameters

    • erc20: PromiseOrValue<string>
    • currReceivers: DripsReceiverStruct[]
    • balanceDelta: PromiseOrValue<BigNumberish>
    • newReceivers: DripsReceiverStruct[]
    • maxEndHint1: PromiseOrValue<BigNumberish>
    • maxEndHint2: PromiseOrValue<BigNumberish>
    • transferTo: PromiseOrValue<string>
    • overrides: Overrides & { from?: PromiseOrValue<string> } = {}

    Returns Promise<PopulatedTransaction>

setSplits

  • setSplits(receivers: SplitsReceiverStruct[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>

  • Parameters

    • receivers: SplitsReceiverStruct[]
    • overrides: Overrides & { from?: PromiseOrValue<string> } = {}

    Returns Promise<PopulatedTransaction>

Static create

  • Creates a new immutable AddressDriverTxFactory instance.

    throws

    {@link DripsErrors.initializationError} if the initialization fails.

    Parameters

    • signer: Signer

      The signer that will be used to sign the generated transactions.

      The singer must be connected to a provider.

      The supported networks are:

      • 'mainnet': chain ID 1
      • 'goerli': chain ID 5
      • 'polygon-mumbai': chain ID 80001
    • Optional customDriverAddress: string

      Overrides the AddressDriver contract address. If it's undefined (default value), the address will be automatically selected based on the signer.provider's network.

    Returns Promise<AddressDriverTxFactory>

    A Promise which resolves to the new client instance.

Generated using TypeDoc