Class AllV8

constructor

• new AllV8(__namedParameters): AllV8

• Parameters

  • __namedParameters: {
        walletClient: {};
        address: `0x${string}`;
        publicClient?: {};
        buyoutWindows?: BuyoutWindows;
    }

    • walletClient: {}

    • address: `0x${string}`

    • Optional publicClient?: {}

    • Optional buyoutWindows?: BuyoutWindows

  Returns AllV8

hasAuction

• hasAuction(__namedParameters): Promise<boolean>

• Parameters

  • __namedParameters: {
        collectionContractAddress: `0x${string}`;
        tokenId: bigint;
    }

    • collectionContractAddress: `0x${string}`

    • tokenId: bigint

  Returns Promise<boolean>

getAuction

• getAuction(__namedParameters): Promise<{
      auction: {
          loanAddress: `0x${string}`;
          loanId: bigint;
          highestBid: bigint;
          triggerFee: bigint;
          minBid: bigint;
          highestBidder: `0x${string}`;
          duration: bigint;
          asset: `0x${string}`;
          startTime: bigint;
          originator: `0x${string}`;
          lastBidTime: bigint;
          loanHash: `0x${string}`;
          buyoutWindow: bigint;
      };
      collectionContractAddress: `0x${string}`;
      tokenId: bigint;
  }>

• Reads the auction's current struct from the chain, with the NFT it auctions (see readAuction), including the loanHash and buyoutWindow only its start event carries.

  Parameters

  • __namedParameters: {
        auction: AuctionIdentity;
    }

    • auction: AuctionIdentity

  Returns Promise<{
      auction: {
          loanAddress: `0x${string}`;
          loanId: bigint;
          highestBid: bigint;
          triggerFee: bigint;
          minBid: bigint;
          highestBidder: `0x${string}`;
          duration: bigint;
          asset: `0x${string}`;
          startTime: bigint;
          originator: `0x${string}`;
          lastBidTime: bigint;
          loanHash: `0x${string}`;
          buyoutWindow: bigint;
      };
      collectionContractAddress: `0x${string}`;
      tokenId: bigint;
  }>

placeBid

• placeBid(__namedParameters): Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          collection: `0x${string}`;
          tokenId: bigint;
          newBidder: `0x${string}`;
          bid: bigint;
          loanAddress: `0x${string}`;
          loanId: bigint;
      }>);
  }>

• Bids on the auction, rebuilding it from the chain when the caller's struct lacks the v3.2 fields or a bid placed since the caller read it makes the liquidator reject it.

  Parameters

  • __namedParameters: {
        collectionContractAddress: `0x${string}`;
        tokenId: bigint;
        bid: bigint;
        auction: Auction;
    }

    • collectionContractAddress: `0x${string}`

    • tokenId: bigint

    • bid: bigint

    • auction: Auction

  Returns Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          collection: `0x${string}`;
          tokenId: bigint;
          newBidder: `0x${string}`;
          bid: bigint;
          loanAddress: `0x${string}`;
          loanId: bigint;
      }>);
  }>

getRemainingLockupSeconds

• getRemainingLockupSeconds(__namedParameters): Promise<number>

• Seconds left before bids open, while the loan's main lender may still buy the other lenders out. v3.2 snapshots that window into each auction when it starts, and it is 0 when the main lender is a pool, so the liquidator's current setting does not apply. The window comes from the caller's struct when it has one, and from the chain once per auction otherwise.

  Parameters

  • __namedParameters: {
        auction: AuctionIdentity & Partial<Pick<{
            loanAddress: `0x${string}`;
            loanId: bigint;
            highestBid: bigint;
            triggerFee: bigint;
            minBid: bigint;
            highestBidder: `0x${string}`;
            duration: bigint;
            asset: `0x${string}`;
            startTime: bigint;
            originator: `0x${string}`;
            lastBidTime: bigint;
            loanHash: `0x${string}`;
            buyoutWindow: bigint;
        }, "buyoutWindow">>;
    }

    • auction: AuctionIdentity & Partial<Pick<{
          loanAddress: `0x${string}`;
          loanId: bigint;
          highestBid: bigint;
          triggerFee: bigint;
          minBid: bigint;
          highestBidder: `0x${string}`;
          duration: bigint;
          asset: `0x${string}`;
          startTime: bigint;
          originator: `0x${string}`;
          lastBidTime: bigint;
          loanHash: `0x${string}`;
          buyoutWindow: bigint;
      }, "buyoutWindow">>

  Returns Promise<number>

settleAuctionWithBuyout

• settleAuctionWithBuyout(__namedParameters): Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          loanAddress: `0x${string}`;
          loanId: bigint;
          nftAddress: `0x${string}`;
          tokenId: bigint;
          largestTrancheIdx: bigint;
      }>);
  }>

• Parameters

  • __namedParameters: {
        auction: Auction;
        loan: LoanV8;
    }

    • auction: Auction

    • loan: LoanV8

  Returns Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          loanAddress: `0x${string}`;
          loanId: bigint;
          nftAddress: `0x${string}`;
          tokenId: bigint;
          largestTrancheIdx: bigint;
      }>);
  }>

settleAuction

• settleAuction(__namedParameters): Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          loanContract: `0x${string}`;
          loanId: bigint;
          collection: `0x${string}`;
          tokenId: bigint;
          asset: `0x${string}`;
          proceeds: bigint;
          settler: `0x${string}`;
          triggerFee: bigint;
      }>);
  }>

• Parameters

  • __namedParameters: {
        auction: Auction;
        loan: LoanV8;
    }

    • auction: Auction

    • loan: LoanV8

  Returns Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          loanContract: `0x${string}`;
          loanId: bigint;
          collection: `0x${string}`;
          tokenId: bigint;
          asset: `0x${string}`;
          proceeds: bigint;
          settler: `0x${string}`;
          triggerFee: bigint;
      }>);
  }>

getPendingRefund

• getPendingRefund(__namedParameters): Promise<bigint>

• The bid refund in token that the liquidator holds for bidder because its transfer failed.

  Parameters

  • __namedParameters: {
        bidder: `0x${string}`;
        token: `0x${string}`;
    }

    • bidder: `0x${string}`

    • token: `0x${string}`

  Returns Promise<bigint>

claimRefund

• claimRefund(__namedParameters): Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          bidder: `0x${string}`;
          asset: `0x${string}`;
          amount: bigint;
      }>);
  }>

• Sends the wallet the bid refund in token the liquidator holds for it.

  Parameters

  • __namedParameters: {
        token: `0x${string}`;
    }

    • token: `0x${string}`

  Returns Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<{
          bidder: `0x${string}`;
          asset: `0x${string}`;
          amount: bigint;
      }>);
  }>

sendTransactionData

• sendTransactionData(data, value?): Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<TransactionReceipt>);
  }>

• Parameters

  • data: `0x${string}`

  • Optional value: bigint

  Returns Promise<{
      txHash: `0x${string}`;
      waitTxInBlock: (() => Promise<TransactionReceipt>);
  }>

abi