Function returnFunds

  • Return locked funds to their owner 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 return capability.

    Throws

    If options.validate is true and the source account does not have enough of the token locked in the lock.

    Parameters

    • lock: Lock

      The lock controlling the funds.

    • sender: AccountAddress

      The sender account that submits the transaction.

    • details: ReturnDetails

      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