Class Gondi

Hierarchy

  • Gondi

Constructors

constructor

Methods

create makeSingleNftOffer makeCollectionOffer makeOrder makeOrders makeDeal makeSellAndRepayOrder buyNowPayLater cancelOrder cancelOffer cancelOffers cancelAllOffers hideOffer hideOffers unhideOffer makeRefinanceOffer cancelRefinanceOffer hideRenegotiationOffer unhideRenegotiationOffer hideOrder showOrder cancelAllRenegotiations offerExecutionFromOffers emitLoan refinanceFromOffers efficientRefinanceFromOffers repayLoan offers loans list unlist listings nftId collections collectionId collectionStepsById ownedNfts getRemainingLockupSeconds isEndLockedUp refinanceFullLoan refinancePartialLoan addTranche delegateMulticall delegate revokeDelegate revokeDelegationsAndEmitLoan liquidateLoan placeBid settleAuction settleAuctionWithBuyout getAuctionRemainingLockupSeconds getOwner balanceOf isApprovedNFTForAll approveNFTForAll transferNFT isApprovedToken approveToken currencyAllowance currencyBalance createUserVault _createUserVault depositUserVaultERC721s depositUserVaultERC1155s depositUserVaultERC20 burnUserVaultAndWithdraw wrapOldERC721 unwrapOldERC721 buyWithSellAndRepay sellAndRepay sellNft getProtocolFee

Properties

calculateProratedOriginationFee buildSiweMessage contracts wallet account bcClient apiClient

Constructors

constructor

Methods

Static create

makeSingleNftOffer

  • Parameters

    Returns Promise<{
        aprBps: bigint;
        borrowerAddress: `0x${string}`;
        capacity: bigint;
        contractAddress: `0x${string}`;
        duration: bigint;
        expirationTime: bigint;
        fee: bigint;
        lenderAddress: `0x${string}`;
        lenderRefinanceDisabled?: boolean;
        maxSeniorRepayment?: InputMaybe<bigint>;
        maxTrancheFloor?: InputMaybe<bigint>;
        nftId: number;
        offerHash: `0x${string}`;
        offerId: bigint;
        offerValidators: OfferValidatorInput[];
        principalAddress: `0x${string}`;
        principalAmount: bigint;
        requiresLiquidation?: InputMaybe<boolean>;
        signature: `0x${string}`;
        signerAddress?: InputMaybe<`0x${string}`>;
        id: string;
        nftCollateralAddress: `0x${string}`;
        nftCollateralTokenId: bigint;
    }>

makeCollectionOffer

  • Parameters

    Returns Promise<{
        aprBps: bigint;
        borrowerAddress: `0x${string}`;
        capacity: bigint;
        collectionId: number;
        contractAddress: `0x${string}`;
        duration: bigint;
        expirationTime: bigint;
        fee: bigint;
        lenderAddress: `0x${string}`;
        lenderRefinanceDisabled?: boolean;
        maxSeniorRepayment?: InputMaybe<bigint>;
        maxTrancheFloor?: InputMaybe<bigint>;
        offerHash: `0x${string}`;
        offerId: bigint;
        offerValidators: OfferValidatorInput[];
        principalAddress: `0x${string}`;
        principalAmount: bigint;
        requiresLiquidation?: InputMaybe<boolean>;
        signature: `0x${string}`;
        signerAddress?: InputMaybe<`0x${string}`>;
        id: string;
        nftCollateralAddress: `0x${string}`;
        nftCollateralTokenId: bigint;
    }>

makeOrder

  • Parameters

    Returns Promise<{
        amount?: InputMaybe<bigint>;
        contractAddress: `0x${string}`;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        tokenId: bigint;
        __typename?: "MultipleTraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        collectionId: number;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        __typename?: "MultipleTraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        traitIds: number[];
        __typename?: "MultipleTraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        contractAddress: `0x${string}`;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        tokenId: bigint;
        __typename?: "TraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        collectionId: number;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        __typename?: "TraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        traitIds: number[];
        __typename?: "TraitOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        contractAddress: `0x${string}`;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        tokenId: bigint;
        __typename?: "SingleNFTOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        collectionId: number;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        __typename?: "SingleNFTOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        traitIds: number[];
        __typename?: "SingleNFTOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        contractAddress: `0x${string}`;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        tokenId: bigint;
        __typename?: "CollectionOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        collectionId: number;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        __typename?: "CollectionOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    } | {
        amount?: InputMaybe<bigint>;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        fees?: InputMaybe<OrderFee[]>;
        isAsk?: InputMaybe<boolean>;
        maxExecutions?: InputMaybe<bigint>;
        price?: InputMaybe<bigint>;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        traitIds: number[];
        __typename?: "CollectionOrder";
        id: string;
        status: string;
        marketPlaceAddress: `0x${string}`;
    }>

makeOrders

  • Parameters

    Returns Promise<{
        __typename?: "SingleNFTOrder";
        id: string;
        price: bigint;
        fees: bigint;
        currencyAddress: `0x${string}`;
        marketPlace: string;
        status: string;
        startTime: Date;
        expiration: Date;
        maker: `0x${string}`;
        isAsk: boolean;
        nonce: bigint;
        taker: `0x${string}`;
        signature: `0x${string}`;
        marketPlaceAddress: `0x${string}`;
        evmOrder?: null | object;
        nft: {
            __typename?: "NFT";
            id: string;
        };
    }[]>

