@indigo-labs/indigo-sdk 0.1.0

package/dist/types/indigo/price-oracle.d.ts

@@ -0,0 +1,4 @@
+export type PriceOracleDatum = {
+    price: bigint;
+    expiration: bigint;
+};

package/dist/types/indigo/price-oracle.js

@@ -0,0 +1 @@
+export {};

package/dist/types/system-params.d.ts

@@ -0,0 +1,217 @@
+import { AssetClass, CurrencySymbol } from "./generic";
+export 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;
+}
+export type ValidatorHashes = {
+    versionRegistryHash: string;
+    treasuryHash: string;
+    stakingHash: string;
+    stabilityPoolHash: string;
+    pollShardHash: string;
+    pollManagerHash: string;
+    govHash: string;
+    executeHash: string;
+    collectorHash: string;
+    cdpHash: string;
+    cdpCreatorHash: string;
+};
+export interface AddressCredential {
+    tag: string;
+    contents: PubKeyHash;
+}
+export interface ScriptCredential {
+    tag: string;
+    contents: {
+        tag: string;
+        contents: string;
+    };
+}
+export interface PubKeyHash {
+    getPubKeyHash: string;
+}
+export interface VersionRecordParams {
+    upgradeToken: AssetClass;
+}
+export interface TreasuryParams {
+    upgradeToken: AssetClass;
+    versionRecordToken: AssetClass;
+    treasuryUtxosStakeCredential?: ScriptCredential;
+}
+export interface StartTime {
+    slot: number;
+    blockHeader: string;
+}
+export interface StakingParams {
+    versionRecordToken: AssetClass;
+    stakingToken: AssetClass;
+    stakingManagerNFT: AssetClass;
+    pollToken: AssetClass;
+    indyToken: AssetClass;
+    collectorValHash: string;
+}
+export 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;
+}
+export 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;
+}
+export interface Output {
+    scriptRef: ScriptRef;
+    output: ScriptOutput;
+}
+export interface ScriptRef {
+    tag: string;
+    contents?: string[] | null;
+}
+export interface ScriptOutput {
+    referenceScript: string;
+    datum: AddressCredentialOrDatum;
+    amount: Amount;
+    address: Address;
+}
+export interface AddressCredentialOrDatum {
+    tag: string;
+    contents: string;
+}
+export interface Amount {
+    getValue?: ((CurrencySymbol | ((number)[] | null)[] | null)[] | null)[] | null;
+}
+export interface Address {
+    addressStakingCredential?: null;
+    addressCredential: AddressCredentialOrDatum;
+}
+export interface Input {
+    transactionId: string;
+    index: number;
+}
+export interface ScriptReference {
+    output: Output;
+    input: Input;
+}
+export interface AuthTokenPolicies {
+    upgradeTokenRef: ScriptReference;
+    stakingTokenRef: ScriptReference;
+    stabilityPoolTokenRef: ScriptReference;
+    snapshotEpochToScaleToSumTokenRef: ScriptReference;
+    pollManagerTokenRef: ScriptReference;
+    iAssetTokenRef: ScriptReference;
+    cdpAuthTokenRef: ScriptReference;
+    accountTokenRef: ScriptReference;
+}
+export interface PollShardParams {
+    stakingValHash: string;
+    stakingToken: AssetClass;
+    pollToken: AssetClass;
+    indyAsset: AssetClass;
+}
+export interface PollManagerParams {
+    upgradeToken: AssetClass;
+    treasuryValHash: string;
+    shardsValHash: string;
+    pollToken: AssetClass;
+    pBiasTime: number;
+    initialIndyDistribution: number;
+    indyAsset: AssetClass;
+    govNFT: AssetClass;
+    govExecuteValHash: string;
+}
+export interface GovParams {
+    versionRecordToken: AssetClass;
+    upgradeToken: AssetClass;
+    pollToken: AssetClass;
+    pollManagerValHash: string;
+    indyAsset: AssetClass;
+    iAssetAuthToken: AssetClass;
+    govNFT: AssetClass;
+    gBiasTime: number;
+    daoIdentityToken: AssetClass;
+}
+export interface ExecuteParams {
+    versionRegistryValHash: string;
+    versionRecordToken: AssetClass;
+    upgradeToken: AssetClass;
+    treasuryValHash: string;
+    stabilityPoolToken: AssetClass;
+    sPoolValHash: string;
+    maxInterestPeriods: number;
+    iAssetToken: AssetClass;
+    govNFT: AssetClass;
+    cdpValHash: string;
+}
+export interface DistributionParams {
+    treasuryIndyAmount: number;
+    totalINDYSupply: number;
+    initialIndyDistribution: number;
+}
+export interface CollectorParams {
+    versionRecordToken: AssetClass;
+    stakingToken: AssetClass;
+    stakingManagerNFT: AssetClass;
+}
+export 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;
+}
+export interface CdpCreatorParams {
+    versionRecordToken: AssetClass;
+    minCollateralInLovelace: number;
+    iAssetAuthTk: AssetClass;
+    collectorValHash: string;
+    cdpScriptHash: string;
+    cdpCreatorNft: AssetClass;
+    cdpAuthTk: AssetClass;
+    cdpAssetCs: CurrencySymbol;
+    biasTime: number;
+}

