@indigo-labs/indigo-sdk 0.2.42 → 0.3.1

package/.github/workflows/ci.yml

@@ -2,12 +2,14 @@ name: CI
 
 on:
   push:
-    branches: [main, develop]
+    branches:
+      - main
+      - v3
   pull_request:
 
 jobs:
   lint-and-build:
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
 
     steps:
       - name: Checkout code

package/README.md

@@ -49,18 +49,91 @@ Instructions:
 2. Run `pnpm install`
 3. Run `pnpm run test`
 
-## Endpoints
-
-- **Open CDP**
-- **Close CDP**
-- **Deposit Collateral to CDP**
-- **Withdraw Collateral from CDP**
-- **Mint against CDP**
-- **Burn against CDP**
-- **Pay CDP Interest**
-- **Open a Staking Position**
-- **Adjust a Staking Position**
-- **Close a Staking Position**
-- **Open a Stability Pool Account**
-- **Adjust a Stability Pool Account**
-- **Close a Stability Pool Account**
+## Transaction endpoints
+
+The SDK exposes **transaction builders** (mostly async functions that return a Lucid `TxBuilder`, or attach to an existing builder). They are grouped below by on-chain contract module under `src/contracts/`.
+
+### CDP (`cdp`)
+
+| Function       | Summary                                                                          |
+| -------------- | -------------------------------------------------------------------------------- |
+| `openCdp`      | Open a new CDP: deposit collateral, mint iAsset.                                 |
+| `depositCdp`   | Add collateral to an existing CDP.                                               |
+| `withdrawCdp`  | Withdraw collateral from an existing CDP                                         |
+| `mintCdp`      | Mint additional iAsset debt with an existing CDP.                                |
+| `burnCdp`      | Burn iAsset to pay down existing CDP's debt.                                     |
+| `closeCdp`     | Close a CDP, burn remaining debt and withdraw collateral.                        |
+| `redeemCdp`    | Redeem iAsset for collateral (burning CDP debt and withdrawing collateral).      |
+| `freezeCdp`    | Freeze a CDP marking it for liquidation.                                         |
+| `liquidateCdp` | Liquidate a frozen CDP via the stability pool: absorb debt, move collateral.     |
+| `mergeCdps`    | Merge several frozen CDPs for the same iAsset into a single combined frozen CDP. |
+
+### Collector (`collector`)
+
+| Function         | Summary                                                     |
+| ---------------- | ----------------------------------------------------------- |
+| `collectorFeeTx` | Attach a collector fee payment to an in-flight transaction. |
+
+### Governance (`gov`)
+
+| Function             | Summary                                    |
+| -------------------- | ------------------------------------------ |
+| `createProposal`     | Create a governance proposal.              |
+| `createShardsChunks` | Create poll shards for voting.             |
+| `vote`               | Vote on a poll shard.                      |
+| `mergeShards`        | Merge poll shards to a poll manager.       |
+| `endProposal`        | End the poll and prepare it for execution. |
+| `executeProposal`    | Execute a passed proposal.                 |
+
+### Stability pool (`stability-pool`)
+
+| Function                     | Summary                                               |
+| ---------------------------- | ----------------------------------------------------- |
+| `requestSpAccountCreation`   | Create request for Stability pool account creation.   |
+| `requestSpAccountAdjustment` | Create request for Stability pool account adjustment. |
+| `requestSpAccountClosure`    | Create request for Stability pool account closure.    |
+| `processSpRequest`           | Process a request against a Stability pool.           |
+| `createE2s2sSnapshots`       | Record new epoch–scale–sum snapshot.                  |
+
+### Staking (`staking`)
+
+| Function                | Summary                                                  |
+| ----------------------- | -------------------------------------------------------- |
+| `openStakingPosition`   | Create INDY staking position.                            |
+| `adjustStakingPosition` | Adjust the stake in your INDY staking position.          |
+| `closeStakingPosition`  | Close your staking position and withdraw your stake.     |
+| `distributeAda`         | Distribute ADA from collector to INDY stakers as reward. |
+
+### Interest oracle (`interest-oracle`)
+
+| Function              | Summary                                                  |
+| --------------------- | -------------------------------------------------------- |
+| `startInterestOracle` | Bootstrap an interest oracle UTxO.                       |
+| `feedInterestOracle`  | Update the oracle’s interest rate and last-updated time. |
+
+### Interest collection (`interest-collection`)
+
+| Function               | Summary                                                                                     |
+| ---------------------- | ------------------------------------------------------------------------------------------- |
+| `batchCollectInterest` | Settle and collect interest for multiple CDPs in a single Tx.                               |
+| `distributeInterest`   | Distribute funds held by interest collector UTxOs according to the interest admin multisig. |
+| `updatePermissions`    | Update interest admin permissions.                                                          |
+
+### Treasury (`treasury`)
+
+| Function                    | Summary                                                                      |
+| --------------------------- | ---------------------------------------------------------------------------- |
+| `treasuryFeeTx`             | Attach a treasury fee payment to an in-flight transaction.                   |
+| `treasuryMerge`             | Merge multiple treasury UTxOs into one.                                      |
+| `treasurySplit`             | Split one treasury UTxO into separate outputs per asset.                     |
+| `treasuryPrepareWithdrawal` | Prepare treasury UTXO tied to a proposal execution and requested withdrawal. |
+
+### ROB — Indigo order book (`rob`)
+
+| Function    | Summary                                                                               |
+| ----------- | ------------------------------------------------------------------------------------- |
+| `openRob`   | Create a buy-iAsset or sell-iAsset order.                                             |
+| `cancelRob` | Cancel an open order and recover the deposit.                                         |
+| `redeemRob` | Fill market order using current oracle price.                                         |
+| `adjustRob` | Adjust deposit on an order, update limit price and claim proceeds from order filling. |
+| `claimRob`  | Claim proceeds from a filled or partially filled order.                               |