makeDeal

  • Parameters

    Returns Promise<{
        blockchain: BlockchainEnum;
        counterOfferForId?: InputMaybe<number>;
        expiration: bigint;
        makerErc20s: `0x${string}`[];
        makerErc20sAmounts: bigint[];
        makerNfts: number[];
        makerNftsAmounts: bigint[];
        signature?: InputMaybe<`0x${string}`>;
        startTime: bigint;
        taker: `0x${string}`;
        takerErc20s: `0x${string}`[];
        takerErc20sAmounts: bigint[];
        takerNfts: number[];
        takerNftsAmounts: bigint[];
        __typename?: "Deal";
        id: string;
        status: string;
    }>

makeSellAndRepayOrder

  • Parameters

    Returns Promise<{
        amount?: InputMaybe<bigint>;
        contractAddress: `0x${string}`;
        criteriaProof?: InputMaybe<`0x${string}`[]>;
        currencyAddress: `0x${string}`;
        expirationTime: bigint;
        extraSeaportData?: InputMaybe<`0x${string}`>;
        fees?: InputMaybe<OrderFee[]>;
        isAsk: boolean;
        orderToFill?: InputMaybe<number>;
        orderToFillInt64?: any;
        price?: InputMaybe<bigint>;
        repaymentSignature?: InputMaybe<`0x${string}`>;
        replaceOrderId?: InputMaybe<number>;
        replaceOrderIdInt64?: any;
        signature: InputMaybe<`0x${string}`>;
        startTime: bigint;
        stealth?: InputMaybe<boolean>;
        taker?: InputMaybe<`0x${string}`>;
        tokenId: bigint;
        __typename?: "SellAndRepayOrder";
        id: string;
        status: string;
        repaymentCalldata: `0x${string}`;
        marketPlaceAddress: `0x${string}`;
    }>

buyNowPayLater

  • Parameters

    • __namedParameters: {
          amounts: bigint[];
          purchaseBundlerAddress?: `0x${string}`;
          contractAddress: `0x${string}`;
          loanDuration: bigint;
          offers: OfferFromExecutionOffer[];
          tokenId: bigint;
          repaymentCalldata?: null | `0x${string}`;
          sellAndRepaySwapData?: Maybe<`0x${string}`>;
          repayFlashLoanSwapParams?: Maybe<{
              inputCurrency: `0x${string}`;
              inputAmount: bigint;
              swapData: `0x${string}`;
          }>;
      }
      • amounts: bigint[]
      • Optional purchaseBundlerAddress?: `0x${string}`
      • contractAddress: `0x${string}`
      • loanDuration: bigint
      • offers: OfferFromExecutionOffer[]
      • tokenId: bigint
      • Optional repaymentCalldata?: null | `0x${string}`
      • Optional sellAndRepaySwapData?: Maybe<`0x${string}`>
      • Optional repayFlashLoanSwapParams?: Maybe<{
            inputCurrency: `0x${string}`;
            inputAmount: bigint;
            swapData: `0x${string}`;
        }>

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

cancelOrder

  • Parameters

    • order: {
          cancelCalldata: `0x${string}`;
          marketPlaceAddress: `0x${string}`;
      }
      • cancelCalldata: `0x${string}`
      • marketPlaceAddress: `0x${string}`

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

cancelOffer

  • Parameters

    • __namedParameters: {
          id: bigint;
          contractAddress: `0x${string}`;
      }
      • id: bigint
      • contractAddress: `0x${string}`

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            lender: `0x${string}`;
            offerId: bigint;
        } | {
            lender: `0x${string}`;
            offerId: bigint;
        } | {
            lender: `0x${string}`;
            offerId: bigint;
        }>);
    }>

cancelOffers

  • Parameters

    • __namedParameters: {
          ids: bigint[];
          contractAddress: `0x${string}`;
      }
      • ids: bigint[]
      • contractAddress: `0x${string}`

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            events: ({
                lender: `0x${string}`;
                offerId: bigint;
            } | {
                lender: `0x${string}`;
                offerId: bigint;
            } | {
                lender: `0x${string}`;
                offerId: bigint;
            })[];
        }>);
    }>

cancelAllOffers

  • Parameters

    • __namedParameters: {
          minId: bigint;
          contractAddress: `0x${string}`;
      }
      • minId: bigint
      • contractAddress: `0x${string}`

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

hideOffer

  • Parameters

    • __namedParameters: {
          id: bigint;
          contractAddress: `0x${string}`;
      }
      • id: bigint
      • contractAddress: `0x${string}`

    Returns Promise<HideOfferMutation>

hideOffers

  • Parameters

    • __namedParameters: {
          ids: bigint[];
          contractAddress: `0x${string}`;
      }
      • ids: bigint[]
      • contractAddress: `0x${string}`

    Returns Promise<HideOffersMutation>

unhideOffer

makeRefinanceOffer

  • Parameters

    Returns Promise<{
        id: string;
        loanId: string;
        duration: bigint;
        principalAmount: bigint;
        aprBps: bigint;
        renegotiationId: bigint;
        expirationTime: bigint;
        targetPrincipal?: InputMaybe<bigint[]>;
        requiresLiquidation?: InputMaybe<boolean>;
        strictImprovement?: InputMaybe<boolean>;
        trancheIndex?: InputMaybe<bigint[]>;
        lenderAddress: `0x${string}`;
        signerAddress?: InputMaybe<`0x${string}`>;
        offerHash: `0x${string}`;
        feeAmount: bigint;
        isAddNewTranche?: InputMaybe<boolean>;
        signature: `0x${string}`;
    } | {
        offerHash: `0x${string}`;
        signature: `0x${string}`;
        renegotiationId: bigint;
        targetPrincipal: bigint[];
        trancheIndex: bigint[];
        lenderAddress: `0x${string}`;
        signerAddress: InputMaybe<`0x${string}`>;
        loanId: string;
        duration: bigint;
        principalAmount: bigint;
        aprBps: bigint;
        expirationTime: bigint;
        requiresLiquidation?: InputMaybe<boolean>;
        strictImprovement?: InputMaybe<boolean>;
        feeAmount: bigint;
        isAddNewTranche?: InputMaybe<boolean>;
    }>

