chore(sdk): add auto-generated docs

kumo-earth · Oct 1, 2023 · 3eb6c12 · 3eb6c12
1 parent 387fafa
commit 3eb6c12
Show file tree

Hide file tree

Showing 138 changed files with 31 additions and 2,445 deletions.
diff --git a/docs/sdk/lib-base.kumostake.md b/docs/sdk/lib-base.kumostake.md
@@ -14,7 +14,7 @@ export declare class KUMOStake
 
 ## Remarks
 
-Returned by the [getKUMOStake()](./lib-base.readablekumo.getkumostake.md) function.
+Returned by the  function.
 
 The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `KUMOStake` class.
 

diff --git a/docs/sdk/lib-base.kumostorebasestate.kumobalance.md b/docs/sdk/lib-base.kumostorebasestate.kumobalance.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.kumostake.md b/docs/sdk/lib-base.kumostorebasestate.kumostake.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.kumotoken.md b/docs/sdk/lib-base.kumostorebasestate.kumotoken.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.liquidityminingkumoreward.md b/docs/sdk/lib-base.kumostorebasestate.liquidityminingkumoreward.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.liquidityminingstake.md b/docs/sdk/lib-base.kumostorebasestate.liquidityminingstake.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.md b/docs/sdk/lib-base.kumostorebasestate.md
@@ -16,18 +16,7 @@ export interface KumoStoreBaseState
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [kumoBalance](./lib-base.kumostorebasestate.kumobalance.md) |  | [Decimal](./lib-base.decimal.md) | User's KUMO token balance. |
-|  [kumoStake](./lib-base.kumostorebasestate.kumostake.md) |  | [KUMOStake](./lib-base.kumostake.md) | User's KUMO stake. |
-|  [kumoToken](./lib-base.kumostorebasestate.kumotoken.md) |  | string | KUSD token address |
 |  [kusdBalance](./lib-base.kumostorebasestate.kusdbalance.md) |  | [Decimal](./lib-base.decimal.md) | User's KUSD token balance. |
 |  [kusdToken](./lib-base.kumostorebasestate.kusdtoken.md) |  | string | KUSD token address |
-|  [liquidityMiningKUMOReward](./lib-base.kumostorebasestate.liquidityminingkumoreward.md) |  | [Decimal](./lib-base.decimal.md) | Amount of KUMO the user has earned through mining liquidity. |
-|  [liquidityMiningStake](./lib-base.kumostorebasestate.liquidityminingstake.md) |  | [Decimal](./lib-base.decimal.md) | Amount of Uniswap ETH/KUSD LP tokens the user has staked in liquidity mining. |
-|  [remainingLiquidityMiningKUMOReward](./lib-base.kumostorebasestate.remainingliquidityminingkumoreward.md) |  | [Decimal](./lib-base.decimal.md) | Remaining KUMO that will be collectively rewarded to liquidity miners. |
-|  [remainingStabilityPoolKUMOReward](./lib-base.kumostorebasestate.remainingstabilitypoolkumoreward.md) |  | [Decimal](./lib-base.decimal.md) | Remaining KUMO that will be collectively rewarded to stability depositors. |
-|  [totalStakedKUMO](./lib-base.kumostorebasestate.totalstakedkumo.md) |  | [Decimal](./lib-base.decimal.md) | Total amount of KUMO currently staked. |
-|  [totalStakedUniTokens](./lib-base.kumostorebasestate.totalstakedunitokens.md) |  | [Decimal](./lib-base.decimal.md) | Total amount of Uniswap ETH/KUSD LP tokens currently staked in liquidity mining. |
-|  [uniTokenAllowance](./lib-base.kumostorebasestate.unitokenallowance.md) |  | [Decimal](./lib-base.decimal.md) | The liquidity mining contract's allowance of user's Uniswap ETH/KUSD LP tokens. |
-|  [uniTokenBalance](./lib-base.kumostorebasestate.unitokenbalance.md) |  | [Decimal](./lib-base.decimal.md) | User's Uniswap ETH/KUSD LP token balance. |
 |  [vaults](./lib-base.kumostorebasestate.vaults.md) |  | [Vault](./lib-base.vault.md)<!-- -->\[\] | Custom Vault Array for each Asset type |
 
