Class default

Constructors

constructor

new default(
    __namedParameters: {
        oracle_owner_pubkey: Uint8Array;
        txfee_per_byte: bigint;
    },
): default
Parameters
- __namedParameters: { oracle_owner_pubkey: Uint8Array; txfee_per_byte: bigint }
Returns default
- Defined in moria/src/v0/index.ts:93

Properties

_context

_context: CompilerContext

_default_preferred_token_output_bch_amount

_default_preferred_token_output_bch_amount: null | bigint

_template_predefined_data

_template_predefined_data: { [template_name: string]: any }

Methods

addCollateral

addCollateral(
    loan_utxo: UTXOWithNFT,
    amount: bigint,
    loan_private_key: Uint8Array,
    input_coins: SpendableCoin[],
    payout_rules: PayoutRule[],
): AddCollateralTxResult
Add collateral to an existing loan.
Parameters
- loan_utxo: UTXOWithNFT
  The current loan's utxo.
- amount: bigint
  The amount to increase the collateral.
- loan_private_key: Uint8Array
  The private key of the current loan.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the refinance procedure.
- payout_rules: PayoutRule[]
  A list of payout rules.
Returns AddCollateralTxResult
add collateral tx result
- Defined in moria/src/v0/index.ts:239

getCompilerContext

getCompilerContext(): CompilerContext
Returns CompilerContext
- Defined in moria/src/v0/index.ts:121

getInfo

getInfo(): { musd_token_id: string; oracle_token_id: string }
Get musd & oracle token id.

Returns { musd_token_id: string; oracle_token_id: string }
- Defined in moria/src/v0/index.ts:285

getOutputMinAmount

getOutputMinAmount(output: Output): bigint
Parameters
- output: Output
Returns bigint
- Defined in moria/src/v0/index.ts:125

getPreferredTokenOutputBCHAmount

getPreferredTokenOutputBCHAmount(output: Output): null | bigint
Parameters
- output: Output
Returns null | bigint
- Defined in moria/src/v0/index.ts:140

getTxFeePerByte

getTxFeePerByte(): bigint
Returns bigint
- Defined in moria/src/v0/index.ts:149

liquidateLoan

liquidateLoan(
    moria_utxo: UTXOWithNFT,
    oracle_utxo: UTXOWithNFT,
    loan_utxo: UTXOWithNFT,
    input_coins: SpendableCoin[],
    payout_rules: PayoutRule[],
): moria0.MoriaTxResult
Liquidate an under-water (collateral < 110%) loan. With MUSD tokens equivalent to the loan amount. The payout is the loan's collateral + the remainder of MUSD tokens if more MUSD is provided in inputs.
Parameters
- moria_utxo: UTXOWithNFT
  The moria's utxo.
- oracle_utxo: UTXOWithNFT
  The oracle's utxo.
- loan_utxo: UTXOWithNFT
  The current loan's utxo.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the refinance procedure.
- payout_rules: PayoutRule[]
  A list of payout rules. The payout rules is expected to not have more than two outputs.
Returns moria0.MoriaTxResult
A tx that pays out the collateral in exchange for MUSD
- Defined in moria/src/v0/index.ts:205

mintLoan

mintLoan(
    moria_utxo: UTXOWithNFT,
    oracle_utxo: UTXOWithNFT,
    input_coins: SpendableCoin[],
    loan_amount: bigint,
    collateral_amount: bigint,
    borrower_pkh: Uint8Array,
    token_payout_locking_bytecode: Uint8Array,
    payout_rules: PayoutRule[],
): MintTxResult
Mint a new loan. The collateral amount is taken from input_coins and the remaining - fees is in the payouts.
Parameters
- moria_utxo: UTXOWithNFT
  The moria's utxo.
- oracle_utxo: UTXOWithNFT
  The oracle's utxo.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the loan's collateral + fees
- loan_amount: bigint
  The amount of MUSD to mint.
- collateral_amount: bigint
  The collateral amount (sats)
- borrower_pkh: Uint8Array
  borrower's public key's hash160, the pkh's format is equivalent to pkh used in p2pkh
- token_payout_locking_bytecode: Uint8Array
- payout_rules: PayoutRule[]
  A list of payout rules. The payout rules is expected to not have more than two outputs.
Returns MintTxResult
The mint tx result.
- Defined in moria/src/v0/index.ts:170

redeemWithSunsetSignature