cancelRefinanceOffer

  • Parameters

    • __namedParameters: {
          id: bigint;
          contractAddress: `0x${string}`;
      }
      • id: bigint
      • contractAddress: `0x${string}`

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            lender: `0x${string}`;
            renegotiationId: bigint;
        } | {
            lender: `0x${string}`;
            renegotiationId: bigint;
        } | {
            lender: `0x${string}`;
            renegotiationId: bigint;
        }>);
    }>

hideRenegotiationOffer

unhideRenegotiationOffer

hideOrder

  • Hides a bid. isAsk is required so a listing is rejected here rather than by the API, which refuses it either way.

    Parameters

    • __namedParameters: {
          id: number;
          isAsk: boolean;
      }
      • id: number
      • isAsk: boolean

    Returns Promise<HideOrderMutation>

    Deprecated

    Listings can no longer be hidden — cancel one on-chain instead. Still hides bids.

showOrder

  • Unhides a bid. isAsk is required so a listing is rejected here rather than by the API, which refuses it either way.

    Parameters

    • __namedParameters: {
          id: number;
          isAsk: boolean;
      }
      • id: number
      • isAsk: boolean

    Returns Promise<ShowOrderMutation>

    Deprecated

    Listings can no longer be hidden — a listing hidden before that change stays hidden and is cancelled on-chain. Still unhides bids.

cancelAllRenegotiations

  • Parameters

    • __namedParameters: {
          minId: bigint;
          contractAddress: `0x${string}`;
      }
      • minId: bigint
      • contractAddress: `0x${string}`

    Returns Promise<void | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            lender: `0x${string}`;
            minRenegotiationId: bigint;
        }>);
    }>

offerExecutionFromOffers

emitLoan

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
            offerIds: string[];
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                source: readonly {
                    loanId: bigint;
                    lender: `0x${string}`;
                    principalAmount: bigint;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                id: string;
            };
            loanId: bigint;
            offerId: string;
        }>);
    }>

refinanceFromOffers

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
            offerIds: string[];
        }>);
    }>

efficientRefinanceFromOffers

  • Parameters

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

repayLoan

  • Parameters

    • __namedParameters: {
          loan: LoanToMslLoanType;
          loanId: bigint;
          nftReceiver?: `0x${string}`;
      }

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loanId: bigint;
            totalRepayment: bigint;
            fee: bigint;
        } | {
            loanId: bigint;
            totalRepayment: bigint;
            fee: bigint;
        } | {
            loanId: bigint;
            totalRepayment: bigint;
            fee: bigint;
        }>);
    }>