diff --git a/docs/sdk/lib-base.kumostorebasestate.remainingliquidityminingkumoreward.md b/docs/sdk/lib-base.kumostorebasestate.remainingliquidityminingkumoreward.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.remainingstabilitypoolkumoreward.md b/docs/sdk/lib-base.kumostorebasestate.remainingstabilitypoolkumoreward.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.totalstakedkumo.md b/docs/sdk/lib-base.kumostorebasestate.totalstakedkumo.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.totalstakedunitokens.md b/docs/sdk/lib-base.kumostorebasestate.totalstakedunitokens.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.unitokenallowance.md b/docs/sdk/lib-base.kumostorebasestate.unitokenallowance.md
diff --git a/docs/sdk/lib-base.kumostorebasestate.unitokenbalance.md b/docs/sdk/lib-base.kumostorebasestate.unitokenbalance.md
diff --git a/docs/sdk/lib-base.populatablekumo.approveunitokens.md b/docs/sdk/lib-base.populatablekumo.approveunitokens.md
diff --git a/docs/sdk/lib-base.populatablekumo.depositkusdinstabilitypool.md b/docs/sdk/lib-base.populatablekumo.depositkusdinstabilitypool.md
@@ -27,5 +27,5 @@ Promise&lt;[PopulatedKumoTransaction](./lib-base.populatedkumotransaction.md)<!-
 
 The `frontendTag` parameter is only effective when making a new deposit.
 
-As a side-effect, the transaction will also pay out an existing Stability Deposit's [collateral gain](./lib-base.stabilitydeposit.collateralgain.md) and [KUMO reward](./lib-base.stabilitydeposit.kumoreward.md)<!-- -->.
+As a side-effect, the transaction will also pay out an existing Stability Deposit's [collateral gain](./lib-base.stabilitydeposit.collateralgain.md) and TODO: after KIP-3, change to `KUSD reward` .
 
diff --git a/docs/sdk/lib-base.populatablekumo.exitliquiditymining.md b/docs/sdk/lib-base.populatablekumo.exitliquiditymining.md
diff --git a/docs/sdk/lib-base.populatablekumo.md b/docs/sdk/lib-base.populatablekumo.md
@@ -24,30 +24,21 @@ Implemented by [PopulatableEthersKumo](./lib-ethers.populatableetherskumo.md)<!-
 |  Method | Description |
 |  --- | --- |
 |  [adjustTrove(params, asset, maxBorrowingRate)](./lib-base.populatablekumo.adjusttrove.md) | Adjust existing Trove by changing its collateral, debt, or both. |
-|  [approveUniTokens(allowance)](./lib-base.populatablekumo.approveunitokens.md) | Allow the liquidity mining contract to use Uniswap ETH/KUSD LP tokens for [staking](./lib-base.transactablekumo.stakeunitokens.md)<!-- -->. |
 |  [borrowKUSD(asset, amount, maxBorrowingRate)](./lib-base.populatablekumo.borrowkusd.md) | Adjust existing Trove by borrowing more KUSD. |
 |  [claimCollateralSurplus(asset)](./lib-base.populatablekumo.claimcollateralsurplus.md) | Claim leftover collateral after a liquidation or redemption. |
 |  [closeTrove(asset)](./lib-base.populatablekumo.closetrove.md) | Close existing Trove by repaying all debt and withdrawing all collateral. |
 |  [depositCollateral(asset, amount)](./lib-base.populatablekumo.depositcollateral.md) | Adjust existing Trove by depositing more collateral. |
 |  [depositKUSDInStabilityPool(amount, asset)](./lib-base.populatablekumo.depositkusdinstabilitypool.md) | Make a new Stability Deposit, or top up existing one. |
-|  [exitLiquidityMining()](./lib-base.populatablekumo.exitliquiditymining.md) | Withdraw all staked LP tokens from liquidity mining and claim reward. |
 |  [liquidate(asset, address)](./lib-base.populatablekumo.liquidate.md) | Liquidate one or more undercollateralized Troves. |
 |  [liquidateUpTo(asset, maximumNumberOfTrovesToLiquidate)](./lib-base.populatablekumo.liquidateupto.md) | Liquidate the least collateralized Troves up to a maximum number. |
 |  [openTrove(params, asset, maxBorrowingRate)](./lib-base.populatablekumo.opentrove.md) | Open a new Trove by depositing collateral and borrowing KUSD. |
 |  [redeemKUSD(asset, amount, maxRedemptionRate)](./lib-base.populatablekumo.redeemkusd.md) | Redeem KUSD to native currency (e.g. Ether) at face value. |
 |  [repayKUSD(asset, amount)](./lib-base.populatablekumo.repaykusd.md) | Adjust existing Trove by repaying some of its debt. |
 |  [requestTestToken(tokenAddress)](./lib-base.populatablekumo.requesttesttoken.md) | Request Test tokens to an address. |