redeemWithSunsetSignature(
    moria_utxo: UTXOWithNFT,
    oracle_utxo: UTXOWithNFT,
    loan_utxo: UTXOWithNFT,
    sunset_datasig: Uint8Array,
    input_coins: SpendableCoin[],
    payout_rules: PayoutRule[],
): RedeemTxResult
Redeem MUSD tokens equivalent to the loan amount with a BCH payout, The payout includes the remainder of MUSD tokens if more MUSD is provided in inputs.
Parameters
- moria_utxo: UTXOWithNFT
  The moria's utxo.
- oracle_utxo: UTXOWithNFT
  The oracle's utxo.
- loan_utxo: UTXOWithNFT
  The current loan's utxo.
- sunset_datasig: Uint8Array
  A unique sig which will be revealed on the blockchain once the sunset event occurs.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the refinance procedure.
- payout_rules: PayoutRule[]
  A list of payout rules. The payout rules is expected to not have more than two outputs.
Returns RedeemTxResult
A tx that redeems MUSD with BCH payouts
- Defined in moria/src/v0/index.ts:223

refiLoan

refiLoan(
    moria_utxo: UTXOWithNFT,
    oracle_utxo: UTXOWithNFT,
    next_loan_amount: bigint,
    next_collateral_amount: bigint,
    current_loan_utxo: UTXOWithNFT,
    current_loan_private_key: Uint8Array,
    next_loan_pkh: Uint8Array,
    input_coins: SpendableCoin[],
    payout_rules: PayoutRule[],
): RefinanceLoanResult
Mint a new loan to pay back another loan in order to reduce or increase the size and/or add or decrease the collateral rate of the loan.
Parameters
- moria_utxo: UTXOWithNFT
  The moria's utxo.
- oracle_utxo: UTXOWithNFT
  The oracle's utxo.
- next_loan_amount: bigint
  the amount of the next loan
- next_collateral_amount: bigint
  The collateral amount for the substitute loan
- current_loan_utxo: UTXOWithNFT
  The current loan's utxo.
- current_loan_private_key: Uint8Array
  The private key of the current loan.
- next_loan_pkh: Uint8Array
  borrower's public key's hash160, the pkh's format is equivalent to pkh used in p2pkh.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the refinance procedure.
- payout_rules: PayoutRule[]
  A list of payout rules. The payout rules is expected to not have more than two outputs.
Returns RefinanceLoanResult
refinance tx chain with details
- Defined in moria/src/v0/index.ts:260

repayLoan

repayLoan(
    moria_utxo: UTXOWithNFT,
    oracle_utxo: UTXOWithNFT,
    loan_utxo: UTXOWithNFT,
    loan_private_key: Uint8Array,
    input_coins: SpendableCoin[],
    payout_rules: PayoutRule[],
): moria0.MoriaTxResult
Repay a loan with MUSD tokens equivalent to the loan amount. The payout is the loan's collateral + the remainder of MUSD tokens if more MUSD is provided in inputs.
Parameters
- moria_utxo: UTXOWithNFT
  The moria's utxo.
- oracle_utxo: UTXOWithNFT
  The oracle's utxo.
- loan_utxo: UTXOWithNFT
  The current loan's utxo.
- loan_private_key: Uint8Array
  The private key of the current loan.
- input_coins: SpendableCoin[]
  A set of spendable coins to fund the refinance procedure.
- payout_rules: PayoutRule[]
  A list of payout rules. The payout rules is expected to not have more than two outputs.
Returns moria0.MoriaTxResult
A tx that pays out the collateral in exchange for MUSD
- Defined in moria/src/v0/index.ts:188

setDefaultPreferredTokenOutputBCHAmount

setDefaultPreferredTokenOutputBCHAmount(value: null | bigint): void
Parameters
- value: null | bigint
Returns void
- Defined in moria/src/v0/index.ts:146

setTxFeePerByte

setTxFeePerByte(value: bigint): void
Parameters
- value: bigint
Returns void
- Defined in moria/src/v0/index.ts:152

verifyTxResult

verifyTxResult(tx_result: TxResult): void
Verify the validity of a TxResult, Expecting the generated transaction should be valid.
Parameters
- tx_result: TxResult
  result of a generated transaction
Returns void
Throws
InvalidProgramState
- Defined in moria/src/v0/index.ts:270

`Static`calculateCollateralAmountForTargetRate

calculateCollateralAmountForTargetRate(
    loan_amount: bigint,
    rate: Fraction | "MIN",
    oracle_price: bigint,
): bigint
Helper function for calculating the collateral amount for a target collateral rate at a given price.
Parameters
- loan_amount: bigint
  Loan amount.