offers

  • Parameters

    Returns Promise<{
        offers: ({
            type: undefined | "CollectionOffer" | "SingleNFTOffer";
            lender: undefined | null | `0x${string}`;
            borrower: undefined | null | `0x${string}`;
            signer: undefined | null | `0x${string}`;
            offerValidators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[] | {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
            nftCollateralAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            id: string;
            offerId: bigint;
            lenderAddress?: null | `0x${string}`;
            borrowerAddress?: null | `0x${string}`;
            signerAddress?: null | `0x${string}`;
            contractAddress: `0x${string}`;
            requiresLiquidation?: null | boolean;
            principalAddress: `0x${string}`;
            principalAmount: bigint;
            aprBps: bigint;
            fee: bigint;
            capacity: bigint;
            expirationTime: bigint;
            duration: bigint;
            status: string;
            offerHash?: null | `0x${string}`;
            signature?: null | `0x${string}`;
            createdDate?: null | Date;
            repayment: bigint;
            hidden?: null | boolean;
            maxSeniorRepayment: bigint;
            lenderRefinanceDisabled: boolean;
            collection: {
                __typename?: "Collection";
                id: string;
                slug: string;
                contractData: {
                    __typename?: "ContractData";
                    contractAddress: `0x${string}`;
                };
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            validators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
        } | {
            type: undefined | "CollectionOffer" | "SingleNFTOffer";
            lender: undefined | null | `0x${string}`;
            borrower: undefined | null | `0x${string}`;
            signer: undefined | null | `0x${string}`;
            offerValidators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[] | {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
            nftCollateralAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            id: string;
            offerId: bigint;
            lenderAddress?: null | `0x${string}`;
            borrowerAddress?: null | `0x${string}`;
            signerAddress?: null | `0x${string}`;
            contractAddress: `0x${string}`;
            requiresLiquidation?: null | boolean;
            principalAddress: `0x${string}`;
            principalAmount: bigint;
            aprBps: bigint;
            fee: bigint;
            capacity: bigint;
            expirationTime: bigint;
            duration: bigint;
            status: string;
            offerHash?: null | `0x${string}`;
            signature?: null | `0x${string}`;
            createdDate?: null | Date;
            repayment: bigint;
            hidden?: null | boolean;
            maxSeniorRepayment: bigint;
            lenderRefinanceDisabled: boolean;
            nft: {
                __typename?: "NFT";
                id: string;
                tokenId: bigint;
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            validators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
        })[];
        hasNextPage: true;
        cursor: string;
    } | {
        offers: ({
            type: undefined | "CollectionOffer" | "SingleNFTOffer";
            lender: undefined | null | `0x${string}`;
            borrower: undefined | null | `0x${string}`;
            signer: undefined | null | `0x${string}`;
            offerValidators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[] | {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
            nftCollateralAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            id: string;
            offerId: bigint;
            lenderAddress?: null | `0x${string}`;
            borrowerAddress?: null | `0x${string}`;
            signerAddress?: null | `0x${string}`;
            contractAddress: `0x${string}`;
            requiresLiquidation?: null | boolean;
            principalAddress: `0x${string}`;
            principalAmount: bigint;
            aprBps: bigint;
            fee: bigint;
            capacity: bigint;
            expirationTime: bigint;
            duration: bigint;
            status: string;
            offerHash?: null | `0x${string}`;
            signature?: null | `0x${string}`;
            createdDate?: null | Date;
            repayment: bigint;
            hidden?: null | boolean;
            maxSeniorRepayment: bigint;
            lenderRefinanceDisabled: boolean;
            collection: {
                __typename?: "Collection";
                id: string;
                slug: string;
                contractData: {
                    __typename?: "ContractData";
                    contractAddress: `0x${string}`;
                };
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            validators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
        } | {
            type: undefined | "CollectionOffer" | "SingleNFTOffer";
            lender: undefined | null | `0x${string}`;
            borrower: undefined | null | `0x${string}`;
            signer: undefined | null | `0x${string}`;
            offerValidators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[] | {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
            nftCollateralAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            id: string;
            offerId: bigint;
            lenderAddress?: null | `0x${string}`;
            borrowerAddress?: null | `0x${string}`;
            signerAddress?: null | `0x${string}`;
            contractAddress: `0x${string}`;
            requiresLiquidation?: null | boolean;
            principalAddress: `0x${string}`;
            principalAmount: bigint;
            aprBps: bigint;
            fee: bigint;
            capacity: bigint;
            expirationTime: bigint;
            duration: bigint;
            status: string;
            offerHash?: null | `0x${string}`;
            signature?: null | `0x${string}`;
            createdDate?: null | Date;
            repayment: bigint;
            hidden?: null | boolean;
            maxSeniorRepayment: bigint;
            lenderRefinanceDisabled: boolean;
            nft: {
                __typename?: "NFT";
                id: string;
                tokenId: bigint;
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            validators: {
                __typename?: "OfferValidator";
                arguments: `0x${string}`;
                validator: `0x${string}`;
            }[];
        })[];
        hasNextPage: false;
        cursor: null;
    }>

loans

  • Parameters

    Returns Promise<{
        loans: {
            type: undefined | "MultiSourceLoan";
            contractAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            nftCollateralAddress: undefined | `0x${string}`;
            borrower: `0x${string}`;
            startTime: bigint;
            source: {
                lender: `0x${string}`;
                loanId: bigint;
                startTime: bigint;
                __typename?: "Source";
                id: string;
                originationFee: bigint;
                principalAmount: bigint;
                lenderAddress: string;
                accruedInterest: bigint;
                aprBps: bigint;
            }[];
            id: string;
            address: `0x${string}`;
            loanId: number;
            timestamp: Date;
            txHash: `0x${string}`;
            indexInBlock: number;
            borrowerAddress: `0x${string}`;
            principalAddress: `0x${string}`;
            duration: bigint;
            status: string;
            principalAmount: bigint;
            blendedAprBps: number;
            totalOriginationFee: bigint;
            protocolFee: bigint;
            lenderRefinanceDisabled: boolean;
            offer: {
                __typename?: "CollectionOffer";
                offerId: bigint;
                signerAddress?: null | `0x${string}`;
            } | {
                __typename?: "SingleNFTOffer";
                offerId: bigint;
                signerAddress?: null | `0x${string}`;
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            repaidActivity?: null | {
                __typename?: "LoanRepaid";
                totalInterest: bigint;
                timestamp: Date;
            };
            nft: {
                __typename?: "NFT";
                id: string;
                name?: null | string;
                tokenId: bigint;
                nftId: string;
                owner?: null | `0x${string}`;
                image?: null | {
                    __typename?: "Asset";
                    data: string;
                    cacheUrl?: null | string;
                    contentTypeMime: string;
                    accessTypeName: string;
                };
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    name?: null | string;
                    nftsCount?: null | number;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
            sources: {
                __typename?: "Source";
                id: string;
                loanId: string;
                originationFee: bigint;
                principalAmount: bigint;
                lenderAddress: string;
                accruedInterest: bigint;
                aprBps: bigint;
                startTime: Date;
            }[];
        }[];
        hasNextPage: true;
        cursor: string;
    } | {
        loans: {
            type: undefined | "MultiSourceLoan";
            contractAddress: `0x${string}`;
            nftCollateralTokenId: bigint;
            nftCollateralAddress: undefined | `0x${string}`;
            borrower: `0x${string}`;
            startTime: bigint;
            source: {
                lender: `0x${string}`;
                loanId: bigint;
                startTime: bigint;
                __typename?: "Source";
                id: string;
                originationFee: bigint;
                principalAmount: bigint;
                lenderAddress: string;
                accruedInterest: bigint;
                aprBps: bigint;
            }[];
            id: string;
            address: `0x${string}`;
            loanId: number;
            timestamp: Date;
            txHash: `0x${string}`;
            indexInBlock: number;
            borrowerAddress: `0x${string}`;
            principalAddress: `0x${string}`;
            duration: bigint;
            status: string;
            principalAmount: bigint;
            blendedAprBps: number;
            totalOriginationFee: bigint;
            protocolFee: bigint;
            lenderRefinanceDisabled: boolean;
            offer: {
                __typename?: "CollectionOffer";
                offerId: bigint;
                signerAddress?: null | `0x${string}`;
            } | {
                __typename?: "SingleNFTOffer";
                offerId: bigint;
                signerAddress?: null | `0x${string}`;
            };
            currency: {
                __typename?: "Currency";
                symbol: string;
                decimals: number;
                address: `0x${string}`;
            };
            repaidActivity?: null | {
                __typename?: "LoanRepaid";
                totalInterest: bigint;
                timestamp: Date;
            };
            nft: {
                __typename?: "NFT";
                id: string;
                name?: null | string;
                tokenId: bigint;
                nftId: string;
                owner?: null | `0x${string}`;
                image?: null | {
                    __typename?: "Asset";
                    data: string;
                    cacheUrl?: null | string;
                    contentTypeMime: string;
                    accessTypeName: string;
                };
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    name?: null | string;
                    nftsCount?: null | number;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
            sources: {
                __typename?: "Source";
                id: string;
                loanId: string;
                originationFee: bigint;
                principalAmount: bigint;
                lenderAddress: string;
                accruedInterest: bigint;
                aprBps: bigint;
                startTime: Date;
            }[];
        }[];
        hasNextPage: false;
        cursor: null;
    }>

list

unlist

listings

  • Parameters

    Returns Promise<{
        listings: {
            __typename?: "Listing";
            id: string;
            marketplaceName: MarketplaceEnum;
            createdDate: Date;
            desiredDuration?: null | number;
            desiredPrincipalAddress?: null | `0x${string}`;
            user: {
                __typename?: "User";
                walletAddress: `0x${string}`;
            };
            nft: {
                __typename?: "NFT";
                id: string;
                tokenId: bigint;
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
        }[];
        hasNextPage: true;
        cursor: string;
    } | {
        listings: {
            __typename?: "Listing";
            id: string;
            marketplaceName: MarketplaceEnum;
            createdDate: Date;
            desiredDuration?: null | number;
            desiredPrincipalAddress?: null | `0x${string}`;
            user: {
                __typename?: "User";
                walletAddress: `0x${string}`;
            };
            nft: {
                __typename?: "NFT";
                id: string;
                tokenId: bigint;
                collection?: null | {
                    __typename?: "Collection";
                    id: string;
                    slug: string;
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                };
            };
        }[];
        hasNextPage: false;
        cursor: null;
    }>

nftId

  • Parameters

    • props: Object

    Returns Promise<number>

collections

  • Parameters

    • props: {
          statsCurrency?: `0x${string}`;
          standards?: TokenStandardType[];
          collections?: number[];
          cursor?: string;
      }
      • Optional statsCurrency?: `0x${string}`
      • Optional standards?: TokenStandardType[]
      • Optional collections?: number[]
      • Optional cursor?: string

    Returns Promise<{
        collections: {
            __typename?: "Collection";
            id: string;
            name?: null | string;
            slug: string;
            description?: null | string;
            discordUrl?: null | string;
            twitterUsername?: null | string;
            externalUrl?: null | string;
            collectionUrl?: null | string;
            verified: boolean;
            wrapperCollections: {
                __typename?: "Collection";
                contractData: {
                    __typename?: "ContractData";
                    contractAddress: `0x${string}`;
                };
            }[];
            image?: null | {
                __typename?: "Asset";
                cacheUrl?: null | string;
            };
            bannerImage?: null | {
                __typename?: "Asset";
                cacheUrl?: null | string;
            };
            contractData: {
                __typename?: "ContractData";
                blockchain: string;
                contractAddress: `0x${string}`;
                createdDate: Date;
                creatorAddress?: null | `0x${string}`;
            };
            statistics: {
                __typename?: "CollectionStatistics";
                floorPrice7d?: null | number;
                floorPrice30d?: null | number;
                totalVolume?: null | number;
                totalVolume1y?: null | number;
                totalVolume3m?: null | number;
                totalVolume1m?: null | number;
                totalVolume1w?: null | number;
                totalLoanVolume: bigint;
                totalLoanVolume1w: bigint;
                totalLoanVolume1m: bigint;
                totalLoanVolume3m: bigint;
                totalLoanVolume1y: bigint;
                numberOfPricedNfts: number;
                nftsCount?: null | number;
                percentageInOutstandingLoans: number;
                repaymentRate: number;
                numberOfOffers: number;
                floorPrice?: null | {
                    __typename?: "CurrencyAmount";
                    amount: number;
                    currency: {
                        __typename?: "Currency";
                        address: `0x${string}`;
                        decimals: number;
                    };
                };
                bestOffer?: null | {
                    __typename?: "CurrencyAmount";
                    amount: number;
                    currency: {
                        __typename?: "Currency";
                        address: `0x${string}`;
                        decimals: number;
                    };
                };
            };
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: null | string;
            hasNextPage: boolean;
        };
    }>

collectionId

  • Parameters

    • props: {
          slug: string;
          contractAddress?: undefined;
      }
      • slug: string
      • Optional contractAddress?: undefined

    Returns Promise<number>

  • Parameters

    • props: {
          slug?: undefined;
          contractAddress: `0x${string}`;
      }
      • Optional slug?: undefined
      • contractAddress: `0x${string}`

    Returns Promise<number[]>

collectionStepsById

  • Parameters

    • props: {
          collectionId: number;
      }
      • collectionId: number

    Returns Promise<{
        __typename?: "OfferSteps";
        aprBpsStep: bigint;
        origFeeBpsStep: bigint;
        usdcStep: bigint;
        wethStep: bigint;
    }>

ownedNfts

  • Parameters

    Returns Promise<{
        ownedNfts: {
            __typename?: "NFT";
            id: string;
            tokenId: bigint;
            collection?: null | {
                __typename?: "Collection";
                id: string;
                contractData: {
                    __typename?: "ContractData";
                    contractAddress: `0x${string}`;
                };
                wrapperCollections: {
                    __typename?: "Collection";
                    contractData: {
                        __typename?: "ContractData";
                        contractAddress: `0x${string}`;
                    };
                }[];
            };
            activeLoan?: null | {
                __typename?: "MultiSourceLoan";
                id: string;
            };
            statistics: {
                __typename?: "NftStatistics";
                lastSale?: null | {
                    __typename?: "Sale";
                    order?: null | {
                        __typename?: "BuyNowPayLaterOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "CollectionOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "MultipleTraitOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "SellAndRepayOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "SingleNFTOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "StealthMaskedOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    } | {
                        __typename?: "TraitOrder";
                        price: bigint;
                        currency: {
                            __typename?: "Currency";
                            address: `0x${string}`;
                            decimals: number;
                        };
                    };
                };
                topTraitFloorPrice?: null | {
                    __typename?: "CurrencyAmount";
                    amount: number;
                    currency: {
                        __typename?: "Currency";
                        address: `0x${string}`;
                        decimals: number;
                    };
                };
            };
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: null | string;
            hasNextPage: boolean;
        };
    }>

getRemainingLockupSeconds

isEndLockedUp

  • Parameters

    • __namedParameters: {
          loan: Object;
      }
      • loan: Object

    Returns Promise<boolean>

refinanceFullLoan

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
            renegotiationId: string;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                source: readonly {
                    loanId: bigint;
                    lender: `0x${string}`;
                    principalAmount: bigint;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                id: string;
            };
            loanId: bigint;
            renegotiationId: string;
        }>);
    }>

refinancePartialLoan

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
            renegotiationId: string;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                source: readonly {
                    loanId: bigint;
                    lender: `0x${string}`;
                    principalAmount: bigint;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                id: string;
            };
            loanId: bigint;
            renegotiationId: string;
        }>);
    }>

addTranche

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
            renegotiationId: string;
        }>);
    }>

delegateMulticall

  • Delegate Multicall should be used when token is used as collateral for an active loan. Multicall will be performed to the contract address of the first delegation.

    Parameters

    • delegations: {
          loan: LoanToMslLoanType;
          loanId: bigint;
          to: `0x${string}`;
          enable: boolean;
          rights?: `0x${string}`;
      }[]

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            results: {
                loanId: bigint;
                delegate: `0x${string}`;
                value: boolean;
            }[];
        }>);
    }>