-|  [sendKUMO(toAddress, amount)](./lib-base.populatablekumo.sendkumo.md) | Send KUMO tokens to an address. |
 |  [sendKUSD(toAddress, amount)](./lib-base.populatablekumo.sendkusd.md) | Send KUSD tokens to an address. |
-|  [stakeKUMO(amount)](./lib-base.populatablekumo.stakekumo.md) | Stake KUMO to start earning fee revenue or increase existing stake. |
-|  [stakeUniTokens(amount)](./lib-base.populatablekumo.stakeunitokens.md) | Stake Uniswap ETH/KUSD LP tokens to participate in liquidity mining and earn KUMO. |
 |  [transferCollateralGainToTrove(asset, assetName)](./lib-base.populatablekumo.transfercollateralgaintotrove.md) | Transfer [collateral gain](./lib-base.stabilitydeposit.collateralgain.md) from Stability Deposit to Trove. |
 |  [transferTestTokens(tokenAddress, toAddress, amount)](./lib-base.populatablekumo.transfertesttokens.md) | Request Test tokens to an address. |
-|  [unstakeKUMO(amount)](./lib-base.populatablekumo.unstakekumo.md) | Withdraw KUMO from staking. |
-|  [unstakeUniTokens(amount)](./lib-base.populatablekumo.unstakeunitokens.md) | Withdraw Uniswap ETH/KUSD LP tokens from liquidity mining. |
 |  [withdrawCollateral(asset, amount)](./lib-base.populatablekumo.withdrawcollateral.md) | Adjust existing Trove by withdrawing some of its collateral. |
-|  [withdrawGainsFromStabilityPool(asset)](./lib-base.populatablekumo.withdrawgainsfromstabilitypool.md) | Withdraw [collateral gain](./lib-base.stabilitydeposit.collateralgain.md) and [KUMO reward](./lib-base.stabilitydeposit.kumoreward.md) from Stability Deposit. |
-|  [withdrawGainsFromStaking()](./lib-base.populatablekumo.withdrawgainsfromstaking.md) | Withdraw [collateral gain](./lib-base.kumostake.collateralgain.md) and [KUSD gain](./lib-base.kumostake.kusdgain.md) from KUMO stake. |
-|  [withdrawKUMORewardFromLiquidityMining()](./lib-base.populatablekumo.withdrawkumorewardfromliquiditymining.md) | Withdraw KUMO that has been earned by mining liquidity. |
+|  [withdrawGainsFromStabilityPool(asset)](./lib-base.populatablekumo.withdrawgainsfromstabilitypool.md) | Withdraw [collateral gain](./lib-base.stabilitydeposit.collateralgain.md) and  from Stability Deposit. |
 |  [withdrawKUSDFromStabilityPool(amount, asset)](./lib-base.populatablekumo.withdrawkusdfromstabilitypool.md) | Withdraw KUSD from Stability Deposit. |
 
diff --git a/docs/sdk/lib-base.populatablekumo.sendkumo.md b/docs/sdk/lib-base.populatablekumo.sendkumo.md
diff --git a/docs/sdk/lib-base.populatablekumo.stakekumo.md b/docs/sdk/lib-base.populatablekumo.stakekumo.md
diff --git a/docs/sdk/lib-base.populatablekumo.stakeunitokens.md b/docs/sdk/lib-base.populatablekumo.stakeunitokens.md
diff --git a/docs/sdk/lib-base.populatablekumo.transfercollateralgaintotrove.md b/docs/sdk/lib-base.populatablekumo.transfercollateralgaintotrove.md
@@ -27,5 +27,5 @@ Promise&lt;[PopulatedKumoTransaction](./lib-base.populatedkumotransaction.md)<!-
 
 The collateral gain is transfered to the Trove as additional collateral.
 
-As a side-effect, the transaction will also pay out the Stability Deposit's [KUMO reward](./lib-base.stabilitydeposit.kumoreward.md)<!-- -->.
+As a side-effect, the transaction will also pay out the Stability Deposit's .
 
diff --git a/docs/sdk/lib-base.populatablekumo.unstakekumo.md b/docs/sdk/lib-base.populatablekumo.unstakekumo.md