- rate: Fraction | "MIN"
  Collateral rate represented as a Fraction or literal string 'MIN' for minimum collateral amount possible.
- oracle_price: bigint
  The token price from the oracle
Returns bigint
the collateral amount
- Defined in moria/src/v0/index.ts:302

`Static`calculateLoanAmountWithAvailableCollateralForTargetRate

calculateLoanAmountWithAvailableCollateralForTargetRate(
    collateral_amount: bigint,
    rate: Fraction | "MIN",
    oracle_price: bigint,
): bigint
Helper function for calculating the loan amount with the collateral_amount with a target collateral rate at a given price.
Parameters
- collateral_amount: bigint
  Collateral amount in sats.
- rate: Fraction | "MIN"
  Collateral rate represented as a Fraction or literal string 'MIN' for minimum collateral amount possible.
- oracle_price: bigint
  The token price from the oracle
Returns bigint
the loan amount
- Defined in moria/src/v0/index.ts:347

`Static`getConstants

getConstants(): MoriaV0Constants
Returns MoriaV0Constants
- Defined in moria/src/v0/index.ts:57

`Static`moriaLibauthCompiler

moriaLibauthCompiler(
    getPredefinedData: () => {
        oracle_token: Uint8Array;
        sunset_message: Uint8Array;
        sunset_pubkey: Uint8Array;
    },
): CompilerBch
Parameters
- getPredefinedData: () => {
      oracle_token: Uint8Array;
      sunset_message: Uint8Array;
      sunset_pubkey: Uint8Array;
  }
Returns CompilerBch
- Defined in moria/src/v0/index.ts:65

`Static`oracleLibauthCompiler

oracleLibauthCompiler(
getPredefinedData: () => { owner_pubkey: Uint8Array },
): CompilerBch
Parameters
- getPredefinedData: () => { owner_pubkey: Uint8Array }
Returns CompilerBch
- Defined in moria/src/v0/index.ts:79

`Static`parseOracleMessageFromNFTCommitment

parseOracleMessageFromNFTCommitment(commitment: Uint8Array): OracleNFTParameters
Reads a valid oracle's commitment.
Parameters
- commitment: Uint8Array
  the nft's commitment
Returns OracleNFTParameters
parameters stored in the loan's commitment
- Defined in moria/src/v0/index.ts:373

`Static`parseParametersFromLoanNFTCommitment

parseParametersFromLoanNFTCommitment(commitment: Uint8Array): LoanNFTParameters
Reads a valid loan's commitment.
Parameters
- commitment: Uint8Array
  the nft's commitment
Returns LoanNFTParameters
parameters stored in the loan's commitment
- Defined in moria/src/v0/index.ts:359

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

_context

_default_preferred_token_output_bch_amount

_template_predefined_data

Methods

addCollateral

Parameters

Returns AddCollateralTxResult

getCompilerContext

Returns CompilerContext

getInfo

Returns { musd_token_id: string; oracle_token_id: string }

getOutputMinAmount

Parameters

Returns bigint

getPreferredTokenOutputBCHAmount

Parameters

Returns null | bigint

getTxFeePerByte

Returns bigint

liquidateLoan

Parameters

Returns moria0.MoriaTxResult

mintLoan

Parameters

Returns MintTxResult

redeemWithSunsetSignature

Parameters

Returns RedeemTxResult

refiLoan

Parameters

Returns RefinanceLoanResult

repayLoan

Parameters

Returns moria0.MoriaTxResult

setDefaultPreferredTokenOutputBCHAmount

Parameters

Returns void

setTxFeePerByte

Parameters

Returns void

verifyTxResult

Parameters

Returns void

Throws

StaticcalculateCollateralAmountForTargetRate

Parameters

Returns bigint

StaticcalculateLoanAmountWithAvailableCollateralForTargetRate

Parameters

Returns bigint

StaticgetConstants

Returns MoriaV0Constants

StaticmoriaLibauthCompiler

Parameters

Returns CompilerBch

StaticoracleLibauthCompiler

Parameters

Returns CompilerBch

StaticparseOracleMessageFromNFTCommitment

Parameters

Returns OracleNFTParameters

StaticparseParametersFromLoanNFTCommitment

Parameters

Returns LoanNFTParameters

Settings

On This Page

`Static`calculateCollateralAmountForTargetRate

`Static`calculateLoanAmountWithAvailableCollateralForTargetRate

`Static`getConstants

`Static`moriaLibauthCompiler

`Static`oracleLibauthCompiler

`Static`parseOracleMessageFromNFTCommitment

`Static`parseParametersFromLoanNFTCommitment