delegate

  • Delegate should be used when token is used as collateral for an active loan.

    Parameters

    • __namedParameters: {
          loan: LoanToMslLoanType;
          loanId: bigint;
          to: `0x${string}`;
          enable: boolean;
          rights?: `0x${string}`;
      }
      • loan: LoanToMslLoanType
      • loanId: bigint
      • to: `0x${string}`
      • enable: boolean
      • Optional rights?: `0x${string}`

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                loanId: bigint;
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint | bigint & Date;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                contractStartTime: bigint | Date;
            };
            value: boolean;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loan: {
                loanId: bigint;
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint | bigint & Date;
                duration: bigint;
                source: readonly {
                    loanId: bigint;
                    lender: `0x${string}`;
                    principalAmount: bigint;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
            };
            value: boolean;
        }>);
    }>

revokeDelegate

  • RevokeDelegate should be used when token is not being used as collateral.

    Parameters

    • __namedParameters: {
          to: `0x${string}`;
          collection: `0x${string}`;
          tokenId: bigint;
          contract?: `0x${string}`;
      }
      • to: `0x${string}`
      • collection: `0x${string}`
      • tokenId: bigint
      • Optional contract?: `0x${string}`

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

revokeDelegationsAndEmitLoan

  • RevokeDelegationsAndEmitLoan should be used when token has been delegated without being revoked, and a new loan wants to be emitted, erasing the delegations provided as argument.

    Parameters

    • __namedParameters: {
          delegations: `0x${string}`[];
          emit: EmitLoanArgs;
      }

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            results: ({
                loanId: bigint;
                offerId: readonly bigint[];
                loan: {
                    borrower: `0x${string}`;
                    nftCollateralTokenId: bigint;
                    nftCollateralAddress: `0x${string}`;
                    principalAddress: `0x${string}`;
                    principalAmount: bigint;
                    startTime: bigint;
                    duration: bigint;
                    tranche: readonly ({ loanId: bigint; floor: bigint; principalAmount: bigint; lender: `0x${string}`; accruedInterest: bigint; startTime: bigint; aprBps: bigint; })[];
                    protocolFee: bigint;
                };
                fee: bigint;
            } | {
                delegate: `0x${string}`;
                collection: `0x${string}`;
                tokenId: bigint;
                _rights: `0x${string}`;
            })[];
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                id: string;
            } | {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                tranche: readonly {
                    loanId: bigint;
                    floor: bigint;
                    principalAmount: bigint;
                    lender: `0x${string}`;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                protocolFee: bigint;
                lenderRefinanceDisabled: boolean;
                id: string;
            };
            loanId: bigint;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            results: ({
                loanId: bigint;
                offerId: bigint;
                loan: {
                    borrower: `0x${string}`;
                    nftCollateralTokenId: bigint;
                    nftCollateralAddress: `0x${string}`;
                    principalAddress: `0x${string}`;
                    principalAmount: bigint;
                    startTime: bigint;
                    duration: bigint;
                    source: readonly ({ loanId: bigint; lender: `0x${string}`; principalAmount: bigint; accruedInterest: bigint; startTime: bigint; aprBps: bigint; })[];
                };
                lender: `0x${string}`;
                borrower: `0x${string}`;
                fee: bigint;
            } | {
                delegate: `0x${string}`;
                collection: `0x${string}`;
                tokenId: bigint;
            })[];
            loan: {
                contractAddress: `0x${string}`;
                borrower: `0x${string}`;
                nftCollateralTokenId: bigint;
                nftCollateralAddress: `0x${string}`;
                principalAddress: `0x${string}`;
                principalAmount: bigint;
                startTime: bigint;
                duration: bigint;
                source: readonly {
                    loanId: bigint;
                    lender: `0x${string}`;
                    principalAmount: bigint;
                    accruedInterest: bigint;
                    startTime: bigint;
                    aprBps: bigint;
                }[];
                id: string;
            };
            loanId: bigint;
        }>);
    }>