package/dist/types/system-params.js

@@ -0,0 +1 @@
+export {};

package/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  "presets": [
+      [
+          "@babel/preset-env",
+          {
+              "targets": {
+                  "node": "current"
+              }
+          }
+      ],
+      "@babel/preset-typescript",
+  ]
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@indigo-labs/indigo-sdk",
+    "version": "0.1.0",
+    "description": "Indigo SDK for interacting with Indigo endpoints via lucid-evolution",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc",
+        "build-tsup": "tsup src/index.ts --format esm,cjs --dts --clean",
+        "test": "node --no-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "prettier": "prettier --ignore-path .gitignore --write \"./src/**/*.+(js|ts|json)\"",
+        "prettier:fix": "prettier --write src",
+        "example": "tsup ./examples/sample-cdp.ts  --format esm,cjs --dts --clean && node ./dist/sample-cdp.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/IndigoProtocol/indigo-sdk.git"
+    },
+    "keywords": [
+        "indigo",
+        "sdk",
+        "typescript",
+        "lucid-evolution",
+        "cdp"
+    ],
+    "author": "3rd Eye Labs",
+    "license": "MIT",
+    "dependencies": {
+        "@lucid-evolution/lucid": "^0.4.22",
+        "babel-jest": "^29.5.0"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.21.4",
+        "@babel/preset-env": "^7.21.4",
+        "@babel/preset-typescript": "^7.21.4",
+        "@types/jest": "^29.5.0",
+        "jest": "^29.5.0",
+        "ts-jest": "^29.1.0",
+        "ts-node": "^10.9.1",
+        "tsup": "^8.3.6",
+        "typescript": "^5.0.3"
+    }
+}

package/src/contracts/cdp-creator.ts

@@ -0,0 +1,86 @@
+import {
+  Address,
+  applyParamsToScript,
+  Constr,
+  Credential,
+  Data,
+  fromText,
+  LucidEvolution,
+  SpendingValidator,
+  UTxO,
+  validatorToAddress,
+  validatorToScriptHash,
+} from '@lucid-evolution/lucid';
+import { _cdpCreatorValidator } from '../scripts/cdp-creator-validator';
+import { CdpCreatorParams, ScriptReferences } from '../types/system-params';
+import { scriptRef } from '../helpers/lucid-utils';
+
+export class CDPCreatorContract {
+  static address(params: CdpCreatorParams, lucid: LucidEvolution): Address {
+    const network = lucid.config().network;
+    if (!network) {
+      throw new Error('Network configuration is undefined');
+    }
+    return validatorToAddress(network, CDPCreatorContract.validator(params));
+  }
+
+  static validator(params: CdpCreatorParams): SpendingValidator {
+    return {
+      type: 'PlutusV2',
+      script: applyParamsToScript(_cdpCreatorValidator.cborHex, [
+        new Constr(0, [
+          new Constr(0, [
+            params.cdpCreatorNft[0].unCurrencySymbol,
+            fromText(params.cdpCreatorNft[1].unTokenName),
+          ]),
+          params.cdpAssetCs.unCurrencySymbol,
+          new Constr(0, [
+            params.cdpAuthTk[0].unCurrencySymbol,
+            fromText(params.cdpAuthTk[1].unTokenName),
+          ]),
+          new Constr(0, [
+            params.iAssetAuthTk[0].unCurrencySymbol,
+            fromText(params.iAssetAuthTk[1].unTokenName),
+          ]),
+          new Constr(0, [
+            params.versionRecordToken[0].unCurrencySymbol,
+            fromText(params.versionRecordToken[1].unTokenName),
+          ]),
+          params.cdpScriptHash,
+          params.collectorValHash,
+          BigInt(params.minCollateralInLovelace),
+          BigInt(params.biasTime),
+        ]),
+      ]),
+    };
+  }
+
+  static validatorHash(
+    params: CdpCreatorParams
+  ): string {
+    return validatorToScriptHash(CDPCreatorContract.validator(params));
+  }
+
+  static redeemer(
+    hash: Credential,
+    mintedAmount: bigint,
+    collateralAmount: bigint,
+    currentTime: bigint,
+  ): Data {
+    if (hash.type !== 'Key') throw new Error('Cannot support script hash.');
+
+    return new Constr<Data>(0, [
+      hash.hash,
+      BigInt(mintedAmount),
+      BigInt(collateralAmount),
+      currentTime
+    ]);
+  }
+
+  static scriptRef(
+    params: ScriptReferences,
+    lucid: LucidEvolution,
+  ): Promise<UTxO> {
+    return scriptRef(params.cdpCreatorValidatorRef, lucid);
+  }
+}