Function fund

  • Fund a lock with tokens from the sender account.

    Returns

    The hash of the submitted transaction.

    Throws

    If options.validate is true and the lock has expired.

    Throws

    If options.validate is true and the sender does not have the fund capability.

    Throws

    If options.validate is true and the token is not configured on the lock.

    Throws

    If options.validate is true and the sender does not have enough available balance of the token.

    Parameters

    • lock: Lock

      The lock to fund.

    • sender: AccountAddress

      The sender account that submits the transaction.

    • details: FundDetails

      The operation details excluding the lock id.

    • signer: AccountSigner

      The signer used to sign the transaction.

    • Optional metadata: LockUpdateMetadata

      Optional transaction metadata such as expiry and nonce.

    • options: LockOperationOptions = {}

      Optional validation behavior.

    Returns Promise<Type>

Settings

Member Visibility

Theme

Generated using TypeDoc