liquidateLoan

  • Parameters

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

placeBid

  • 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<{
            auctionContract: `0x${string}`;
            tokenId: bigint;
            newBidder: `0x${string}`;
            bid: bigint;
            loanAddress: `0x${string}`;
            loanId: bigint;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            collection: `0x${string}`;
            tokenId: bigint;
            newBidder: `0x${string}`;
            bid: bigint;
            loanAddress: `0x${string}`;
            loanId: bigint;
        }>);
    }>

settleAuction

  • Parameters

    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;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loanContract: `0x${string}`;
            loanId: bigint;
            auctionContract: `0x${string}`;
            tokenId: bigint;
            asset: `0x${string}`;
            proceeds: bigint;
            settler: `0x${string}`;
            triggerFee: bigint;
        }>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            loanContract: `0x${string}`;
            loanId: bigint;
            auctionContract: `0x${string}`;
            tokenId: bigint;
            asset: `0x${string}`;
            highestBid: bigint;
            settler: `0x${string}`;
            triggerFee: bigint;
        }>);
    }>

settleAuctionWithBuyout

  • Parameters

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

getAuctionRemainingLockupSeconds

  • Parameters

    • __namedParameters: {
          auction: Pick<Auction, "loanAddress" | "startTime">;
      }
      • auction: Pick<Auction, "loanAddress" | "startTime">

    Returns Promise<number>

