@indigo-labs/indigo-sdk 0.1.0 → 0.1.2

package/dist/index.d.mts

@@ -0,0 +1,418 @@
+import { LucidEvolution, Address as Address$1, SpendingValidator, Credential, Data, UTxO, OutRef, TxBuilder, Constr, Assets, ScriptType } from '@lucid-evolution/lucid';
+
+interface OnChainDecimal {
+    getOnChainInt: bigint;
+}
+interface CurrencySymbol {
+    unCurrencySymbol: string;
+}
+interface TokenName {
+    unTokenName: string;
+}
+type AssetClass = [CurrencySymbol, TokenName];
+
+interface SystemParams {
+    versionRecordParams: VersionRecordParams;
+    validatorHashes: ValidatorHashes;
+    treasuryParams: TreasuryParams;
+    startTime: StartTime;
+    stakingParams: StakingParams;
+    stabilityPoolParams: StabilityPoolParams;
+    scriptReferences: ScriptReferences;
+    pollShardParams: PollShardParams;
+    pollManagerParams: PollManagerParams;
+    indyToken: AssetClass;
+    govParams: GovParams;
+    executeParams: ExecuteParams;
+    distributionParams: DistributionParams;
+    collectorParams: CollectorParams;
+    cdpParams: CdpParams;
+    cdpCreatorParams: CdpCreatorParams;
+}
+type ValidatorHashes = {
+    versionRegistryHash: string;
+    treasuryHash: string;
+    stakingHash: string;
+    stabilityPoolHash: string;
+    pollShardHash: string;
+    pollManagerHash: string;
+    govHash: string;
+    executeHash: string;
+    collectorHash: string;
+    cdpHash: string;
+    cdpCreatorHash: string;
+};
+interface AddressCredential {
+    tag: string;
+    contents: PubKeyHash;
+}
+interface ScriptCredential {
+    tag: string;
+    contents: {
+        tag: string;
+        contents: string;
+    };
+}
+interface PubKeyHash {
+    getPubKeyHash: string;
+}
+interface VersionRecordParams {
+    upgradeToken: AssetClass;
+}
+interface TreasuryParams {
+    upgradeToken: AssetClass;
+    versionRecordToken: AssetClass;
+    treasuryUtxosStakeCredential?: ScriptCredential;
+}
+interface StartTime {
+    slot: number;
+    blockHeader: string;
+}
+interface StakingParams {
+    versionRecordToken: AssetClass;
+    stakingToken: AssetClass;
+    stakingManagerNFT: AssetClass;
+    pollToken: AssetClass;
+    indyToken: AssetClass;
+    collectorValHash: string;
+}
+interface StabilityPoolParams {
+    versionRecordToken: AssetClass;
+    stabilityPoolToken: AssetClass;
+    snapshotEpochToScaleToSumToken: AssetClass;
+    requestCollateralLovelaces: number;
+    iAssetAuthToken: AssetClass;
+    govNFT: AssetClass;
+    collectorValHash: string;
+    cdpToken: AssetClass;
+    assetSymbol: CurrencySymbol;
+    accountToken: AssetClass;
+    accountCreateFeeLovelaces: number;
+    accountAdjustmentFeeLovelaces: number;
+}
+interface ScriptReferences {
+    vestingValidatorRef: ScriptReference;
+    versionRegistryValidatorRef: ScriptReference;
+    versionRecordTokenPolicyRef: ScriptReference;
+    treasuryValidatorRef: ScriptReference;
+    stakingValidatorRef: ScriptReference;
+    stabilityPoolValidatorRef: ScriptReference;
+    pollShardValidatorRef: ScriptReference;
+    pollManagerValidatorRef: ScriptReference;
+    liquidityValidatorRef: ScriptReference;
+    iAssetTokenPolicyRef: ScriptReference;
+    governanceValidatorRef: ScriptReference;
+    executeValidatorRef: ScriptReference;
+    collectorValidatorRef: ScriptReference;
+    cdpValidatorRef: ScriptReference;
+    cdpCreatorValidatorRef: ScriptReference;
+    authTokenPolicies: AuthTokenPolicies;
+}
+interface Output {
+    scriptRef: ScriptRef;
+    output: ScriptOutput;
+}
+interface ScriptRef {
+    tag: string;
+    contents?: string[] | null;
+}
+interface ScriptOutput {
+    referenceScript: string;
+    datum: AddressCredentialOrDatum;
+    amount: Amount;
+    address: Address;
+}
+interface AddressCredentialOrDatum {
+    tag: string;
+    contents: string;
+}
+interface Amount {
+    getValue?: ((CurrencySymbol | ((number)[] | null)[] | null)[] | null)[] | null;
+}
+interface Address {
+    addressStakingCredential?: null;
+    addressCredential: AddressCredentialOrDatum;
+}
+interface Input {
+    transactionId: string;
+    index: number;
+}
+interface ScriptReference {
+    output: Output;
+    input: Input;
+}
+interface AuthTokenPolicies {
+    upgradeTokenRef: ScriptReference;
+    stakingTokenRef: ScriptReference;
+    stabilityPoolTokenRef: ScriptReference;
+    snapshotEpochToScaleToSumTokenRef: ScriptReference;
+    pollManagerTokenRef: ScriptReference;
+    iAssetTokenRef: ScriptReference;
+    cdpAuthTokenRef: ScriptReference;
+    accountTokenRef: ScriptReference;
+}
+interface PollShardParams {
+    stakingValHash: string;
+    stakingToken: AssetClass;
+    pollToken: AssetClass;
+    indyAsset: AssetClass;
+}
+interface PollManagerParams {
+    upgradeToken: AssetClass;
+    treasuryValHash: string;
+    shardsValHash: string;
+    pollToken: AssetClass;
+    pBiasTime: number;
+    initialIndyDistribution: number;
+    indyAsset: AssetClass;
+    govNFT: AssetClass;
+    govExecuteValHash: string;
+}
+interface GovParams {
+    versionRecordToken: AssetClass;
+    upgradeToken: AssetClass;
+    pollToken: AssetClass;
+    pollManagerValHash: string;
+    indyAsset: AssetClass;
+    iAssetAuthToken: AssetClass;
+    govNFT: AssetClass;
+    gBiasTime: number;
+    daoIdentityToken: AssetClass;
+}
+interface ExecuteParams {
+    versionRegistryValHash: string;
+    versionRecordToken: AssetClass;
+    upgradeToken: AssetClass;
+    treasuryValHash: string;
+    stabilityPoolToken: AssetClass;
+    sPoolValHash: string;
+    maxInterestPeriods: number;
+    iAssetToken: AssetClass;
+    govNFT: AssetClass;
+    cdpValHash: string;
+}
+interface DistributionParams {
+    treasuryIndyAmount: number;
+    totalINDYSupply: number;
+    initialIndyDistribution: number;
+}
+interface CollectorParams {
+    versionRecordToken: AssetClass;
+    stakingToken: AssetClass;
+    stakingManagerNFT: AssetClass;
+}
+interface CdpParams {
+    versionRecordToken: AssetClass;
+    upgradeToken: AssetClass;
+    treasuryValHash: string;
+    stabilityPoolAuthToken: AssetClass;
+    spValHash: string;
+    partialRedemptionExtraFeeLovelace: number;
+    minCollateralInLovelace: number;
+    iAssetAuthToken: AssetClass;
+    govNFT: AssetClass;
+    collectorValHash: string;
+    cdpAuthToken: AssetClass;
+    cdpAssetSymbol: CurrencySymbol;
+    biasTime: number;
+}
+interface CdpCreatorParams {
+    versionRecordToken: AssetClass;
+    minCollateralInLovelace: number;
+    iAssetAuthTk: AssetClass;
+    collectorValHash: string;
+    cdpScriptHash: string;
+    cdpCreatorNft: AssetClass;
+    cdpAuthTk: AssetClass;
+    cdpAssetCs: CurrencySymbol;
+    biasTime: number;
+}
+
+declare class CDPCreatorContract {
+    static address(params: CdpCreatorParams, lucid: LucidEvolution): Address$1;
+    static validator(params: CdpCreatorParams): SpendingValidator;
+    static validatorHash(params: CdpCreatorParams): string;
+    static redeemer(hash: Credential, mintedAmount: bigint, collateralAmount: bigint, currentTime: bigint): Data;
+    static scriptRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+}
+
+type ActiveCDPInterestTracking = {
+    type: 'ActiveCDPInterestTracking';
+    last_settled: bigint;
+    unitary_interest_snapshot: bigint;
+};
+type FrozenCDPAccumulatedFees = {
+    type: 'FrozenCDPAccumulatedFees';
+    lovelaces_treasury: bigint;
+    lovelaces_indy_stakers: bigint;
+};
+type CDPFees = ActiveCDPInterestTracking | FrozenCDPAccumulatedFees;
+type CDP = {
+    type: 'CDP';
+    owner: string | undefined;
+    asset: string;
+    mintedAmount: bigint;
+    fees: CDPFees;
+};
+type IAsset = {
+    type: 'IAsset';
+    name: string;
+    price: OnChainDecimal | AssetClass;
+    interestOracle: AssetClass;
+    redemptionRatioPercentage: OnChainDecimal;
+    maintenanceRatioPercentage: OnChainDecimal;
+    liquidationRatioPercentage: OnChainDecimal;
+    debtMintingFeePercentage: OnChainDecimal;
+    liquidationProcessingFeePercentage: OnChainDecimal;
+    stabilityPoolWithdrawalFeePercentage: OnChainDecimal;
+    redemptionReimbursementPercentage: OnChainDecimal;
+    redemptionProcessingFeePercentage: OnChainDecimal;
+    interestCollectorPortionPercentage: OnChainDecimal;
+    firstAsset: boolean;
+    nextAsset?: string;
+};
+type CDPDatum = CDP | IAsset;
+
+declare class CDPContract {
+    static openPosition(asset: string, collateralAmount: bigint, mintedAmount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, cdpCreatorRef?: OutRef, collectorRef?: OutRef): Promise<TxBuilder>;
+    static deposit(cdpRef: OutRef, amount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static withdraw(cdpRef: OutRef, amount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static mint(cdpRef: OutRef, amount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static burn(cdpRef: OutRef, amount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static adjust(cdpRef: OutRef, collateralAmount: bigint, mintAmount: bigint, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static close(cdpRef: OutRef, params: SystemParams, lucid: LucidEvolution, assetRef?: OutRef, priceOracleRef?: OutRef, interestOracleRef?: OutRef, collectorRef?: OutRef, govRef?: OutRef, treasuryRef?: OutRef): Promise<TxBuilder>;
+    static decodeCdpDatum(datum: string): CDPDatum;
+    static encodeCdpDatum(datum: CDPDatum): string;
+    static datum(hash: Credential, asset: string, mintedAmount: bigint, fees: CDPFees): Constr<Data>;
+    static validator(params: CdpParams): SpendingValidator;
+    static validatorHash(params: CdpParams): string;
+    static address(cdpParams: CdpParams, lucid: LucidEvolution, skh?: Credential): string;
+    static scriptRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+    static cdpAuthTokenRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+    static assetTokenRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+    static assetAuthTokenRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+}
+
+declare class CollectorContract {
+    static feeTx(fee: bigint, lucid: LucidEvolution, params: SystemParams, tx: TxBuilder, collectorRef?: OutRef): Promise<void>;
+    static validator(params: CollectorParams): SpendingValidator;
+    static validatorHash(params: CollectorParams): string;
+    static address(params: CollectorParams, lucid: LucidEvolution): Address$1;
+    static scriptRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+}
+
+type ProtocolParams = {
+    proposalDeposit: bigint;
+    votingPeriod: bigint;
+    effectiveDelay: bigint;
+    expirationPeriod: bigint;
+    collateralFeePercentage: bigint;
+    proposingPeriod: bigint;
+    totalShards: bigint;
+    minimumQuorum: bigint;
+    maxTreasuryLovelaceSpend: bigint;
+    maxTreasuryIndySpend: bigint;
+};
+type GovDatum = {
+    currentProposal: bigint;
+    protocolParams: ProtocolParams;
+    currentVersion: bigint;
+    iassetsCount: bigint;
+    activeProposals: bigint;
+    treasuryIndyWithdrawnAmt: bigint;
+};
+
+declare class GovContract {
+    static decodeGovDatum(datum: string): GovDatum;
+    static encodeGovDatum(datum: GovDatum): string;
+}
+
+type InterestOracleDatum = {
+    unitaryInterest: bigint;
+    interestRate: bigint;
+    lastUpdated: bigint;
+};
+
+declare class InterestOracleContract {
+    static decodeInterestOracleDatum(datum: string): InterestOracleDatum;
+    static encodeInterestOracleDatum(datum: InterestOracleDatum): string;
+    static calculateUnitaryInterestSinceOracleLastUpdated(now: bigint, oracleDatum: InterestOracleDatum): bigint;
+    static calculateUnitaryInterest(timePeriod: bigint, interestRate: bigint): bigint;
+    static calculateAccruedInterest(now: bigint, unitaryInterestSnapshot: bigint, mintedAmount: bigint, interestLastSettled: bigint, interestOracleDatum: InterestOracleDatum): bigint;
+}
+
+type PriceOracleDatum = {
+    price: bigint;
+    expiration: bigint;
+};
+
+declare class PriceOracleContract {
+    static decodePriceOracleDatum(datum: string): PriceOracleDatum;
+    static encodePriceOracleDatum(datum: PriceOracleDatum): string;
+}
+
+declare class TreasuryContract {
+    static feeTx(fee: bigint, lucid: LucidEvolution, params: SystemParams, tx: TxBuilder, treasuryRef?: OutRef): Promise<void>;
+    static validator(params: TreasuryParams): SpendingValidator;
+    static validatorHash(params: TreasuryParams): string;
+    static address(params: TreasuryParams, lucid: LucidEvolution): Address$1;
+    static scriptRef(params: ScriptReferences, lucid: LucidEvolution): Promise<UTxO>;
+}
+
+type IAssetOutput = {
+    utxo: UTxO;
+    datum: IAsset;
+};
+declare class IAssetHelpers {
+    static findIAssetByRef(outRef: OutRef, params: SystemParams, lucid: LucidEvolution): Promise<IAssetOutput>;
+    static findIAssetByName(assetName: string, params: SystemParams, lucid: LucidEvolution): Promise<IAssetOutput>;
+}
+
+declare class CDPHelpers {
+    static cdps(params: SystemParams, lucid: LucidEvolution): Promise<UTxO[]>;
+}
+
+declare function calculateFeeFromPercentage(percent: bigint, amount: bigint): bigint;
+declare function loadSystemParamsFromFile(file: string): SystemParams;
+declare function loadSystemParamsFromUrl(url: string): Promise<SystemParams>;
+
+declare function addrDetails(lucid: LucidEvolution): Promise<[Credential, Credential | undefined]>;
+declare function scriptRef(ref: ScriptReference, lucid: LucidEvolution): Promise<UTxO>;
+declare function balance(utxos: UTxO[]): Assets;
+declare const getRandomElement: (arr: any[]) => any;
+
+declare const oneHour: bigint;
+declare const oneDay: bigint;
+declare const oneYear: bigint;
+
+declare const _cdpCreatorValidator: {
+    type: ScriptType;
+    description: string;
+    cborHex: string;
+};
+
+declare const _cdpValidator: {
+    type: ScriptType;
+    description: string;
+    cborHex: string;
+};
+
+declare const _collectorValidator: {
+    type: ScriptType;
+    description: string;
+    cborHex: string;
+};
+
+declare const _interestOracleValidator: {
+    type: ScriptType;
+    description: string;
+    cborHex: string;
+};
+
+declare const _treasuryValidator: {
+    type: ScriptType;
+    description: string;
+    cborHex: string;
+};
+
+export { type ActiveCDPInterestTracking, type Address, type AddressCredential, type AddressCredentialOrDatum, type Amount, type AssetClass, type AuthTokenPolicies, type CDP, CDPContract, CDPCreatorContract, type CDPDatum, type CDPFees, CDPHelpers, type CdpCreatorParams, type CdpParams, CollectorContract, type CollectorParams, type CurrencySymbol, type DistributionParams, type ExecuteParams, type FrozenCDPAccumulatedFees, GovContract, type GovDatum, type GovParams, type IAsset, IAssetHelpers, type IAssetOutput, type Input, InterestOracleContract, type InterestOracleDatum, type OnChainDecimal, type Output, type PollManagerParams, type PollShardParams, PriceOracleContract, type PriceOracleDatum, type ProtocolParams, type PubKeyHash, type ScriptCredential, type ScriptOutput, type ScriptRef, type ScriptReference, type ScriptReferences, type StabilityPoolParams, type StakingParams, type StartTime, type SystemParams, type TokenName, TreasuryContract, type TreasuryParams, type ValidatorHashes, type VersionRecordParams, _cdpCreatorValidator, _cdpValidator, _collectorValidator, _interestOracleValidator, _treasuryValidator, addrDetails, balance, calculateFeeFromPercentage, getRandomElement, loadSystemParamsFromFile, loadSystemParamsFromUrl, oneDay, oneHour, oneYear, scriptRef };