getOwner

  • Get the owner of an ERC 721 token.

    Parameters

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

    Returns Promise<`0x${string}`>

balanceOf

  • Get the balance of an ERC 1155 token id.

    Parameters

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

    Returns Promise<bigint>

isApprovedNFTForAll

  • Parameters

    • __namedParameters: {
          nftAddress: `0x${string}`;
          standard: NftStandard;
          to?: `0x${string}`;
      }
      • nftAddress: `0x${string}`
      • standard: NftStandard
      • Optional to?: `0x${string}`

    Returns Promise<boolean>

approveNFTForAll

  • Parameters

    • __namedParameters: {
          nftAddress: `0x${string}`;
          standard: NftStandard;
          to?: `0x${string}`;
      }
      • nftAddress: `0x${string}`
      • standard: NftStandard
      • Optional to?: `0x${string}`

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            owner: `0x${string}`;
            operator: `0x${string}`;
            approved: boolean;
        } | {
            owner: `0x${string}`;
            operator: `0x${string}`;
            approved: boolean;
        }>);
    }>

transferNFT

  • Transfer an NFT to another wallet. The sender is the connected wallet account. Supports ERC721 (default), ERC1155, naked CryptoPunks and old (pre-ERC721) collections. amount only applies to ERC1155 transfers.

    Parameters

    • __namedParameters: {
          to: `0x${string}`;
          nftAddress: `0x${string}`;
          tokenId: bigint;
          standard?: TransferNftStandard;
          amount?: bigint;
      }
      • to: `0x${string}`
      • nftAddress: `0x${string}`
      • tokenId: bigint
      • Optional standard?: TransferNftStandard
      • Optional amount?: bigint

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            from: `0x${string}`;
            to: `0x${string}`;
            punkIndex: bigint;
        } & TransactionReceipt>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            _from: `0x${string}`;
            _to: `0x${string}`;
            _tokenId: bigint;
        } & TransactionReceipt>);
    } | {
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            from: `0x${string}`;
            to: `0x${string}`;
            id: bigint;
        } & TransactionReceipt>);
    }>

isApprovedToken

  • Parameters

    • __namedParameters: {
          tokenAddress: `0x${string}`;
          amount: bigint;
          to?: `0x${string}`;
      }
      • tokenAddress: `0x${string}`
      • amount: bigint
      • Optional to?: `0x${string}`

    Returns Promise<boolean>

approveToken

  • Parameters

    • __namedParameters: {
          tokenAddress: `0x${string}`;
          amount?: bigint;
          to?: `0x${string}`;
      }
      • tokenAddress: `0x${string}`
      • Optional amount?: bigint
      • Optional to?: `0x${string}`

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

currencyAllowance

  • Parameters

    • __namedParameters: {
          tokenAddress: `0x${string}`;
          to?: `0x${string}`;
      }
      • tokenAddress: `0x${string}`
      • Optional to?: `0x${string}`

    Returns Promise<bigint>

currencyBalance

  • Parameters

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

    Returns Promise<bigint>

createUserVault

  • Parameters

    Returns Promise<{
        vaultId: bigint;
        receipts: ({
            vaultId: bigint;
            collection: `0x${string}`;
            tokenId: bigint;
        } | {
            vaultId: bigint;
            token: `0x${string}`;
            amount: bigint;
        })[];
    }>

_createUserVault

  • _createUserVault(__namedParameters): Promise<{
        vaultId: bigint;
        receipts: ({
            vaultId: bigint;
            collection: `0x${string}`;
            tokenId: bigint;
        } | {
            vaultId: bigint;
            token: `0x${string}`;
            amount: bigint;
        })[];
    }>

  • Parameters

    Returns Promise<{
        vaultId: bigint;
        receipts: ({
            vaultId: bigint;
            collection: `0x${string}`;
            tokenId: bigint;
        } | {
            vaultId: bigint;
            token: `0x${string}`;
            amount: bigint;
        })[];
    }>

depositUserVaultERC721s

  • Parameters

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

depositUserVaultERC1155s

  • Parameters

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

depositUserVaultERC20

  • Parameters

    • __namedParameters: {
          userVaultAddress?: `0x${string}`;
      } & DepositERC20Args

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

burnUserVaultAndWithdraw

  • Parameters

    Returns Promise<{
        txHash: `0x${string}`;
        waitTxInBlock: (() => Promise<{
            events: {
                vaultId: bigint;
                collection: `0x${string}`;
                tokenId: bigint;
            }[];
            oldEvents: {
                vaultId: bigint;
                collection: `0x${string}`;
                tokenId: bigint;
            }[];
        }>);
    }>

wrapOldERC721

  • Parameters

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

unwrapOldERC721

  • Parameters

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

buyWithSellAndRepay

  • Parameters

    • __namedParameters: {
          repaymentCalldata: `0x${string}`;
          purchaseBundlerAddress?: `0x${string}`;
          mslContractAddress: `0x${string}`;
          price: bigint;
          swapData?: Maybe<`0x${string}`>;
      }
      • repaymentCalldata: `0x${string}`
      • Optional purchaseBundlerAddress?: `0x${string}`
      • mslContractAddress: `0x${string}`
      • price: bigint
      • Optional swapData?: Maybe<`0x${string}`>

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

sellAndRepay

  • Parameters

    • __namedParameters: {
          purchaseBundlerAddress?: `0x${string}`;
          mslContractAddress: `0x${string}`;
          repaymentCalldata: `0x${string}`;
          swapData?: `0x${string}`;
      }
      • Optional purchaseBundlerAddress?: `0x${string}`
      • mslContractAddress: `0x${string}`
      • repaymentCalldata: `0x${string}`
      • Optional swapData?: `0x${string}`

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

sellNft

  • Sells nft into order, a Native or OpenSea bid. The Gondi API builds the sale calldata for both marketplaces, so OpenSea bids need no client-side OpenSea credentials and no approval beyond the collateral's.

    Parameters

    • __namedParameters: {
          order: {
              id: string;
              currencyAddress: `0x${string}`;
              originalId: string;
              marketPlace: string;
              marketPlaceAddress: `0x${string}`;
              price: bigint;
          };
          nft: {
              id: string;
              tokenId: bigint;
              collectionAddress: `0x${string}`;
          };
      }
      • order: {
            id: string;
            currencyAddress: `0x${string}`;
            originalId: string;
            marketPlace: string;
            marketPlaceAddress: `0x${string}`;
            price: bigint;
        }
        • id: string
        • currencyAddress: `0x${string}`

          The order's currency as reported by the Gondi API. A native-currency order carries the zero address on Ethereum, but a synthetic sentinel on other chains (__HYPE_ADDRESS on HyperEVM, __RETH_ADDRESS on Robinhood) — check it with isNativeCurrency.

        • originalId: string
        • marketPlace: string
        • marketPlaceAddress: `0x${string}`
        • price: bigint
      • nft: {
            id: string;
            tokenId: bigint;
            collectionAddress: `0x${string}`;
        }
        • id: string
        • tokenId: bigint
        • collectionAddress: `0x${string}`

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

getProtocolFee

  • Parameters

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

    Returns Promise<{
        recipient: `0x${string}`;
        fraction: bigint;
    } | {
        recipient: `0x${string}`;
        fraction: bigint;
    } | {
        recipient: `0x${string}`;
        fraction: bigint;
    }>

Properties

Static calculateProratedOriginationFee

calculateProratedOriginationFee: ((__namedParameters) => {
    fee: bigint;
    actualEaprBps: bigint;
}) = calculateProratedOriginationFee

Type declaration

    • (__namedParameters): {
          fee: bigint;
          actualEaprBps: bigint;
      }

    • Parameters

      • __namedParameters: {
            principal: bigint;
            aprBps: bigint;
            duration: bigint;
            effectiveApr: number;
        }
        • principal: bigint
        • aprBps: bigint
        • duration: bigint
        • effectiveApr: number

      Returns {
          fee: bigint;
          actualEaprBps: bigint;
      }

      • fee: bigint
      • actualEaprBps: bigint

Static buildSiweMessage

buildSiweMessage: ((__namedParameters) => string) = buildSiweMessage

Type declaration

    • (__namedParameters): string

    • Parameters

      • __namedParameters: {
            domain: string;
            address: string;
            statement: string;
            uri: string;
            version: string;
            chainId: number;
            nonce: string;
            issuedAt?: string;
        }
        • domain: string
        • address: string
        • statement: string
        • uri: string
        • version: string
        • chainId: number
        • nonce: string
        • Optional issuedAt?: string

      Returns string

contracts

contracts: Contracts

wallet

wallet: {}

Type declaration

    account

    account: Account

    bcClient

    bcClient: {}

    Type declaration

      apiClient

      apiClient: Api

      Settings

      Theme

      On This Page