@compass-labs/api-sdk 2.2.106 → 2.2.108-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -33
- package/codeSamples_typescript.yaml +6 -78
- package/dist/commonjs/funcs/creditCreditSwap.d.ts +23 -0
- package/dist/commonjs/funcs/creditCreditSwap.d.ts.map +1 -0
- package/dist/commonjs/funcs/{riskYieldRiskYieldCollect.js → creditCreditSwap.js} +14 -9
- package/dist/commonjs/funcs/creditCreditSwap.js.map +1 -0
- package/dist/commonjs/funcs/earnEarnSwap.d.ts +7 -7
- package/dist/commonjs/funcs/earnEarnSwap.js +7 -7
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/models/components/creditswaprequest.d.ts +112 -0
- package/dist/commonjs/models/components/creditswaprequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/creditswaprequest.js +101 -0
- package/dist/commonjs/models/components/creditswaprequest.js.map +1 -0
- package/dist/commonjs/models/components/creditswapresponse.d.ts +51 -0
- package/dist/commonjs/models/components/creditswapresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{riskyieldliquidityresponse.js → creditswapresponse.js} +25 -25
- package/dist/commonjs/models/components/creditswapresponse.js.map +1 -0
- package/dist/commonjs/models/components/earnswaprequest.d.ts +2 -3
- package/dist/commonjs/models/components/earnswaprequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/earnswaprequest.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +2 -57
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +2 -57
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +0 -4
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -4
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.d.ts +4 -4
- package/dist/commonjs/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.js +5 -5
- package/dist/commonjs/models/operations/v2earnvaults.js.map +1 -1
- package/dist/commonjs/sdk/credit.d.ts +12 -0
- package/dist/commonjs/sdk/credit.d.ts.map +1 -1
- package/dist/commonjs/sdk/credit.js +15 -0
- package/dist/commonjs/sdk/credit.js.map +1 -1
- package/dist/commonjs/sdk/earn.d.ts +7 -7
- package/dist/commonjs/sdk/earn.js +7 -7
- package/dist/commonjs/sdk/sdk.d.ts +0 -3
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +0 -4
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/creditCreditSwap.d.ts +23 -0
- package/dist/esm/funcs/creditCreditSwap.d.ts.map +1 -0
- package/dist/esm/funcs/{riskYieldRiskYieldCollect.js → creditCreditSwap.js} +13 -8
- package/dist/esm/funcs/creditCreditSwap.js.map +1 -0
- package/dist/esm/funcs/earnEarnSwap.d.ts +7 -7
- package/dist/esm/funcs/earnEarnSwap.js +7 -7
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/models/components/creditswaprequest.d.ts +112 -0
- package/dist/esm/models/components/creditswaprequest.d.ts.map +1 -0
- package/dist/esm/models/components/creditswaprequest.js +62 -0
- package/dist/esm/models/components/creditswaprequest.js.map +1 -0
- package/dist/esm/models/components/creditswapresponse.d.ts +51 -0
- package/dist/esm/models/components/creditswapresponse.d.ts.map +1 -0
- package/dist/esm/models/components/creditswapresponse.js +37 -0
- package/dist/esm/models/components/creditswapresponse.js.map +1 -0
- package/dist/esm/models/components/earnswaprequest.d.ts +2 -3
- package/dist/esm/models/components/earnswaprequest.d.ts.map +1 -1
- package/dist/esm/models/components/earnswaprequest.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +2 -57
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +2 -57
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +0 -4
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -4
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.d.ts +4 -4
- package/dist/esm/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.js +3 -3
- package/dist/esm/models/operations/v2earnvaults.js.map +1 -1
- package/dist/esm/sdk/credit.d.ts +12 -0
- package/dist/esm/sdk/credit.d.ts.map +1 -1
- package/dist/esm/sdk/credit.js +15 -0
- package/dist/esm/sdk/credit.js.map +1 -1
- package/dist/esm/sdk/earn.d.ts +7 -7
- package/dist/esm/sdk/earn.js +7 -7
- package/dist/esm/sdk/sdk.d.ts +0 -3
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +0 -4
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/docs/models/components/{riskyieldtransferrequest.md → creditswaprequest.md} +24 -23
- package/docs/models/components/creditswaprequestamountin.md +19 -0
- package/docs/models/components/creditswaprequestchain.md +17 -0
- package/docs/models/components/creditswaprequestpricing.md +17 -0
- package/docs/models/components/creditswaprequestslippage.md +19 -0
- package/docs/models/components/{riskyieldcollectrequest.md → creditswapresponse.md} +14 -18
- package/docs/models/components/creditswapresponseswapprovider.md +17 -0
- package/docs/models/components/earnswaprequest.md +2 -3
- package/docs/models/operations/{v2earnvaultsminliquidityusd.md → minliquidityusd.md} +1 -1
- package/docs/models/operations/v2earnvaultsrequest.md +1 -1
- package/docs/sdks/credit/README.md +94 -0
- package/docs/sdks/earn/README.md +7 -7
- package/openapi_prepped_for_speakeasy.json +10284 -15316
- package/package.json +1 -1
- package/src/funcs/{riskYieldRiskYieldIncrease.ts → creditCreditSwap.ts} +17 -12
- package/src/funcs/earnEarnSwap.ts +7 -7
- package/src/lib/config.ts +2 -2
- package/src/models/components/creditswaprequest.ts +186 -0
- package/src/models/components/creditswapresponse.ts +99 -0
- package/src/models/components/earnswaprequest.ts +2 -3
- package/src/models/components/index.ts +2 -57
- package/src/models/operations/index.ts +0 -4
- package/src/models/operations/v2earnvaults.ts +8 -12
- package/src/sdk/credit.ts +23 -0
- package/src/sdk/earn.ts +7 -7
- package/src/sdk/sdk.ts +0 -6
- package/dist/commonjs/funcs/riskYieldRiskYieldCollect.d.ts +0 -18
- package/dist/commonjs/funcs/riskYieldRiskYieldCollect.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldCollect.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldCreateAccount.d.ts +0 -27
- package/dist/commonjs/funcs/riskYieldRiskYieldCreateAccount.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldCreateAccount.js +0 -128
- package/dist/commonjs/funcs/riskYieldRiskYieldCreateAccount.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldDecrease.d.ts +0 -23
- package/dist/commonjs/funcs/riskYieldRiskYieldDecrease.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldDecrease.js +0 -124
- package/dist/commonjs/funcs/riskYieldRiskYieldDecrease.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldIncrease.d.ts +0 -18
- package/dist/commonjs/funcs/riskYieldRiskYieldIncrease.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldIncrease.js +0 -119
- package/dist/commonjs/funcs/riskYieldRiskYieldIncrease.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldMint.d.ts +0 -30
- package/dist/commonjs/funcs/riskYieldRiskYieldMint.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldMint.js +0 -131
- package/dist/commonjs/funcs/riskYieldRiskYieldMint.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPools.d.ts +0 -33
- package/dist/commonjs/funcs/riskYieldRiskYieldPools.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPools.js +0 -151
- package/dist/commonjs/funcs/riskYieldRiskYieldPools.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPoolsPoolId.d.ts +0 -24
- package/dist/commonjs/funcs/riskYieldRiskYieldPoolsPoolId.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPoolsPoolId.js +0 -136
- package/dist/commonjs/funcs/riskYieldRiskYieldPoolsPoolId.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPositions.d.ts +0 -34
- package/dist/commonjs/funcs/riskYieldRiskYieldPositions.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldPositions.js +0 -141
- package/dist/commonjs/funcs/riskYieldRiskYieldPositions.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldRebalance.d.ts +0 -37
- package/dist/commonjs/funcs/riskYieldRiskYieldRebalance.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldRebalance.js +0 -138
- package/dist/commonjs/funcs/riskYieldRiskYieldRebalance.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldRiskScenarios.d.ts +0 -42
- package/dist/commonjs/funcs/riskYieldRiskYieldRiskScenarios.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldRiskScenarios.js +0 -143
- package/dist/commonjs/funcs/riskYieldRiskYieldRiskScenarios.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldSwap.d.ts +0 -32
- package/dist/commonjs/funcs/riskYieldRiskYieldSwap.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldSwap.js +0 -133
- package/dist/commonjs/funcs/riskYieldRiskYieldSwap.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldTokens.d.ts +0 -28
- package/dist/commonjs/funcs/riskYieldRiskYieldTokens.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldTokens.js +0 -142
- package/dist/commonjs/funcs/riskYieldRiskYieldTokens.js.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldTransfer.d.ts +0 -25
- package/dist/commonjs/funcs/riskYieldRiskYieldTransfer.d.ts.map +0 -1
- package/dist/commonjs/funcs/riskYieldRiskYieldTransfer.js +0 -126
- package/dist/commonjs/funcs/riskYieldRiskYieldTransfer.js.map +0 -1
- package/dist/commonjs/models/components/bothsidesdeposit.d.ts +0 -31
- package/dist/commonjs/models/components/bothsidesdeposit.d.ts.map +0 -1
- package/dist/commonjs/models/components/bothsidesdeposit.js +0 -63
- package/dist/commonjs/models/components/bothsidesdeposit.js.map +0 -1
- package/dist/commonjs/models/components/costbasis.d.ts +0 -25
- package/dist/commonjs/models/components/costbasis.d.ts.map +0 -1
- package/dist/commonjs/models/components/costbasis.js +0 -61
- package/dist/commonjs/models/components/costbasis.js.map +0 -1
- package/dist/commonjs/models/components/costbasissource.d.ts +0 -11
- package/dist/commonjs/models/components/costbasissource.d.ts.map +0 -1
- package/dist/commonjs/models/components/costbasissource.js +0 -48
- package/dist/commonjs/models/components/costbasissource.js.map +0 -1
- package/dist/commonjs/models/components/createriskyieldaccountrequest.d.ts +0 -46
- package/dist/commonjs/models/components/createriskyieldaccountrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/createriskyieldaccountrequest.js +0 -65
- package/dist/commonjs/models/components/createriskyieldaccountrequest.js.map +0 -1
- package/dist/commonjs/models/components/createriskyieldaccountresponse.d.ts +0 -18
- package/dist/commonjs/models/components/createriskyieldaccountresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/createriskyieldaccountresponse.js +0 -57
- package/dist/commonjs/models/components/createriskyieldaccountresponse.js.map +0 -1
- package/dist/commonjs/models/components/depositplan.d.ts +0 -32
- package/dist/commonjs/models/components/depositplan.d.ts.map +0 -1
- package/dist/commonjs/models/components/depositplan.js +0 -65
- package/dist/commonjs/models/components/depositplan.js.map +0 -1
- package/dist/commonjs/models/components/dexpooldetailresponse.d.ts +0 -23
- package/dist/commonjs/models/components/dexpooldetailresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/dexpooldetailresponse.js +0 -67
- package/dist/commonjs/models/components/dexpooldetailresponse.js.map +0 -1
- package/dist/commonjs/models/components/dexpoolinfo.d.ts +0 -110
- package/dist/commonjs/models/components/dexpoolinfo.d.ts.map +0 -1
- package/dist/commonjs/models/components/dexpoolinfo.js +0 -130
- package/dist/commonjs/models/components/dexpoolinfo.js.map +0 -1
- package/dist/commonjs/models/components/dexpoolsresponse.d.ts +0 -14
- package/dist/commonjs/models/components/dexpoolsresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/dexpoolsresponse.js +0 -54
- package/dist/commonjs/models/components/dexpoolsresponse.js.map +0 -1
- package/dist/commonjs/models/components/dextokeninfo.d.ts +0 -43
- package/dist/commonjs/models/components/dextokeninfo.d.ts.map +0 -1
- package/dist/commonjs/models/components/dextokeninfo.js +0 -86
- package/dist/commonjs/models/components/dextokeninfo.js.map +0 -1
- package/dist/commonjs/models/components/dextokenkind.d.ts +0 -17
- package/dist/commonjs/models/components/dextokenkind.d.ts.map +0 -1
- package/dist/commonjs/models/components/dextokenkind.js +0 -54
- package/dist/commonjs/models/components/dextokenkind.js.map +0 -1
- package/dist/commonjs/models/components/dextokenref.d.ts +0 -29
- package/dist/commonjs/models/components/dextokenref.d.ts.map +0 -1
- package/dist/commonjs/models/components/dextokenref.js +0 -68
- package/dist/commonjs/models/components/dextokenref.js.map +0 -1
- package/dist/commonjs/models/components/dextokensresponse.d.ts +0 -18
- package/dist/commonjs/models/components/dextokensresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/dextokensresponse.js +0 -60
- package/dist/commonjs/models/components/dextokensresponse.js.map +0 -1
- package/dist/commonjs/models/components/dexversion.d.ts +0 -30
- package/dist/commonjs/models/components/dexversion.d.ts.map +0 -1
- package/dist/commonjs/models/components/dexversion.js +0 -59
- package/dist/commonjs/models/components/dexversion.js.map +0 -1
- package/dist/commonjs/models/components/fullrange.d.ts +0 -15
- package/dist/commonjs/models/components/fullrange.d.ts.map +0 -1
- package/dist/commonjs/models/components/fullrange.js +0 -49
- package/dist/commonjs/models/components/fullrange.js.map +0 -1
- package/dist/commonjs/models/components/launchpad.d.ts +0 -14
- package/dist/commonjs/models/components/launchpad.d.ts.map +0 -1
- package/dist/commonjs/models/components/launchpad.js +0 -52
- package/dist/commonjs/models/components/launchpad.js.map +0 -1
- package/dist/commonjs/models/components/launchpadmetadata.d.ts +0 -22
- package/dist/commonjs/models/components/launchpadmetadata.d.ts.map +0 -1
- package/dist/commonjs/models/components/launchpadmetadata.js +0 -63
- package/dist/commonjs/models/components/launchpadmetadata.js.map +0 -1
- package/dist/commonjs/models/components/liquiditybucket.d.ts +0 -27
- package/dist/commonjs/models/components/liquiditybucket.d.ts.map +0 -1
- package/dist/commonjs/models/components/liquiditybucket.js +0 -64
- package/dist/commonjs/models/components/liquiditybucket.js.map +0 -1
- package/dist/commonjs/models/components/lpposition.d.ts +0 -100
- package/dist/commonjs/models/components/lpposition.d.ts.map +0 -1
- package/dist/commonjs/models/components/lpposition.js +0 -120
- package/dist/commonjs/models/components/lpposition.js.map +0 -1
- package/dist/commonjs/models/components/pairclass.d.ts +0 -24
- package/dist/commonjs/models/components/pairclass.d.ts.map +0 -1
- package/dist/commonjs/models/components/pairclass.js +0 -59
- package/dist/commonjs/models/components/pairclass.js.map +0 -1
- package/dist/commonjs/models/components/planstep.d.ts +0 -23
- package/dist/commonjs/models/components/planstep.d.ts.map +0 -1
- package/dist/commonjs/models/components/planstep.js +0 -55
- package/dist/commonjs/models/components/planstep.js.map +0 -1
- package/dist/commonjs/models/components/planstepkind.d.ts +0 -17
- package/dist/commonjs/models/components/planstepkind.d.ts.map +0 -1
- package/dist/commonjs/models/components/planstepkind.js +0 -54
- package/dist/commonjs/models/components/planstepkind.js.map +0 -1
- package/dist/commonjs/models/components/poolhourlypoint.d.ts +0 -22
- package/dist/commonjs/models/components/poolhourlypoint.d.ts.map +0 -1
- package/dist/commonjs/models/components/poolhourlypoint.js +0 -69
- package/dist/commonjs/models/components/poolhourlypoint.js.map +0 -1
- package/dist/commonjs/models/components/poolonchainstate.d.ts +0 -29
- package/dist/commonjs/models/components/poolonchainstate.d.ts.map +0 -1
- package/dist/commonjs/models/components/poolonchainstate.js +0 -68
- package/dist/commonjs/models/components/poolonchainstate.js.map +0 -1
- package/dist/commonjs/models/components/poolselector.d.ts +0 -62
- package/dist/commonjs/models/components/poolselector.d.ts.map +0 -1
- package/dist/commonjs/models/components/poolselector.js +0 -64
- package/dist/commonjs/models/components/poolselector.js.map +0 -1
- package/dist/commonjs/models/components/positionstatus.d.ts +0 -12
- package/dist/commonjs/models/components/positionstatus.d.ts.map +0 -1
- package/dist/commonjs/models/components/positionstatus.js +0 -49
- package/dist/commonjs/models/components/positionstatus.js.map +0 -1
- package/dist/commonjs/models/components/pricerange.d.ts +0 -31
- package/dist/commonjs/models/components/pricerange.d.ts.map +0 -1
- package/dist/commonjs/models/components/pricerange.js +0 -69
- package/dist/commonjs/models/components/pricerange.js.map +0 -1
- package/dist/commonjs/models/components/pricesource.d.ts +0 -31
- package/dist/commonjs/models/components/pricesource.d.ts.map +0 -1
- package/dist/commonjs/models/components/pricesource.js +0 -60
- package/dist/commonjs/models/components/pricesource.js.map +0 -1
- package/dist/commonjs/models/components/probabilisticoutlook.d.ts +0 -32
- package/dist/commonjs/models/components/probabilisticoutlook.d.ts.map +0 -1
- package/dist/commonjs/models/components/probabilisticoutlook.js +0 -73
- package/dist/commonjs/models/components/probabilisticoutlook.js.map +0 -1
- package/dist/commonjs/models/components/rebalancephase.d.ts +0 -16
- package/dist/commonjs/models/components/rebalancephase.d.ts.map +0 -1
- package/dist/commonjs/models/components/rebalancephase.js +0 -53
- package/dist/commonjs/models/components/rebalancephase.js.map +0 -1
- package/dist/commonjs/models/components/rebalancereason.d.ts +0 -14
- package/dist/commonjs/models/components/rebalancereason.d.ts.map +0 -1
- package/dist/commonjs/models/components/rebalancereason.js +0 -51
- package/dist/commonjs/models/components/rebalancereason.js.map +0 -1
- package/dist/commonjs/models/components/rebalancestrategy.d.ts +0 -17
- package/dist/commonjs/models/components/rebalancestrategy.d.ts.map +0 -1
- package/dist/commonjs/models/components/rebalancestrategy.js +0 -51
- package/dist/commonjs/models/components/rebalancestrategy.js.map +0 -1
- package/dist/commonjs/models/components/resolvedrange.d.ts +0 -27
- package/dist/commonjs/models/components/resolvedrange.d.ts.map +0 -1
- package/dist/commonjs/models/components/resolvedrange.js +0 -67
- package/dist/commonjs/models/components/resolvedrange.js.map +0 -1
- package/dist/commonjs/models/components/riskassumptions.d.ts +0 -35
- package/dist/commonjs/models/components/riskassumptions.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskassumptions.js +0 -83
- package/dist/commonjs/models/components/riskassumptions.js.map +0 -1
- package/dist/commonjs/models/components/riskscenariosrequest.d.ts +0 -106
- package/dist/commonjs/models/components/riskscenariosrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskscenariosrequest.js +0 -124
- package/dist/commonjs/models/components/riskscenariosrequest.js.map +0 -1
- package/dist/commonjs/models/components/riskscenariosresponse.d.ts +0 -38
- package/dist/commonjs/models/components/riskscenariosresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskscenariosresponse.js +0 -64
- package/dist/commonjs/models/components/riskscenariosresponse.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldcollectrequest.d.ts +0 -81
- package/dist/commonjs/models/components/riskyieldcollectrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldcollectrequest.js +0 -81
- package/dist/commonjs/models/components/riskyieldcollectrequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyielddecreaserequest.d.ts +0 -103
- package/dist/commonjs/models/components/riskyielddecreaserequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyielddecreaserequest.js +0 -90
- package/dist/commonjs/models/components/riskyielddecreaserequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldincreaserequest.d.ts +0 -93
- package/dist/commonjs/models/components/riskyieldincreaserequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldincreaserequest.js +0 -98
- package/dist/commonjs/models/components/riskyieldincreaserequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldliquidityresponse.d.ts +0 -28
- package/dist/commonjs/models/components/riskyieldliquidityresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldliquidityresponse.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldmintrequest.d.ts +0 -106
- package/dist/commonjs/models/components/riskyieldmintrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldmintrequest.js +0 -117
- package/dist/commonjs/models/components/riskyieldmintrequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldpositionsresponse.d.ts +0 -16
- package/dist/commonjs/models/components/riskyieldpositionsresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldpositionsresponse.js +0 -64
- package/dist/commonjs/models/components/riskyieldpositionsresponse.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldrebalancerequest.d.ts +0 -125
- package/dist/commonjs/models/components/riskyieldrebalancerequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldrebalancerequest.js +0 -98
- package/dist/commonjs/models/components/riskyieldrebalancerequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldrebalanceresponse.d.ts +0 -34
- package/dist/commonjs/models/components/riskyieldrebalanceresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldrebalanceresponse.js +0 -81
- package/dist/commonjs/models/components/riskyieldrebalanceresponse.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldswaprequest.d.ts +0 -101
- package/dist/commonjs/models/components/riskyieldswaprequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldswaprequest.js +0 -89
- package/dist/commonjs/models/components/riskyieldswaprequest.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldswapresponse.d.ts +0 -27
- package/dist/commonjs/models/components/riskyieldswapresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldswapresponse.js +0 -58
- package/dist/commonjs/models/components/riskyieldswapresponse.js.map +0 -1
- package/dist/commonjs/models/components/riskyieldtransferrequest.d.ts +0 -95
- package/dist/commonjs/models/components/riskyieldtransferrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/riskyieldtransferrequest.js +0 -84
- package/dist/commonjs/models/components/riskyieldtransferrequest.js.map +0 -1
- package/dist/commonjs/models/components/scenarioinput.d.ts +0 -68
- package/dist/commonjs/models/components/scenarioinput.d.ts.map +0 -1
- package/dist/commonjs/models/components/scenarioinput.js +0 -77
- package/dist/commonjs/models/components/scenarioinput.js.map +0 -1
- package/dist/commonjs/models/components/scenarioresult.d.ts +0 -31
- package/dist/commonjs/models/components/scenarioresult.d.ts.map +0 -1
- package/dist/commonjs/models/components/scenarioresult.js +0 -78
- package/dist/commonjs/models/components/scenarioresult.js.map +0 -1
- package/dist/commonjs/models/components/simulation.d.ts +0 -21
- package/dist/commonjs/models/components/simulation.d.ts.map +0 -1
- package/dist/commonjs/models/components/simulation.js +0 -57
- package/dist/commonjs/models/components/simulation.js.map +0 -1
- package/dist/commonjs/models/components/singlesideddeposit.d.ts +0 -30
- package/dist/commonjs/models/components/singlesideddeposit.d.ts.map +0 -1
- package/dist/commonjs/models/components/singlesideddeposit.js +0 -57
- package/dist/commonjs/models/components/singlesideddeposit.js.map +0 -1
- package/dist/commonjs/models/components/stockmetadata.d.ts +0 -27
- package/dist/commonjs/models/components/stockmetadata.d.ts.map +0 -1
- package/dist/commonjs/models/components/stockmetadata.js +0 -67
- package/dist/commonjs/models/components/stockmetadata.js.map +0 -1
- package/dist/commonjs/models/components/stockreference.d.ts +0 -35
- package/dist/commonjs/models/components/stockreference.d.ts.map +0 -1
- package/dist/commonjs/models/components/stockreference.js +0 -66
- package/dist/commonjs/models/components/stockreference.js.map +0 -1
- package/dist/commonjs/models/components/swapplan.d.ts +0 -22
- package/dist/commonjs/models/components/swapplan.d.ts.map +0 -1
- package/dist/commonjs/models/components/swapplan.js +0 -67
- package/dist/commonjs/models/components/swapplan.js.map +0 -1
- package/dist/commonjs/models/components/symmetricrange.d.ts +0 -34
- package/dist/commonjs/models/components/symmetricrange.d.ts.map +0 -1
- package/dist/commonjs/models/components/symmetricrange.js +0 -61
- package/dist/commonjs/models/components/symmetricrange.js.map +0 -1
- package/dist/commonjs/models/components/tickrange.d.ts +0 -19
- package/dist/commonjs/models/components/tickrange.d.ts.map +0 -1
- package/dist/commonjs/models/components/tickrange.js +0 -57
- package/dist/commonjs/models/components/tickrange.js.map +0 -1
- package/dist/commonjs/models/components/usddeposit.d.ts +0 -28
- package/dist/commonjs/models/components/usddeposit.d.ts.map +0 -1
- package/dist/commonjs/models/components/usddeposit.js +0 -61
- package/dist/commonjs/models/components/usddeposit.js.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpools.d.ts +0 -111
- package/dist/commonjs/models/operations/v2riskyieldpools.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpools.js +0 -113
- package/dist/commonjs/models/operations/v2riskyieldpools.js.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpoolspoolid.d.ts +0 -39
- package/dist/commonjs/models/operations/v2riskyieldpoolspoolid.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpoolspoolid.js +0 -71
- package/dist/commonjs/models/operations/v2riskyieldpoolspoolid.js.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpositions.d.ts +0 -41
- package/dist/commonjs/models/operations/v2riskyieldpositions.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldpositions.js +0 -64
- package/dist/commonjs/models/operations/v2riskyieldpositions.js.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldtokens.d.ts +0 -78
- package/dist/commonjs/models/operations/v2riskyieldtokens.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2riskyieldtokens.js +0 -94
- package/dist/commonjs/models/operations/v2riskyieldtokens.js.map +0 -1
- package/dist/commonjs/sdk/riskyield.d.ts +0 -230
- package/dist/commonjs/sdk/riskyield.d.ts.map +0 -1
- package/dist/commonjs/sdk/riskyield.js +0 -275
- package/dist/commonjs/sdk/riskyield.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldCollect.d.ts +0 -18
- package/dist/esm/funcs/riskYieldRiskYieldCollect.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldCollect.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldCreateAccount.d.ts +0 -27
- package/dist/esm/funcs/riskYieldRiskYieldCreateAccount.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldCreateAccount.js +0 -92
- package/dist/esm/funcs/riskYieldRiskYieldCreateAccount.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldDecrease.d.ts +0 -23
- package/dist/esm/funcs/riskYieldRiskYieldDecrease.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldDecrease.js +0 -88
- package/dist/esm/funcs/riskYieldRiskYieldDecrease.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldIncrease.d.ts +0 -18
- package/dist/esm/funcs/riskYieldRiskYieldIncrease.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldIncrease.js +0 -83
- package/dist/esm/funcs/riskYieldRiskYieldIncrease.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldMint.d.ts +0 -30
- package/dist/esm/funcs/riskYieldRiskYieldMint.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldMint.js +0 -95
- package/dist/esm/funcs/riskYieldRiskYieldMint.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPools.d.ts +0 -33
- package/dist/esm/funcs/riskYieldRiskYieldPools.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPools.js +0 -115
- package/dist/esm/funcs/riskYieldRiskYieldPools.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPoolsPoolId.d.ts +0 -24
- package/dist/esm/funcs/riskYieldRiskYieldPoolsPoolId.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPoolsPoolId.js +0 -100
- package/dist/esm/funcs/riskYieldRiskYieldPoolsPoolId.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPositions.d.ts +0 -34
- package/dist/esm/funcs/riskYieldRiskYieldPositions.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldPositions.js +0 -105
- package/dist/esm/funcs/riskYieldRiskYieldPositions.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldRebalance.d.ts +0 -37
- package/dist/esm/funcs/riskYieldRiskYieldRebalance.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldRebalance.js +0 -102
- package/dist/esm/funcs/riskYieldRiskYieldRebalance.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldRiskScenarios.d.ts +0 -42
- package/dist/esm/funcs/riskYieldRiskYieldRiskScenarios.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldRiskScenarios.js +0 -107
- package/dist/esm/funcs/riskYieldRiskYieldRiskScenarios.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldSwap.d.ts +0 -32
- package/dist/esm/funcs/riskYieldRiskYieldSwap.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldSwap.js +0 -97
- package/dist/esm/funcs/riskYieldRiskYieldSwap.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldTokens.d.ts +0 -28
- package/dist/esm/funcs/riskYieldRiskYieldTokens.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldTokens.js +0 -106
- package/dist/esm/funcs/riskYieldRiskYieldTokens.js.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldTransfer.d.ts +0 -25
- package/dist/esm/funcs/riskYieldRiskYieldTransfer.d.ts.map +0 -1
- package/dist/esm/funcs/riskYieldRiskYieldTransfer.js +0 -90
- package/dist/esm/funcs/riskYieldRiskYieldTransfer.js.map +0 -1
- package/dist/esm/models/components/bothsidesdeposit.d.ts +0 -31
- package/dist/esm/models/components/bothsidesdeposit.d.ts.map +0 -1
- package/dist/esm/models/components/bothsidesdeposit.js +0 -24
- package/dist/esm/models/components/bothsidesdeposit.js.map +0 -1
- package/dist/esm/models/components/costbasis.d.ts +0 -25
- package/dist/esm/models/components/costbasis.d.ts.map +0 -1
- package/dist/esm/models/components/costbasis.js +0 -24
- package/dist/esm/models/components/costbasis.js.map +0 -1
- package/dist/esm/models/components/costbasissource.d.ts +0 -11
- package/dist/esm/models/components/costbasissource.d.ts.map +0 -1
- package/dist/esm/models/components/costbasissource.js +0 -12
- package/dist/esm/models/components/costbasissource.js.map +0 -1
- package/dist/esm/models/components/createriskyieldaccountrequest.d.ts +0 -46
- package/dist/esm/models/components/createriskyieldaccountrequest.d.ts.map +0 -1
- package/dist/esm/models/components/createriskyieldaccountrequest.js +0 -28
- package/dist/esm/models/components/createriskyieldaccountrequest.js.map +0 -1
- package/dist/esm/models/components/createriskyieldaccountresponse.d.ts +0 -18
- package/dist/esm/models/components/createriskyieldaccountresponse.d.ts.map +0 -1
- package/dist/esm/models/components/createriskyieldaccountresponse.js +0 -20
- package/dist/esm/models/components/createriskyieldaccountresponse.js.map +0 -1
- package/dist/esm/models/components/depositplan.d.ts +0 -32
- package/dist/esm/models/components/depositplan.d.ts.map +0 -1
- package/dist/esm/models/components/depositplan.js +0 -28
- package/dist/esm/models/components/depositplan.js.map +0 -1
- package/dist/esm/models/components/dexpooldetailresponse.d.ts +0 -23
- package/dist/esm/models/components/dexpooldetailresponse.d.ts.map +0 -1
- package/dist/esm/models/components/dexpooldetailresponse.js +0 -30
- package/dist/esm/models/components/dexpooldetailresponse.js.map +0 -1
- package/dist/esm/models/components/dexpoolinfo.d.ts +0 -110
- package/dist/esm/models/components/dexpoolinfo.d.ts.map +0 -1
- package/dist/esm/models/components/dexpoolinfo.js +0 -93
- package/dist/esm/models/components/dexpoolinfo.js.map +0 -1
- package/dist/esm/models/components/dexpoolsresponse.d.ts +0 -14
- package/dist/esm/models/components/dexpoolsresponse.d.ts.map +0 -1
- package/dist/esm/models/components/dexpoolsresponse.js +0 -17
- package/dist/esm/models/components/dexpoolsresponse.js.map +0 -1
- package/dist/esm/models/components/dextokeninfo.d.ts +0 -43
- package/dist/esm/models/components/dextokeninfo.d.ts.map +0 -1
- package/dist/esm/models/components/dextokeninfo.js +0 -49
- package/dist/esm/models/components/dextokeninfo.js.map +0 -1
- package/dist/esm/models/components/dextokenkind.d.ts +0 -17
- package/dist/esm/models/components/dextokenkind.d.ts.map +0 -1
- package/dist/esm/models/components/dextokenkind.js +0 -18
- package/dist/esm/models/components/dextokenkind.js.map +0 -1
- package/dist/esm/models/components/dextokenref.d.ts +0 -29
- package/dist/esm/models/components/dextokenref.d.ts.map +0 -1
- package/dist/esm/models/components/dextokenref.js +0 -31
- package/dist/esm/models/components/dextokenref.js.map +0 -1
- package/dist/esm/models/components/dextokensresponse.d.ts +0 -18
- package/dist/esm/models/components/dextokensresponse.d.ts.map +0 -1
- package/dist/esm/models/components/dextokensresponse.js +0 -23
- package/dist/esm/models/components/dextokensresponse.js.map +0 -1
- package/dist/esm/models/components/dexversion.d.ts +0 -30
- package/dist/esm/models/components/dexversion.d.ts.map +0 -1
- package/dist/esm/models/components/dexversion.js +0 -23
- package/dist/esm/models/components/dexversion.js.map +0 -1
- package/dist/esm/models/components/fullrange.d.ts +0 -15
- package/dist/esm/models/components/fullrange.d.ts.map +0 -1
- package/dist/esm/models/components/fullrange.js +0 -12
- package/dist/esm/models/components/fullrange.js.map +0 -1
- package/dist/esm/models/components/launchpad.d.ts +0 -14
- package/dist/esm/models/components/launchpad.d.ts.map +0 -1
- package/dist/esm/models/components/launchpad.js +0 -16
- package/dist/esm/models/components/launchpad.js.map +0 -1
- package/dist/esm/models/components/launchpadmetadata.d.ts +0 -22
- package/dist/esm/models/components/launchpadmetadata.d.ts.map +0 -1
- package/dist/esm/models/components/launchpadmetadata.js +0 -26
- package/dist/esm/models/components/launchpadmetadata.js.map +0 -1
- package/dist/esm/models/components/liquiditybucket.d.ts +0 -27
- package/dist/esm/models/components/liquiditybucket.d.ts.map +0 -1
- package/dist/esm/models/components/liquiditybucket.js +0 -27
- package/dist/esm/models/components/liquiditybucket.js.map +0 -1
- package/dist/esm/models/components/lpposition.d.ts +0 -100
- package/dist/esm/models/components/lpposition.d.ts.map +0 -1
- package/dist/esm/models/components/lpposition.js +0 -83
- package/dist/esm/models/components/lpposition.js.map +0 -1
- package/dist/esm/models/components/pairclass.d.ts +0 -24
- package/dist/esm/models/components/pairclass.d.ts.map +0 -1
- package/dist/esm/models/components/pairclass.js +0 -23
- package/dist/esm/models/components/pairclass.js.map +0 -1
- package/dist/esm/models/components/planstep.d.ts +0 -23
- package/dist/esm/models/components/planstep.d.ts.map +0 -1
- package/dist/esm/models/components/planstep.js +0 -18
- package/dist/esm/models/components/planstep.js.map +0 -1
- package/dist/esm/models/components/planstepkind.d.ts +0 -17
- package/dist/esm/models/components/planstepkind.d.ts.map +0 -1
- package/dist/esm/models/components/planstepkind.js +0 -18
- package/dist/esm/models/components/planstepkind.js.map +0 -1
- package/dist/esm/models/components/poolhourlypoint.d.ts +0 -22
- package/dist/esm/models/components/poolhourlypoint.d.ts.map +0 -1
- package/dist/esm/models/components/poolhourlypoint.js +0 -32
- package/dist/esm/models/components/poolhourlypoint.js.map +0 -1
- package/dist/esm/models/components/poolonchainstate.d.ts +0 -29
- package/dist/esm/models/components/poolonchainstate.d.ts.map +0 -1
- package/dist/esm/models/components/poolonchainstate.js +0 -31
- package/dist/esm/models/components/poolonchainstate.js.map +0 -1
- package/dist/esm/models/components/poolselector.d.ts +0 -62
- package/dist/esm/models/components/poolselector.d.ts.map +0 -1
- package/dist/esm/models/components/poolselector.js +0 -27
- package/dist/esm/models/components/poolselector.js.map +0 -1
- package/dist/esm/models/components/positionstatus.d.ts +0 -12
- package/dist/esm/models/components/positionstatus.d.ts.map +0 -1
- package/dist/esm/models/components/positionstatus.js +0 -13
- package/dist/esm/models/components/positionstatus.js.map +0 -1
- package/dist/esm/models/components/pricerange.d.ts +0 -31
- package/dist/esm/models/components/pricerange.d.ts.map +0 -1
- package/dist/esm/models/components/pricerange.js +0 -30
- package/dist/esm/models/components/pricerange.js.map +0 -1
- package/dist/esm/models/components/pricesource.d.ts +0 -31
- package/dist/esm/models/components/pricesource.d.ts.map +0 -1
- package/dist/esm/models/components/pricesource.js +0 -24
- package/dist/esm/models/components/pricesource.js.map +0 -1
- package/dist/esm/models/components/probabilisticoutlook.d.ts +0 -32
- package/dist/esm/models/components/probabilisticoutlook.d.ts.map +0 -1
- package/dist/esm/models/components/probabilisticoutlook.js +0 -36
- package/dist/esm/models/components/probabilisticoutlook.js.map +0 -1
- package/dist/esm/models/components/rebalancephase.d.ts +0 -16
- package/dist/esm/models/components/rebalancephase.d.ts.map +0 -1
- package/dist/esm/models/components/rebalancephase.js +0 -16
- package/dist/esm/models/components/rebalancephase.js.map +0 -1
- package/dist/esm/models/components/rebalancereason.d.ts +0 -14
- package/dist/esm/models/components/rebalancereason.d.ts.map +0 -1
- package/dist/esm/models/components/rebalancereason.js +0 -15
- package/dist/esm/models/components/rebalancereason.js.map +0 -1
- package/dist/esm/models/components/rebalancestrategy.d.ts +0 -17
- package/dist/esm/models/components/rebalancestrategy.d.ts.map +0 -1
- package/dist/esm/models/components/rebalancestrategy.js +0 -15
- package/dist/esm/models/components/rebalancestrategy.js.map +0 -1
- package/dist/esm/models/components/resolvedrange.d.ts +0 -27
- package/dist/esm/models/components/resolvedrange.d.ts.map +0 -1
- package/dist/esm/models/components/resolvedrange.js +0 -30
- package/dist/esm/models/components/resolvedrange.js.map +0 -1
- package/dist/esm/models/components/riskassumptions.d.ts +0 -35
- package/dist/esm/models/components/riskassumptions.d.ts.map +0 -1
- package/dist/esm/models/components/riskassumptions.js +0 -46
- package/dist/esm/models/components/riskassumptions.js.map +0 -1
- package/dist/esm/models/components/riskscenariosrequest.d.ts +0 -106
- package/dist/esm/models/components/riskscenariosrequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskscenariosrequest.js +0 -83
- package/dist/esm/models/components/riskscenariosrequest.js.map +0 -1
- package/dist/esm/models/components/riskscenariosresponse.d.ts +0 -38
- package/dist/esm/models/components/riskscenariosresponse.d.ts.map +0 -1
- package/dist/esm/models/components/riskscenariosresponse.js +0 -27
- package/dist/esm/models/components/riskscenariosresponse.js.map +0 -1
- package/dist/esm/models/components/riskyieldcollectrequest.d.ts +0 -81
- package/dist/esm/models/components/riskyieldcollectrequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldcollectrequest.js +0 -43
- package/dist/esm/models/components/riskyieldcollectrequest.js.map +0 -1
- package/dist/esm/models/components/riskyielddecreaserequest.d.ts +0 -103
- package/dist/esm/models/components/riskyielddecreaserequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyielddecreaserequest.js +0 -51
- package/dist/esm/models/components/riskyielddecreaserequest.js.map +0 -1
- package/dist/esm/models/components/riskyieldincreaserequest.d.ts +0 -93
- package/dist/esm/models/components/riskyieldincreaserequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldincreaserequest.js +0 -59
- package/dist/esm/models/components/riskyieldincreaserequest.js.map +0 -1
- package/dist/esm/models/components/riskyieldliquidityresponse.d.ts +0 -28
- package/dist/esm/models/components/riskyieldliquidityresponse.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldliquidityresponse.js +0 -37
- package/dist/esm/models/components/riskyieldliquidityresponse.js.map +0 -1
- package/dist/esm/models/components/riskyieldmintrequest.d.ts +0 -106
- package/dist/esm/models/components/riskyieldmintrequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldmintrequest.js +0 -77
- package/dist/esm/models/components/riskyieldmintrequest.js.map +0 -1
- package/dist/esm/models/components/riskyieldpositionsresponse.d.ts +0 -16
- package/dist/esm/models/components/riskyieldpositionsresponse.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldpositionsresponse.js +0 -27
- package/dist/esm/models/components/riskyieldpositionsresponse.js.map +0 -1
- package/dist/esm/models/components/riskyieldrebalancerequest.d.ts +0 -125
- package/dist/esm/models/components/riskyieldrebalancerequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldrebalancerequest.js +0 -59
- package/dist/esm/models/components/riskyieldrebalancerequest.js.map +0 -1
- package/dist/esm/models/components/riskyieldrebalanceresponse.d.ts +0 -34
- package/dist/esm/models/components/riskyieldrebalanceresponse.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldrebalanceresponse.js +0 -44
- package/dist/esm/models/components/riskyieldrebalanceresponse.js.map +0 -1
- package/dist/esm/models/components/riskyieldswaprequest.d.ts +0 -101
- package/dist/esm/models/components/riskyieldswaprequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldswaprequest.js +0 -50
- package/dist/esm/models/components/riskyieldswaprequest.js.map +0 -1
- package/dist/esm/models/components/riskyieldswapresponse.d.ts +0 -27
- package/dist/esm/models/components/riskyieldswapresponse.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldswapresponse.js +0 -21
- package/dist/esm/models/components/riskyieldswapresponse.js.map +0 -1
- package/dist/esm/models/components/riskyieldtransferrequest.d.ts +0 -95
- package/dist/esm/models/components/riskyieldtransferrequest.d.ts.map +0 -1
- package/dist/esm/models/components/riskyieldtransferrequest.js +0 -46
- package/dist/esm/models/components/riskyieldtransferrequest.js.map +0 -1
- package/dist/esm/models/components/scenarioinput.d.ts +0 -68
- package/dist/esm/models/components/scenarioinput.d.ts.map +0 -1
- package/dist/esm/models/components/scenarioinput.js +0 -37
- package/dist/esm/models/components/scenarioinput.js.map +0 -1
- package/dist/esm/models/components/scenarioresult.d.ts +0 -31
- package/dist/esm/models/components/scenarioresult.d.ts.map +0 -1
- package/dist/esm/models/components/scenarioresult.js +0 -41
- package/dist/esm/models/components/scenarioresult.js.map +0 -1
- package/dist/esm/models/components/simulation.d.ts +0 -21
- package/dist/esm/models/components/simulation.d.ts.map +0 -1
- package/dist/esm/models/components/simulation.js +0 -20
- package/dist/esm/models/components/simulation.js.map +0 -1
- package/dist/esm/models/components/singlesideddeposit.d.ts +0 -30
- package/dist/esm/models/components/singlesideddeposit.d.ts.map +0 -1
- package/dist/esm/models/components/singlesideddeposit.js +0 -19
- package/dist/esm/models/components/singlesideddeposit.js.map +0 -1
- package/dist/esm/models/components/stockmetadata.d.ts +0 -27
- package/dist/esm/models/components/stockmetadata.d.ts.map +0 -1
- package/dist/esm/models/components/stockmetadata.js +0 -30
- package/dist/esm/models/components/stockmetadata.js.map +0 -1
- package/dist/esm/models/components/stockreference.d.ts +0 -35
- package/dist/esm/models/components/stockreference.d.ts.map +0 -1
- package/dist/esm/models/components/stockreference.js +0 -29
- package/dist/esm/models/components/stockreference.js.map +0 -1
- package/dist/esm/models/components/swapplan.d.ts +0 -22
- package/dist/esm/models/components/swapplan.d.ts.map +0 -1
- package/dist/esm/models/components/swapplan.js +0 -30
- package/dist/esm/models/components/swapplan.js.map +0 -1
- package/dist/esm/models/components/symmetricrange.d.ts +0 -34
- package/dist/esm/models/components/symmetricrange.d.ts.map +0 -1
- package/dist/esm/models/components/symmetricrange.js +0 -23
- package/dist/esm/models/components/symmetricrange.js.map +0 -1
- package/dist/esm/models/components/tickrange.d.ts +0 -19
- package/dist/esm/models/components/tickrange.d.ts.map +0 -1
- package/dist/esm/models/components/tickrange.js +0 -20
- package/dist/esm/models/components/tickrange.js.map +0 -1
- package/dist/esm/models/components/usddeposit.d.ts +0 -28
- package/dist/esm/models/components/usddeposit.d.ts.map +0 -1
- package/dist/esm/models/components/usddeposit.js +0 -23
- package/dist/esm/models/components/usddeposit.js.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpools.d.ts +0 -111
- package/dist/esm/models/operations/v2riskyieldpools.d.ts.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpools.js +0 -74
- package/dist/esm/models/operations/v2riskyieldpools.js.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpoolspoolid.d.ts +0 -39
- package/dist/esm/models/operations/v2riskyieldpoolspoolid.d.ts.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpoolspoolid.js +0 -34
- package/dist/esm/models/operations/v2riskyieldpoolspoolid.js.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpositions.d.ts +0 -41
- package/dist/esm/models/operations/v2riskyieldpositions.d.ts.map +0 -1
- package/dist/esm/models/operations/v2riskyieldpositions.js +0 -27
- package/dist/esm/models/operations/v2riskyieldpositions.js.map +0 -1
- package/dist/esm/models/operations/v2riskyieldtokens.d.ts +0 -78
- package/dist/esm/models/operations/v2riskyieldtokens.d.ts.map +0 -1
- package/dist/esm/models/operations/v2riskyieldtokens.js +0 -56
- package/dist/esm/models/operations/v2riskyieldtokens.js.map +0 -1
- package/dist/esm/sdk/riskyield.d.ts +0 -230
- package/dist/esm/sdk/riskyield.d.ts.map +0 -1
- package/dist/esm/sdk/riskyield.js +0 -271
- package/dist/esm/sdk/riskyield.js.map +0 -1
- package/docs/models/components/amount0.md +0 -17
- package/docs/models/components/amount1.md +0 -17
- package/docs/models/components/baseusdmovepct.md +0 -19
- package/docs/models/components/bothsidesdeposit.md +0 -23
- package/docs/models/components/costbasis.md +0 -28
- package/docs/models/components/costbasissource.md +0 -15
- package/docs/models/components/createriskyieldaccountrequest.md +0 -23
- package/docs/models/components/createriskyieldaccountrequestchain.md +0 -17
- package/docs/models/components/createriskyieldaccountresponse.md +0 -29
- package/docs/models/components/depositplan.md +0 -34
- package/docs/models/components/dexpooldetailresponse.md +0 -59
- package/docs/models/components/dexpoolinfo.md +0 -73
- package/docs/models/components/dexpoolsresponse.md +0 -44
- package/docs/models/components/dextokeninfo.md +0 -37
- package/docs/models/components/dextokenkind.md +0 -15
- package/docs/models/components/dextokenref.md +0 -28
- package/docs/models/components/dextokensresponse.md +0 -24
- package/docs/models/components/dexversion.md +0 -21
- package/docs/models/components/feeaprpctoverride.md +0 -19
- package/docs/models/components/fullrange.md +0 -19
- package/docs/models/components/launchpad.md +0 -15
- package/docs/models/components/launchpadmetadata.md +0 -25
- package/docs/models/components/liquiditybucket.md +0 -31
- package/docs/models/components/lpposition.md +0 -82
- package/docs/models/components/pairclass.md +0 -17
- package/docs/models/components/percent.md +0 -19
- package/docs/models/components/planstep.md +0 -28
- package/docs/models/components/planstepkind.md +0 -15
- package/docs/models/components/poolhourlypoint.md +0 -27
- package/docs/models/components/poolonchainstate.md +0 -34
- package/docs/models/components/poolselector.md +0 -28
- package/docs/models/components/positionstatus.md +0 -15
- package/docs/models/components/pricelower.md +0 -17
- package/docs/models/components/pricerange.md +0 -23
- package/docs/models/components/pricesource.md +0 -21
- package/docs/models/components/priceupper.md +0 -17
- package/docs/models/components/probabilisticoutlook.md +0 -49
- package/docs/models/components/quoteusdmovepct.md +0 -19
- package/docs/models/components/ratiomovepct.md +0 -19
- package/docs/models/components/rebalancephase.md +0 -23
- package/docs/models/components/rebalancereason.md +0 -15
- package/docs/models/components/rebalancestrategy.md +0 -17
- package/docs/models/components/resolvedrange.md +0 -34
- package/docs/models/components/riskassumptions.md +0 -41
- package/docs/models/components/riskscenariosrequest.md +0 -55
- package/docs/models/components/riskscenariosrequestchain.md +0 -15
- package/docs/models/components/riskscenariosrequestdeposit.md +0 -34
- package/docs/models/components/riskscenariosrequestrange.md +0 -42
- package/docs/models/components/riskscenariosresponse.md +0 -39
- package/docs/models/components/riskyieldcollectrequestchain.md +0 -17
- package/docs/models/components/riskyieldcollectrequestslippagepct.md +0 -19
- package/docs/models/components/riskyielddecreaserequest.md +0 -32
- package/docs/models/components/riskyielddecreaserequestchain.md +0 -17
- package/docs/models/components/riskyielddecreaserequestslippagepct.md +0 -19
- package/docs/models/components/riskyieldincreaserequest.md +0 -34
- package/docs/models/components/riskyieldincreaserequestchain.md +0 -17
- package/docs/models/components/riskyieldincreaserequestdeposit.md +0 -34
- package/docs/models/components/riskyieldincreaserequestslippagepct.md +0 -19
- package/docs/models/components/riskyieldliquidityresponse.md +0 -36
- package/docs/models/components/riskyieldmintrequest.md +0 -41
- package/docs/models/components/riskyieldmintrequestchain.md +0 -17
- package/docs/models/components/riskyieldmintrequestdeposit.md +0 -34
- package/docs/models/components/riskyieldmintrequestrange.md +0 -42
- package/docs/models/components/riskyieldmintrequestslippagepct.md +0 -19
- package/docs/models/components/riskyieldpositionsresponse.md +0 -59
- package/docs/models/components/riskyieldrebalancerequest.md +0 -40
- package/docs/models/components/riskyieldrebalancerequestchain.md +0 -17
- package/docs/models/components/riskyieldrebalancerequestslippagepct.md +0 -19
- package/docs/models/components/riskyieldrebalancerequestwidthpct.md +0 -19
- package/docs/models/components/riskyieldrebalanceresponse.md +0 -32
- package/docs/models/components/riskyieldswaprequest.md +0 -37
- package/docs/models/components/riskyieldswaprequestamountin.md +0 -19
- package/docs/models/components/riskyieldswaprequestchain.md +0 -17
- package/docs/models/components/riskyieldswaprequestslippagepct.md +0 -19
- package/docs/models/components/riskyieldswapresponse.md +0 -19
- package/docs/models/components/riskyieldtransferrequestaction.md +0 -17
- package/docs/models/components/riskyieldtransferrequestamount.md +0 -19
- package/docs/models/components/riskyieldtransferrequestchain.md +0 -17
- package/docs/models/components/scenarioinput.md +0 -28
- package/docs/models/components/scenarioresult.md +0 -39
- package/docs/models/components/simulation.md +0 -25
- package/docs/models/components/singlesideddeposit.md +0 -26
- package/docs/models/components/singlesideddepositamount.md +0 -17
- package/docs/models/components/stockmetadata.md +0 -31
- package/docs/models/components/stockreference.md +0 -31
- package/docs/models/components/swapplan.md +0 -29
- package/docs/models/components/symmetricrange.md +0 -24
- package/docs/models/components/symmetricrangewidthpct.md +0 -19
- package/docs/models/components/tickrange.md +0 -23
- package/docs/models/components/usddeposit.md +0 -24
- package/docs/models/components/valueusd.md +0 -17
- package/docs/models/components/voloverridepct.md +0 -19
- package/docs/models/operations/minvolume24husd.md +0 -17
- package/docs/models/operations/poolhistory.md +0 -15
- package/docs/models/operations/poolorderby.md +0 -15
- package/docs/models/operations/tokenorderby.md +0 -15
- package/docs/models/operations/v2riskyieldpoolschain.md +0 -15
- package/docs/models/operations/v2riskyieldpoolsdirection.md +0 -15
- package/docs/models/operations/v2riskyieldpoolsmintvlusd.md +0 -17
- package/docs/models/operations/v2riskyieldpoolspoolidchain.md +0 -15
- package/docs/models/operations/v2riskyieldpoolspoolidrequest.md +0 -23
- package/docs/models/operations/v2riskyieldpoolsrequest.md +0 -37
- package/docs/models/operations/v2riskyieldpositionschain.md +0 -15
- package/docs/models/operations/v2riskyieldpositionsrequest.md +0 -22
- package/docs/models/operations/v2riskyieldtokenschain.md +0 -15
- package/docs/models/operations/v2riskyieldtokensdirection.md +0 -15
- package/docs/models/operations/v2riskyieldtokensminliquidityusd.md +0 -17
- package/docs/models/operations/v2riskyieldtokensrequest.md +0 -31
- package/docs/sdks/riskyield/README.md +0 -1272
- package/src/funcs/riskYieldRiskYieldCollect.ts +0 -171
- package/src/funcs/riskYieldRiskYieldCreateAccount.ts +0 -181
- package/src/funcs/riskYieldRiskYieldDecrease.ts +0 -176
- package/src/funcs/riskYieldRiskYieldMint.ts +0 -183
- package/src/funcs/riskYieldRiskYieldPools.ts +0 -204
- package/src/funcs/riskYieldRiskYieldPoolsPoolId.ts +0 -190
- package/src/funcs/riskYieldRiskYieldPositions.ts +0 -195
- package/src/funcs/riskYieldRiskYieldRebalance.ts +0 -190
- package/src/funcs/riskYieldRiskYieldRiskScenarios.ts +0 -195
- package/src/funcs/riskYieldRiskYieldSwap.ts +0 -185
- package/src/funcs/riskYieldRiskYieldTokens.ts +0 -195
- package/src/funcs/riskYieldRiskYieldTransfer.ts +0 -178
- package/src/models/components/bothsidesdeposit.ts +0 -72
- package/src/models/components/costbasis.ts +0 -61
- package/src/models/components/costbasissource.ts +0 -18
- package/src/models/components/createriskyieldaccountrequest.ts +0 -81
- package/src/models/components/createriskyieldaccountresponse.ts +0 -48
- package/src/models/components/depositplan.ts +0 -67
- package/src/models/components/dexpooldetailresponse.ts +0 -68
- package/src/models/components/dexpoolinfo.ts +0 -213
- package/src/models/components/dexpoolsresponse.ts +0 -38
- package/src/models/components/dextokeninfo.ts +0 -101
- package/src/models/components/dextokenkind.ts +0 -24
- package/src/models/components/dextokenref.ts +0 -66
- package/src/models/components/dextokensresponse.ts +0 -50
- package/src/models/components/dexversion.ts +0 -37
- package/src/models/components/fullrange.ts +0 -30
- package/src/models/components/launchpad.ts +0 -21
- package/src/models/components/launchpadmetadata.ts +0 -57
- package/src/models/components/liquiditybucket.ts +0 -62
- package/src/models/components/lpposition.ts +0 -191
- package/src/models/components/pairclass.ts +0 -31
- package/src/models/components/planstep.ts +0 -48
- package/src/models/components/planstepkind.ts +0 -23
- package/src/models/components/poolhourlypoint.ts +0 -62
- package/src/models/components/poolonchainstate.ts +0 -68
- package/src/models/components/poolselector.ts +0 -91
- package/src/models/components/positionstatus.ts +0 -19
- package/src/models/components/pricerange.ts +0 -74
- package/src/models/components/pricesource.ts +0 -37
- package/src/models/components/probabilisticoutlook.ts +0 -70
- package/src/models/components/rebalancephase.ts +0 -39
- package/src/models/components/rebalancereason.ts +0 -21
- package/src/models/components/rebalancestrategy.ts +0 -24
- package/src/models/components/resolvedrange.ts +0 -65
- package/src/models/components/riskassumptions.ts +0 -91
- package/src/models/components/riskscenariosrequest.ts +0 -279
- package/src/models/components/riskscenariosresponse.ts +0 -78
- package/src/models/components/riskyieldcollectrequest.ts +0 -139
- package/src/models/components/riskyielddecreaserequest.ts +0 -174
- package/src/models/components/riskyieldincreaserequest.ts +0 -196
- package/src/models/components/riskyieldliquidityresponse.ts +0 -71
- package/src/models/components/riskyieldmintrequest.ts +0 -264
- package/src/models/components/riskyieldpositionsresponse.ts +0 -52
- package/src/models/components/riskyieldrebalancerequest.ts +0 -212
- package/src/models/components/riskyieldrebalanceresponse.ts +0 -88
- package/src/models/components/riskyieldswaprequest.ts +0 -178
- package/src/models/components/riskyieldswapresponse.ts +0 -55
- package/src/models/components/riskyieldtransferrequest.ts +0 -154
- package/src/models/components/scenarioinput.ts +0 -125
- package/src/models/components/scenarioresult.ts +0 -80
- package/src/models/components/simulation.ts +0 -49
- package/src/models/components/singlesideddeposit.ts +0 -65
- package/src/models/components/stockmetadata.ts +0 -67
- package/src/models/components/stockreference.ts +0 -74
- package/src/models/components/swapplan.ts +0 -60
- package/src/models/components/symmetricrange.ts +0 -69
- package/src/models/components/tickrange.ts +0 -42
- package/src/models/components/usddeposit.ts +0 -59
- package/src/models/operations/v2riskyieldpools.ts +0 -195
- package/src/models/operations/v2riskyieldpoolspoolid.ts +0 -78
- package/src/models/operations/v2riskyieldpositions.ts +0 -77
- package/src/models/operations/v2riskyieldtokens.ts +0 -144
- package/src/sdk/riskyield.ts +0 -377
|
@@ -1,1272 +0,0 @@
|
|
|
1
|
-
# RiskYield
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
### Available Operations
|
|
6
|
-
|
|
7
|
-
* [riskYieldTokens](#riskyieldtokens) - List tokens
|
|
8
|
-
* [riskYieldPools](#riskyieldpools) - List pools
|
|
9
|
-
* [riskYieldPoolsPoolId](#riskyieldpoolspoolid) - Get pool detail
|
|
10
|
-
* [riskYieldPositions](#riskyieldpositions) - List LP positions
|
|
11
|
-
* [riskYieldRiskScenarios](#riskyieldriskscenarios) - Model impermanent loss
|
|
12
|
-
* [riskYieldCreateAccount](#riskyieldcreateaccount) - Create account
|
|
13
|
-
* [riskYieldTransfer](#riskyieldtransfer) - Transfer tokens to/from account
|
|
14
|
-
* [riskYieldSwap](#riskyieldswap) - Swap tokens
|
|
15
|
-
* [riskYieldMint](#riskyieldmint) - Open a position
|
|
16
|
-
* [riskYieldIncrease](#riskyieldincrease) - Add to a position
|
|
17
|
-
* [riskYieldDecrease](#riskyielddecrease) - Withdraw from a position
|
|
18
|
-
* [riskYieldCollect](#riskyieldcollect) - Collect fees
|
|
19
|
-
* [riskYieldRebalance](#riskyieldrebalance) - Rebalance a position
|
|
20
|
-
|
|
21
|
-
## riskYieldTokens
|
|
22
|
-
|
|
23
|
-
The assets that trade on Robinhood Chain.
|
|
24
|
-
|
|
25
|
-
Tokenized stocks carry their issuer metadata, including the corporate-action
|
|
26
|
-
multiplier — balances do not rebase on a split, so a quote for the
|
|
27
|
-
underlying only becomes a token price once that is applied.
|
|
28
|
-
|
|
29
|
-
Memecoins carry the launch they came from. Every price carries the source it
|
|
30
|
-
was resolved from and a confidence: below 0.6 it came from a pool shallow
|
|
31
|
-
enough that one trade moves it, and every dollar figure derived from it is
|
|
32
|
-
indicative.
|
|
33
|
-
|
|
34
|
-
### Example Usage
|
|
35
|
-
|
|
36
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_tokens" method="get" path="/v2/risk_yield/tokens" -->
|
|
37
|
-
```typescript
|
|
38
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
39
|
-
|
|
40
|
-
const compassApiSDK = new CompassApiSDK({
|
|
41
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
async function run() {
|
|
45
|
-
const result = await compassApiSDK.riskYield.riskYieldTokens({
|
|
46
|
-
offset: 0,
|
|
47
|
-
limit: 20,
|
|
48
|
-
chain: "robinhood",
|
|
49
|
-
kind: "STOCK",
|
|
50
|
-
orderBy: "liquidity_usd",
|
|
51
|
-
});
|
|
52
|
-
|
|
53
|
-
console.log(result);
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
run();
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Standalone function
|
|
60
|
-
|
|
61
|
-
The standalone function version of this method:
|
|
62
|
-
|
|
63
|
-
```typescript
|
|
64
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
65
|
-
import { riskYieldRiskYieldTokens } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldTokens.js";
|
|
66
|
-
|
|
67
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
68
|
-
// You can create one instance of it to use across an application.
|
|
69
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
70
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
71
|
-
});
|
|
72
|
-
|
|
73
|
-
async function run() {
|
|
74
|
-
const res = await riskYieldRiskYieldTokens(compassApiSDK, {
|
|
75
|
-
offset: 0,
|
|
76
|
-
limit: 20,
|
|
77
|
-
chain: "robinhood",
|
|
78
|
-
kind: "STOCK",
|
|
79
|
-
orderBy: "liquidity_usd",
|
|
80
|
-
});
|
|
81
|
-
if (res.ok) {
|
|
82
|
-
const { value: result } = res;
|
|
83
|
-
console.log(result);
|
|
84
|
-
} else {
|
|
85
|
-
console.log("riskYieldRiskYieldTokens failed:", res.error);
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
run();
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Parameters
|
|
93
|
-
|
|
94
|
-
| Parameter | Type | Required | Description |
|
|
95
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
96
|
-
| `request` | [operations.V2RiskYieldTokensRequest](../../models/operations/v2riskyieldtokensrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
97
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
98
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
99
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
100
|
-
|
|
101
|
-
### Response
|
|
102
|
-
|
|
103
|
-
**Promise\<[components.DexTokensResponse](../../models/components/dextokensresponse.md)\>**
|
|
104
|
-
|
|
105
|
-
### Errors
|
|
106
|
-
|
|
107
|
-
| Error Type | Status Code | Content Type |
|
|
108
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
109
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
110
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
111
|
-
|
|
112
|
-
## riskYieldPools
|
|
113
|
-
|
|
114
|
-
Pools you could provide liquidity to, ranked by what you would keep.
|
|
115
|
-
|
|
116
|
-
**Read `lp_earns_fees` first.** The launchpad that dominates this chain
|
|
117
|
-
graduates tokens into pools whose hook takes the swap fee, so they trade
|
|
118
|
-
enormously and pay an external liquidity provider nothing. Those pools are
|
|
119
|
-
listed — they carry the memecoin's price and volume — with a fee APR of
|
|
120
|
-
exactly zero and a note saying why. Pass `lp_earns_fees=true` to hide them.
|
|
121
|
-
|
|
122
|
-
The default ordering is `il_adjusted_apr_7d`: the fee APR less the expected
|
|
123
|
-
impermanent-loss drag from the pair's own volatility. A pool paying 200% on
|
|
124
|
-
an asset that moves 400% is not a better position than one paying 20% on an
|
|
125
|
-
asset that moves 30%, and sorting on the raw APR would say it was.
|
|
126
|
-
|
|
127
|
-
Pools too thin for a rate to mean anything — under 20 swaps a day, or under
|
|
128
|
-
$1,000 of liquidity — are served with `ranked: false` and always sort last.
|
|
129
|
-
|
|
130
|
-
### Example Usage
|
|
131
|
-
|
|
132
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_pools" method="get" path="/v2/risk_yield/pools" -->
|
|
133
|
-
```typescript
|
|
134
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
135
|
-
|
|
136
|
-
const compassApiSDK = new CompassApiSDK({
|
|
137
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
async function run() {
|
|
141
|
-
const result = await compassApiSDK.riskYield.riskYieldPools({
|
|
142
|
-
offset: 0,
|
|
143
|
-
limit: 20,
|
|
144
|
-
chain: "robinhood",
|
|
145
|
-
pairClass: "MEME_STOCK",
|
|
146
|
-
lpEarnsFees: true,
|
|
147
|
-
lpOpen: true,
|
|
148
|
-
orderBy: "il_adjusted_apr_7d",
|
|
149
|
-
});
|
|
150
|
-
|
|
151
|
-
console.log(result);
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
run();
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
### Standalone function
|
|
158
|
-
|
|
159
|
-
The standalone function version of this method:
|
|
160
|
-
|
|
161
|
-
```typescript
|
|
162
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
163
|
-
import { riskYieldRiskYieldPools } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldPools.js";
|
|
164
|
-
|
|
165
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
166
|
-
// You can create one instance of it to use across an application.
|
|
167
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
168
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
169
|
-
});
|
|
170
|
-
|
|
171
|
-
async function run() {
|
|
172
|
-
const res = await riskYieldRiskYieldPools(compassApiSDK, {
|
|
173
|
-
offset: 0,
|
|
174
|
-
limit: 20,
|
|
175
|
-
chain: "robinhood",
|
|
176
|
-
pairClass: "MEME_STOCK",
|
|
177
|
-
lpEarnsFees: true,
|
|
178
|
-
lpOpen: true,
|
|
179
|
-
orderBy: "il_adjusted_apr_7d",
|
|
180
|
-
});
|
|
181
|
-
if (res.ok) {
|
|
182
|
-
const { value: result } = res;
|
|
183
|
-
console.log(result);
|
|
184
|
-
} else {
|
|
185
|
-
console.log("riskYieldRiskYieldPools failed:", res.error);
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
run();
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
### Parameters
|
|
193
|
-
|
|
194
|
-
| Parameter | Type | Required | Description |
|
|
195
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
196
|
-
| `request` | [operations.V2RiskYieldPoolsRequest](../../models/operations/v2riskyieldpoolsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
197
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
198
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
199
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
200
|
-
|
|
201
|
-
### Response
|
|
202
|
-
|
|
203
|
-
**Promise\<[components.DexPoolsResponse](../../models/components/dexpoolsresponse.md)\>**
|
|
204
|
-
|
|
205
|
-
### Errors
|
|
206
|
-
|
|
207
|
-
| Error Type | Status Code | Content Type |
|
|
208
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
209
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
210
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
211
|
-
|
|
212
|
-
## riskYieldPoolsPoolId
|
|
213
|
-
|
|
214
|
-
One pool, with its price history and the caveats that apply to it.
|
|
215
|
-
|
|
216
|
-
For a pool holding a tokenized stock, `stock_reference` compares the pool's
|
|
217
|
-
price against the stock's own. They drift: the pool trades around the clock
|
|
218
|
-
while the stock trades in a session, and that gap is what a liquidity
|
|
219
|
-
provider is quoting against overnight.
|
|
220
|
-
|
|
221
|
-
### Example Usage
|
|
222
|
-
|
|
223
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_pools_{pool_id}" method="get" path="/v2/risk_yield/pools/{pool_id}" -->
|
|
224
|
-
```typescript
|
|
225
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
226
|
-
|
|
227
|
-
const compassApiSDK = new CompassApiSDK({
|
|
228
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
229
|
-
});
|
|
230
|
-
|
|
231
|
-
async function run() {
|
|
232
|
-
const result = await compassApiSDK.riskYield.riskYieldPoolsPoolId({
|
|
233
|
-
poolId: 174842,
|
|
234
|
-
chain: "robinhood",
|
|
235
|
-
depthWords: 4,
|
|
236
|
-
history: "7d",
|
|
237
|
-
});
|
|
238
|
-
|
|
239
|
-
console.log(result);
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
run();
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
### Standalone function
|
|
246
|
-
|
|
247
|
-
The standalone function version of this method:
|
|
248
|
-
|
|
249
|
-
```typescript
|
|
250
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
251
|
-
import { riskYieldRiskYieldPoolsPoolId } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldPoolsPoolId.js";
|
|
252
|
-
|
|
253
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
254
|
-
// You can create one instance of it to use across an application.
|
|
255
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
256
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
257
|
-
});
|
|
258
|
-
|
|
259
|
-
async function run() {
|
|
260
|
-
const res = await riskYieldRiskYieldPoolsPoolId(compassApiSDK, {
|
|
261
|
-
poolId: 174842,
|
|
262
|
-
chain: "robinhood",
|
|
263
|
-
depthWords: 4,
|
|
264
|
-
history: "7d",
|
|
265
|
-
});
|
|
266
|
-
if (res.ok) {
|
|
267
|
-
const { value: result } = res;
|
|
268
|
-
console.log(result);
|
|
269
|
-
} else {
|
|
270
|
-
console.log("riskYieldRiskYieldPoolsPoolId failed:", res.error);
|
|
271
|
-
}
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
run();
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### Parameters
|
|
278
|
-
|
|
279
|
-
| Parameter | Type | Required | Description |
|
|
280
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
281
|
-
| `request` | [operations.V2RiskYieldPoolsPoolIdRequest](../../models/operations/v2riskyieldpoolspoolidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
282
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
283
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
284
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
285
|
-
|
|
286
|
-
### Response
|
|
287
|
-
|
|
288
|
-
**Promise\<[components.DexPoolDetailResponse](../../models/components/dexpooldetailresponse.md)\>**
|
|
289
|
-
|
|
290
|
-
### Errors
|
|
291
|
-
|
|
292
|
-
| Error Type | Status Code | Content Type |
|
|
293
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
294
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
295
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
296
|
-
|
|
297
|
-
## riskYieldPositions
|
|
298
|
-
|
|
299
|
-
Your liquidity positions: what they hold, what they cost, what they paid.
|
|
300
|
-
|
|
301
|
-
Only the first of those is on chain. A position reports its liquidity and
|
|
302
|
-
its range; it does not report the amounts that opened it or what has already
|
|
303
|
-
been collected. Those come from recorded events, and where there are none
|
|
304
|
-
`cost_basis.source` is `unavailable` and the PnL fields are null rather than
|
|
305
|
-
guessed — an invented cost basis would make every number derived from it
|
|
306
|
-
wrong in the same direction.
|
|
307
|
-
|
|
308
|
-
`hold_value_usd` is what the deposited amounts would be worth if they had
|
|
309
|
-
simply been held. The gap between that and `value_usd` is impermanent loss,
|
|
310
|
-
and it is the number that decides whether the fees were worth it.
|
|
311
|
-
|
|
312
|
-
`needs_rebalance` and `rebalance_reasons` say what the API would look at, not
|
|
313
|
-
what it will do: rebalancing realizes the loss, pays gas twice and a swap,
|
|
314
|
-
and puts the position back at risk from a new price.
|
|
315
|
-
|
|
316
|
-
### Example Usage
|
|
317
|
-
|
|
318
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_positions" method="get" path="/v2/risk_yield/positions" -->
|
|
319
|
-
```typescript
|
|
320
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
321
|
-
|
|
322
|
-
const compassApiSDK = new CompassApiSDK({
|
|
323
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
324
|
-
});
|
|
325
|
-
|
|
326
|
-
async function run() {
|
|
327
|
-
const result = await compassApiSDK.riskYield.riskYieldPositions({
|
|
328
|
-
chain: "robinhood",
|
|
329
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
330
|
-
includeClosed: false,
|
|
331
|
-
});
|
|
332
|
-
|
|
333
|
-
console.log(result);
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
run();
|
|
337
|
-
```
|
|
338
|
-
|
|
339
|
-
### Standalone function
|
|
340
|
-
|
|
341
|
-
The standalone function version of this method:
|
|
342
|
-
|
|
343
|
-
```typescript
|
|
344
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
345
|
-
import { riskYieldRiskYieldPositions } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldPositions.js";
|
|
346
|
-
|
|
347
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
348
|
-
// You can create one instance of it to use across an application.
|
|
349
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
350
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
351
|
-
});
|
|
352
|
-
|
|
353
|
-
async function run() {
|
|
354
|
-
const res = await riskYieldRiskYieldPositions(compassApiSDK, {
|
|
355
|
-
chain: "robinhood",
|
|
356
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
357
|
-
includeClosed: false,
|
|
358
|
-
});
|
|
359
|
-
if (res.ok) {
|
|
360
|
-
const { value: result } = res;
|
|
361
|
-
console.log(result);
|
|
362
|
-
} else {
|
|
363
|
-
console.log("riskYieldRiskYieldPositions failed:", res.error);
|
|
364
|
-
}
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
run();
|
|
368
|
-
```
|
|
369
|
-
|
|
370
|
-
### Parameters
|
|
371
|
-
|
|
372
|
-
| Parameter | Type | Required | Description |
|
|
373
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
374
|
-
| `request` | [operations.V2RiskYieldPositionsRequest](../../models/operations/v2riskyieldpositionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
375
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
376
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
377
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
378
|
-
|
|
379
|
-
### Response
|
|
380
|
-
|
|
381
|
-
**Promise\<[components.RiskYieldPositionsResponse](../../models/components/riskyieldpositionsresponse.md)\>**
|
|
382
|
-
|
|
383
|
-
### Errors
|
|
384
|
-
|
|
385
|
-
| Error Type | Status Code | Content Type |
|
|
386
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
387
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
388
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
389
|
-
|
|
390
|
-
## riskYieldRiskScenarios
|
|
391
|
-
|
|
392
|
-
What this position would do if the price moved — and how likely that is.
|
|
393
|
-
|
|
394
|
-
A fee APR on a memecoin pair means nothing without the loss it is paid
|
|
395
|
-
against, which is what this measures.
|
|
396
|
-
|
|
397
|
-
Each scenario takes **two** independent moves, and keeping them apart is the
|
|
398
|
-
point. `ratio_move_pct` is how far the pair's ratio travels, and that is
|
|
399
|
-
what causes impermanent loss. `quote_usd_move_pct` is how far the stock
|
|
400
|
-
moves in dollars, which scales what the position is worth without touching
|
|
401
|
-
the ratio at all — a stock-only move produces an impermanent loss of exactly
|
|
402
|
-
zero. "NVDA drops 10%" and "the memecoin drops 10% against NVDA" are
|
|
403
|
-
different questions, and one number cannot ask both.
|
|
404
|
-
|
|
405
|
-
The two most useful columns are `breakeven_fee_apr_pct` — what this position
|
|
406
|
-
would have to earn for the loss to be worth taking, which you can compare
|
|
407
|
-
against the pool's actual fee APR — and `days_of_fees_to_recover_il`, which
|
|
408
|
-
is null when the pool pays liquidity providers nothing, because no amount of
|
|
409
|
-
time fixes that.
|
|
410
|
-
|
|
411
|
-
`probabilistic` runs the pair's own measured volatility through a driftless
|
|
412
|
-
simulation. Driftless deliberately: nobody knows which way a memecoin goes,
|
|
413
|
-
and a model that assumed one would be predicting returns rather than
|
|
414
|
-
measuring risk. It is absent when the pair has no measured volatility —
|
|
415
|
-
which a pool with a few hours of history does not — because a distribution
|
|
416
|
-
built on zero would report that nothing can happen.
|
|
417
|
-
|
|
418
|
-
### Example Usage
|
|
419
|
-
|
|
420
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_risk_scenarios" method="post" path="/v2/risk_yield/risk/scenarios" -->
|
|
421
|
-
```typescript
|
|
422
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
423
|
-
|
|
424
|
-
const compassApiSDK = new CompassApiSDK({
|
|
425
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
426
|
-
});
|
|
427
|
-
|
|
428
|
-
async function run() {
|
|
429
|
-
const result = await compassApiSDK.riskYield.riskYieldRiskScenarios({
|
|
430
|
-
chain: "robinhood",
|
|
431
|
-
pool: {
|
|
432
|
-
poolId: 1,
|
|
433
|
-
},
|
|
434
|
-
range: {
|
|
435
|
-
type: "symmetric_pct",
|
|
436
|
-
widthPct: "30",
|
|
437
|
-
},
|
|
438
|
-
deposit: {
|
|
439
|
-
type: "usd",
|
|
440
|
-
valueUsd: "1000",
|
|
441
|
-
},
|
|
442
|
-
horizonDays: 30,
|
|
443
|
-
scenarios: [
|
|
444
|
-
{
|
|
445
|
-
name: "meme halves",
|
|
446
|
-
ratioMovePct: "-50",
|
|
447
|
-
},
|
|
448
|
-
{
|
|
449
|
-
name: "meme doubles",
|
|
450
|
-
ratioMovePct: "100",
|
|
451
|
-
},
|
|
452
|
-
{
|
|
453
|
-
name: "stock falls 10%",
|
|
454
|
-
quoteUsdMovePct: "-10",
|
|
455
|
-
},
|
|
456
|
-
],
|
|
457
|
-
});
|
|
458
|
-
|
|
459
|
-
console.log(result);
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
run();
|
|
463
|
-
```
|
|
464
|
-
|
|
465
|
-
### Standalone function
|
|
466
|
-
|
|
467
|
-
The standalone function version of this method:
|
|
468
|
-
|
|
469
|
-
```typescript
|
|
470
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
471
|
-
import { riskYieldRiskYieldRiskScenarios } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldRiskScenarios.js";
|
|
472
|
-
|
|
473
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
474
|
-
// You can create one instance of it to use across an application.
|
|
475
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
476
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
477
|
-
});
|
|
478
|
-
|
|
479
|
-
async function run() {
|
|
480
|
-
const res = await riskYieldRiskYieldRiskScenarios(compassApiSDK, {
|
|
481
|
-
chain: "robinhood",
|
|
482
|
-
pool: {
|
|
483
|
-
poolId: 1,
|
|
484
|
-
},
|
|
485
|
-
range: {
|
|
486
|
-
type: "symmetric_pct",
|
|
487
|
-
widthPct: "30",
|
|
488
|
-
},
|
|
489
|
-
deposit: {
|
|
490
|
-
type: "usd",
|
|
491
|
-
valueUsd: "1000",
|
|
492
|
-
},
|
|
493
|
-
horizonDays: 30,
|
|
494
|
-
scenarios: [
|
|
495
|
-
{
|
|
496
|
-
name: "meme halves",
|
|
497
|
-
ratioMovePct: "-50",
|
|
498
|
-
},
|
|
499
|
-
{
|
|
500
|
-
name: "meme doubles",
|
|
501
|
-
ratioMovePct: "100",
|
|
502
|
-
},
|
|
503
|
-
{
|
|
504
|
-
name: "stock falls 10%",
|
|
505
|
-
quoteUsdMovePct: "-10",
|
|
506
|
-
},
|
|
507
|
-
],
|
|
508
|
-
});
|
|
509
|
-
if (res.ok) {
|
|
510
|
-
const { value: result } = res;
|
|
511
|
-
console.log(result);
|
|
512
|
-
} else {
|
|
513
|
-
console.log("riskYieldRiskYieldRiskScenarios failed:", res.error);
|
|
514
|
-
}
|
|
515
|
-
}
|
|
516
|
-
|
|
517
|
-
run();
|
|
518
|
-
```
|
|
519
|
-
|
|
520
|
-
### Parameters
|
|
521
|
-
|
|
522
|
-
| Parameter | Type | Required | Description |
|
|
523
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
524
|
-
| `request` | [components.RiskScenariosRequest](../../models/components/riskscenariosrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
525
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
526
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
527
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
528
|
-
|
|
529
|
-
### Response
|
|
530
|
-
|
|
531
|
-
**Promise\<[components.RiskScenariosResponse](../../models/components/riskscenariosresponse.md)\>**
|
|
532
|
-
|
|
533
|
-
### Errors
|
|
534
|
-
|
|
535
|
-
| Error Type | Status Code | Content Type |
|
|
536
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
537
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
538
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
539
|
-
|
|
540
|
-
## riskYieldCreateAccount
|
|
541
|
-
|
|
542
|
-
Create the Risk Yield Account that will hold your LP positions.
|
|
543
|
-
|
|
544
|
-
Liquidity is provided from an account, not from your wallet, so this comes
|
|
545
|
-
first. The address is deterministic from the `owner`, and it is the **same
|
|
546
|
-
account as your Earn Account** on this chain — if you already have one,
|
|
547
|
-
this returns it with `transaction: null` and nothing needs to be signed.
|
|
548
|
-
|
|
549
|
-
**If the owner pays gas:** set `sender` to the owner's address.
|
|
550
|
-
|
|
551
|
-
**If someone else pays:** set `sender` to whoever will broadcast.
|
|
552
|
-
|
|
553
|
-
### Example Usage
|
|
554
|
-
|
|
555
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_create_account" method="post" path="/v2/risk_yield/create_account" -->
|
|
556
|
-
```typescript
|
|
557
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
558
|
-
|
|
559
|
-
const compassApiSDK = new CompassApiSDK({
|
|
560
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
561
|
-
});
|
|
562
|
-
|
|
563
|
-
async function run() {
|
|
564
|
-
const result = await compassApiSDK.riskYield.riskYieldCreateAccount({
|
|
565
|
-
sender: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
|
|
566
|
-
owner: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
|
|
567
|
-
});
|
|
568
|
-
|
|
569
|
-
console.log(result);
|
|
570
|
-
}
|
|
571
|
-
|
|
572
|
-
run();
|
|
573
|
-
```
|
|
574
|
-
|
|
575
|
-
### Standalone function
|
|
576
|
-
|
|
577
|
-
The standalone function version of this method:
|
|
578
|
-
|
|
579
|
-
```typescript
|
|
580
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
581
|
-
import { riskYieldRiskYieldCreateAccount } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldCreateAccount.js";
|
|
582
|
-
|
|
583
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
584
|
-
// You can create one instance of it to use across an application.
|
|
585
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
586
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
587
|
-
});
|
|
588
|
-
|
|
589
|
-
async function run() {
|
|
590
|
-
const res = await riskYieldRiskYieldCreateAccount(compassApiSDK, {
|
|
591
|
-
sender: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
|
|
592
|
-
owner: "0xdB035cb494EEE30996fbDD25a7b1Fa38D795bdC6",
|
|
593
|
-
});
|
|
594
|
-
if (res.ok) {
|
|
595
|
-
const { value: result } = res;
|
|
596
|
-
console.log(result);
|
|
597
|
-
} else {
|
|
598
|
-
console.log("riskYieldRiskYieldCreateAccount failed:", res.error);
|
|
599
|
-
}
|
|
600
|
-
}
|
|
601
|
-
|
|
602
|
-
run();
|
|
603
|
-
```
|
|
604
|
-
|
|
605
|
-
### Parameters
|
|
606
|
-
|
|
607
|
-
| Parameter | Type | Required | Description |
|
|
608
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
609
|
-
| `request` | [components.CreateRiskYieldAccountRequest](../../models/components/createriskyieldaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
610
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
611
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
612
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
613
|
-
|
|
614
|
-
### Response
|
|
615
|
-
|
|
616
|
-
**Promise\<[components.CreateRiskYieldAccountResponse](../../models/components/createriskyieldaccountresponse.md)\>**
|
|
617
|
-
|
|
618
|
-
### Errors
|
|
619
|
-
|
|
620
|
-
| Error Type | Status Code | Content Type |
|
|
621
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
622
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
623
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
624
|
-
|
|
625
|
-
## riskYieldTransfer
|
|
626
|
-
|
|
627
|
-
Move tokens between your wallet and your Risk Yield Account.
|
|
628
|
-
|
|
629
|
-
`DEPOSIT` pulls from the owner's wallet into the account; `WITHDRAW` sends
|
|
630
|
-
them back. Native ETH is supported, which matters here because many pools on
|
|
631
|
-
this chain are quoted in it.
|
|
632
|
-
|
|
633
|
-
The account is shared with Earn, so a deposit made through either product is
|
|
634
|
-
available to both.
|
|
635
|
-
|
|
636
|
-
### Example Usage
|
|
637
|
-
|
|
638
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_transfer" method="post" path="/v2/risk_yield/transfer" -->
|
|
639
|
-
```typescript
|
|
640
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
641
|
-
|
|
642
|
-
const compassApiSDK = new CompassApiSDK({
|
|
643
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
644
|
-
});
|
|
645
|
-
|
|
646
|
-
async function run() {
|
|
647
|
-
const result = await compassApiSDK.riskYield.riskYieldTransfer({
|
|
648
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
649
|
-
chain: "robinhood",
|
|
650
|
-
token: "USDG",
|
|
651
|
-
amount: "10",
|
|
652
|
-
action: "DEPOSIT",
|
|
653
|
-
});
|
|
654
|
-
|
|
655
|
-
console.log(result);
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
run();
|
|
659
|
-
```
|
|
660
|
-
|
|
661
|
-
### Standalone function
|
|
662
|
-
|
|
663
|
-
The standalone function version of this method:
|
|
664
|
-
|
|
665
|
-
```typescript
|
|
666
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
667
|
-
import { riskYieldRiskYieldTransfer } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldTransfer.js";
|
|
668
|
-
|
|
669
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
670
|
-
// You can create one instance of it to use across an application.
|
|
671
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
672
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
673
|
-
});
|
|
674
|
-
|
|
675
|
-
async function run() {
|
|
676
|
-
const res = await riskYieldRiskYieldTransfer(compassApiSDK, {
|
|
677
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
678
|
-
chain: "robinhood",
|
|
679
|
-
token: "USDG",
|
|
680
|
-
amount: "10",
|
|
681
|
-
action: "DEPOSIT",
|
|
682
|
-
});
|
|
683
|
-
if (res.ok) {
|
|
684
|
-
const { value: result } = res;
|
|
685
|
-
console.log(result);
|
|
686
|
-
} else {
|
|
687
|
-
console.log("riskYieldRiskYieldTransfer failed:", res.error);
|
|
688
|
-
}
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
run();
|
|
692
|
-
```
|
|
693
|
-
|
|
694
|
-
### Parameters
|
|
695
|
-
|
|
696
|
-
| Parameter | Type | Required | Description |
|
|
697
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
698
|
-
| `request` | [components.RiskYieldTransferRequest](../../models/components/riskyieldtransferrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
699
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
700
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
701
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
702
|
-
|
|
703
|
-
### Response
|
|
704
|
-
|
|
705
|
-
**Promise\<[components.EarnTransferResponse](../../models/components/earntransferresponse.md)\>**
|
|
706
|
-
|
|
707
|
-
### Errors
|
|
708
|
-
|
|
709
|
-
| Error Type | Status Code | Content Type |
|
|
710
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
711
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
712
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
713
|
-
|
|
714
|
-
## riskYieldSwap
|
|
715
|
-
|
|
716
|
-
Trade one token for another from inside your Risk Yield Account.
|
|
717
|
-
|
|
718
|
-
Mostly used to reach the ratio a range needs before opening a position:
|
|
719
|
-
a range fixes the proportion of the two assets, and a caller holding one of
|
|
720
|
-
them has to swap to it.
|
|
721
|
-
|
|
722
|
-
There is no aggregator on this chain, so the route is a Uniswap v3 pool. The
|
|
723
|
-
API quotes every enabled fee tier and takes whichever returns the most — a
|
|
724
|
-
1% pool with depth beats a 0.05% pool with none, which here is the common
|
|
725
|
-
case rather than the corner one.
|
|
726
|
-
|
|
727
|
-
The transaction is simulated before it is returned. A failing simulation is
|
|
728
|
-
a 422 rather than something to sign: on this chain a token may tax
|
|
729
|
-
transfers, block an address or be paused, and none of that is visible until
|
|
730
|
-
the call is actually made.
|
|
731
|
-
|
|
732
|
-
### Example Usage
|
|
733
|
-
|
|
734
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_swap" method="post" path="/v2/risk_yield/swap" -->
|
|
735
|
-
```typescript
|
|
736
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
737
|
-
|
|
738
|
-
const compassApiSDK = new CompassApiSDK({
|
|
739
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
740
|
-
});
|
|
741
|
-
|
|
742
|
-
async function run() {
|
|
743
|
-
const result = await compassApiSDK.riskYield.riskYieldSwap({
|
|
744
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
745
|
-
chain: "robinhood",
|
|
746
|
-
tokenIn: "USDG",
|
|
747
|
-
tokenOut: "WETH",
|
|
748
|
-
amountIn: "100",
|
|
749
|
-
});
|
|
750
|
-
|
|
751
|
-
console.log(result);
|
|
752
|
-
}
|
|
753
|
-
|
|
754
|
-
run();
|
|
755
|
-
```
|
|
756
|
-
|
|
757
|
-
### Standalone function
|
|
758
|
-
|
|
759
|
-
The standalone function version of this method:
|
|
760
|
-
|
|
761
|
-
```typescript
|
|
762
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
763
|
-
import { riskYieldRiskYieldSwap } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldSwap.js";
|
|
764
|
-
|
|
765
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
766
|
-
// You can create one instance of it to use across an application.
|
|
767
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
768
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
769
|
-
});
|
|
770
|
-
|
|
771
|
-
async function run() {
|
|
772
|
-
const res = await riskYieldRiskYieldSwap(compassApiSDK, {
|
|
773
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
774
|
-
chain: "robinhood",
|
|
775
|
-
tokenIn: "USDG",
|
|
776
|
-
tokenOut: "WETH",
|
|
777
|
-
amountIn: "100",
|
|
778
|
-
});
|
|
779
|
-
if (res.ok) {
|
|
780
|
-
const { value: result } = res;
|
|
781
|
-
console.log(result);
|
|
782
|
-
} else {
|
|
783
|
-
console.log("riskYieldRiskYieldSwap failed:", res.error);
|
|
784
|
-
}
|
|
785
|
-
}
|
|
786
|
-
|
|
787
|
-
run();
|
|
788
|
-
```
|
|
789
|
-
|
|
790
|
-
### Parameters
|
|
791
|
-
|
|
792
|
-
| Parameter | Type | Required | Description |
|
|
793
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
794
|
-
| `request` | [components.RiskYieldSwapRequest](../../models/components/riskyieldswaprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
795
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
796
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
797
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
798
|
-
|
|
799
|
-
### Response
|
|
800
|
-
|
|
801
|
-
**Promise\<[components.RiskYieldSwapResponse](../../models/components/riskyieldswapresponse.md)\>**
|
|
802
|
-
|
|
803
|
-
### Errors
|
|
804
|
-
|
|
805
|
-
| Error Type | Status Code | Content Type |
|
|
806
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
807
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
808
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
809
|
-
|
|
810
|
-
## riskYieldMint
|
|
811
|
-
|
|
812
|
-
Provide liquidity to a pool over a price range.
|
|
813
|
-
|
|
814
|
-
The range you ask for is not quite the range you get: ticks are discrete, so
|
|
815
|
-
a 30% band becomes the usable ticks that bracket it — snapped outward, never
|
|
816
|
-
inward, because a position that stops earning sooner than you expected is
|
|
817
|
-
the worse surprise. The `range` in the response is what will actually be
|
|
818
|
-
opened.
|
|
819
|
-
|
|
820
|
-
A range also fixes the proportion of the two assets, so a deposit rarely
|
|
821
|
-
uses all of both. What does not fit is reported as `leftover` and stays in
|
|
822
|
-
your account rather than being quietly swept.
|
|
823
|
-
|
|
824
|
-
Set `preview` to see the plan and its simulation without building anything.
|
|
825
|
-
|
|
826
|
-
### Example Usage
|
|
827
|
-
|
|
828
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_mint" method="post" path="/v2/risk_yield/mint" -->
|
|
829
|
-
```typescript
|
|
830
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
831
|
-
|
|
832
|
-
const compassApiSDK = new CompassApiSDK({
|
|
833
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
834
|
-
});
|
|
835
|
-
|
|
836
|
-
async function run() {
|
|
837
|
-
const result = await compassApiSDK.riskYield.riskYieldMint({
|
|
838
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
839
|
-
chain: "robinhood",
|
|
840
|
-
pool: {
|
|
841
|
-
poolId: 1,
|
|
842
|
-
},
|
|
843
|
-
range: {
|
|
844
|
-
type: "symmetric_pct",
|
|
845
|
-
widthPct: "30",
|
|
846
|
-
},
|
|
847
|
-
deposit: {
|
|
848
|
-
type: "both",
|
|
849
|
-
amount0: "100",
|
|
850
|
-
amount1: "0.04",
|
|
851
|
-
},
|
|
852
|
-
});
|
|
853
|
-
|
|
854
|
-
console.log(result);
|
|
855
|
-
}
|
|
856
|
-
|
|
857
|
-
run();
|
|
858
|
-
```
|
|
859
|
-
|
|
860
|
-
### Standalone function
|
|
861
|
-
|
|
862
|
-
The standalone function version of this method:
|
|
863
|
-
|
|
864
|
-
```typescript
|
|
865
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
866
|
-
import { riskYieldRiskYieldMint } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldMint.js";
|
|
867
|
-
|
|
868
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
869
|
-
// You can create one instance of it to use across an application.
|
|
870
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
871
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
872
|
-
});
|
|
873
|
-
|
|
874
|
-
async function run() {
|
|
875
|
-
const res = await riskYieldRiskYieldMint(compassApiSDK, {
|
|
876
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
877
|
-
chain: "robinhood",
|
|
878
|
-
pool: {
|
|
879
|
-
poolId: 1,
|
|
880
|
-
},
|
|
881
|
-
range: {
|
|
882
|
-
type: "symmetric_pct",
|
|
883
|
-
widthPct: "30",
|
|
884
|
-
},
|
|
885
|
-
deposit: {
|
|
886
|
-
type: "both",
|
|
887
|
-
amount0: "100",
|
|
888
|
-
amount1: "0.04",
|
|
889
|
-
},
|
|
890
|
-
});
|
|
891
|
-
if (res.ok) {
|
|
892
|
-
const { value: result } = res;
|
|
893
|
-
console.log(result);
|
|
894
|
-
} else {
|
|
895
|
-
console.log("riskYieldRiskYieldMint failed:", res.error);
|
|
896
|
-
}
|
|
897
|
-
}
|
|
898
|
-
|
|
899
|
-
run();
|
|
900
|
-
```
|
|
901
|
-
|
|
902
|
-
### Parameters
|
|
903
|
-
|
|
904
|
-
| Parameter | Type | Required | Description |
|
|
905
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
906
|
-
| `request` | [components.RiskYieldMintRequest](../../models/components/riskyieldmintrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
907
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
908
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
909
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
910
|
-
|
|
911
|
-
### Response
|
|
912
|
-
|
|
913
|
-
**Promise\<[components.RiskYieldLiquidityResponse](../../models/components/riskyieldliquidityresponse.md)\>**
|
|
914
|
-
|
|
915
|
-
### Errors
|
|
916
|
-
|
|
917
|
-
| Error Type | Status Code | Content Type |
|
|
918
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
919
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
920
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
921
|
-
|
|
922
|
-
## riskYieldIncrease
|
|
923
|
-
|
|
924
|
-
Add liquidity to a position you already hold, over its existing range.
|
|
925
|
-
|
|
926
|
-
### Example Usage
|
|
927
|
-
|
|
928
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_increase" method="post" path="/v2/risk_yield/increase" -->
|
|
929
|
-
```typescript
|
|
930
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
931
|
-
|
|
932
|
-
const compassApiSDK = new CompassApiSDK({
|
|
933
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
934
|
-
});
|
|
935
|
-
|
|
936
|
-
async function run() {
|
|
937
|
-
const result = await compassApiSDK.riskYield.riskYieldIncrease({
|
|
938
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
939
|
-
chain: "robinhood",
|
|
940
|
-
positionId: 1076416,
|
|
941
|
-
deposit: {
|
|
942
|
-
type: "both",
|
|
943
|
-
amount0: "50",
|
|
944
|
-
amount1: "0.02",
|
|
945
|
-
},
|
|
946
|
-
});
|
|
947
|
-
|
|
948
|
-
console.log(result);
|
|
949
|
-
}
|
|
950
|
-
|
|
951
|
-
run();
|
|
952
|
-
```
|
|
953
|
-
|
|
954
|
-
### Standalone function
|
|
955
|
-
|
|
956
|
-
The standalone function version of this method:
|
|
957
|
-
|
|
958
|
-
```typescript
|
|
959
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
960
|
-
import { riskYieldRiskYieldIncrease } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldIncrease.js";
|
|
961
|
-
|
|
962
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
963
|
-
// You can create one instance of it to use across an application.
|
|
964
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
965
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
966
|
-
});
|
|
967
|
-
|
|
968
|
-
async function run() {
|
|
969
|
-
const res = await riskYieldRiskYieldIncrease(compassApiSDK, {
|
|
970
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
971
|
-
chain: "robinhood",
|
|
972
|
-
positionId: 1076416,
|
|
973
|
-
deposit: {
|
|
974
|
-
type: "both",
|
|
975
|
-
amount0: "50",
|
|
976
|
-
amount1: "0.02",
|
|
977
|
-
},
|
|
978
|
-
});
|
|
979
|
-
if (res.ok) {
|
|
980
|
-
const { value: result } = res;
|
|
981
|
-
console.log(result);
|
|
982
|
-
} else {
|
|
983
|
-
console.log("riskYieldRiskYieldIncrease failed:", res.error);
|
|
984
|
-
}
|
|
985
|
-
}
|
|
986
|
-
|
|
987
|
-
run();
|
|
988
|
-
```
|
|
989
|
-
|
|
990
|
-
### Parameters
|
|
991
|
-
|
|
992
|
-
| Parameter | Type | Required | Description |
|
|
993
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
994
|
-
| `request` | [components.RiskYieldIncreaseRequest](../../models/components/riskyieldincreaserequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
995
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
996
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
997
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
998
|
-
|
|
999
|
-
### Response
|
|
1000
|
-
|
|
1001
|
-
**Promise\<[components.RiskYieldLiquidityResponse](../../models/components/riskyieldliquidityresponse.md)\>**
|
|
1002
|
-
|
|
1003
|
-
### Errors
|
|
1004
|
-
|
|
1005
|
-
| Error Type | Status Code | Content Type |
|
|
1006
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
1007
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
1008
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1009
|
-
|
|
1010
|
-
## riskYieldDecrease
|
|
1011
|
-
|
|
1012
|
-
Take liquidity back out of a position.
|
|
1013
|
-
|
|
1014
|
-
The collect is bundled in by default and should stay that way:
|
|
1015
|
-
`decreaseLiquidity` only *credits* the tokens to the position, it does not
|
|
1016
|
-
move them. Without the collect the position looks emptied while the funds
|
|
1017
|
-
sit in the position manager.
|
|
1018
|
-
|
|
1019
|
-
### Example Usage
|
|
1020
|
-
|
|
1021
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_decrease" method="post" path="/v2/risk_yield/decrease" -->
|
|
1022
|
-
```typescript
|
|
1023
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
1024
|
-
|
|
1025
|
-
const compassApiSDK = new CompassApiSDK({
|
|
1026
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1027
|
-
});
|
|
1028
|
-
|
|
1029
|
-
async function run() {
|
|
1030
|
-
const result = await compassApiSDK.riskYield.riskYieldDecrease({
|
|
1031
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1032
|
-
chain: "robinhood",
|
|
1033
|
-
positionId: 1076416,
|
|
1034
|
-
percent: "100",
|
|
1035
|
-
});
|
|
1036
|
-
|
|
1037
|
-
console.log(result);
|
|
1038
|
-
}
|
|
1039
|
-
|
|
1040
|
-
run();
|
|
1041
|
-
```
|
|
1042
|
-
|
|
1043
|
-
### Standalone function
|
|
1044
|
-
|
|
1045
|
-
The standalone function version of this method:
|
|
1046
|
-
|
|
1047
|
-
```typescript
|
|
1048
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
1049
|
-
import { riskYieldRiskYieldDecrease } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldDecrease.js";
|
|
1050
|
-
|
|
1051
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
1052
|
-
// You can create one instance of it to use across an application.
|
|
1053
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
1054
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1055
|
-
});
|
|
1056
|
-
|
|
1057
|
-
async function run() {
|
|
1058
|
-
const res = await riskYieldRiskYieldDecrease(compassApiSDK, {
|
|
1059
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1060
|
-
chain: "robinhood",
|
|
1061
|
-
positionId: 1076416,
|
|
1062
|
-
percent: "100",
|
|
1063
|
-
});
|
|
1064
|
-
if (res.ok) {
|
|
1065
|
-
const { value: result } = res;
|
|
1066
|
-
console.log(result);
|
|
1067
|
-
} else {
|
|
1068
|
-
console.log("riskYieldRiskYieldDecrease failed:", res.error);
|
|
1069
|
-
}
|
|
1070
|
-
}
|
|
1071
|
-
|
|
1072
|
-
run();
|
|
1073
|
-
```
|
|
1074
|
-
|
|
1075
|
-
### Parameters
|
|
1076
|
-
|
|
1077
|
-
| Parameter | Type | Required | Description |
|
|
1078
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1079
|
-
| `request` | [components.RiskYieldDecreaseRequest](../../models/components/riskyielddecreaserequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1080
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1081
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1082
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1083
|
-
|
|
1084
|
-
### Response
|
|
1085
|
-
|
|
1086
|
-
**Promise\<[components.RiskYieldLiquidityResponse](../../models/components/riskyieldliquidityresponse.md)\>**
|
|
1087
|
-
|
|
1088
|
-
### Errors
|
|
1089
|
-
|
|
1090
|
-
| Error Type | Status Code | Content Type |
|
|
1091
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
1092
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
1093
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1094
|
-
|
|
1095
|
-
## riskYieldCollect
|
|
1096
|
-
|
|
1097
|
-
Sweep the fees a position has earned into your account.
|
|
1098
|
-
|
|
1099
|
-
### Example Usage
|
|
1100
|
-
|
|
1101
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_collect" method="post" path="/v2/risk_yield/collect" -->
|
|
1102
|
-
```typescript
|
|
1103
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
1104
|
-
|
|
1105
|
-
const compassApiSDK = new CompassApiSDK({
|
|
1106
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1107
|
-
});
|
|
1108
|
-
|
|
1109
|
-
async function run() {
|
|
1110
|
-
const result = await compassApiSDK.riskYield.riskYieldCollect({
|
|
1111
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1112
|
-
chain: "robinhood",
|
|
1113
|
-
positionId: 1076416,
|
|
1114
|
-
});
|
|
1115
|
-
|
|
1116
|
-
console.log(result);
|
|
1117
|
-
}
|
|
1118
|
-
|
|
1119
|
-
run();
|
|
1120
|
-
```
|
|
1121
|
-
|
|
1122
|
-
### Standalone function
|
|
1123
|
-
|
|
1124
|
-
The standalone function version of this method:
|
|
1125
|
-
|
|
1126
|
-
```typescript
|
|
1127
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
1128
|
-
import { riskYieldRiskYieldCollect } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldCollect.js";
|
|
1129
|
-
|
|
1130
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
1131
|
-
// You can create one instance of it to use across an application.
|
|
1132
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
1133
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1134
|
-
});
|
|
1135
|
-
|
|
1136
|
-
async function run() {
|
|
1137
|
-
const res = await riskYieldRiskYieldCollect(compassApiSDK, {
|
|
1138
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1139
|
-
chain: "robinhood",
|
|
1140
|
-
positionId: 1076416,
|
|
1141
|
-
});
|
|
1142
|
-
if (res.ok) {
|
|
1143
|
-
const { value: result } = res;
|
|
1144
|
-
console.log(result);
|
|
1145
|
-
} else {
|
|
1146
|
-
console.log("riskYieldRiskYieldCollect failed:", res.error);
|
|
1147
|
-
}
|
|
1148
|
-
}
|
|
1149
|
-
|
|
1150
|
-
run();
|
|
1151
|
-
```
|
|
1152
|
-
|
|
1153
|
-
### Parameters
|
|
1154
|
-
|
|
1155
|
-
| Parameter | Type | Required | Description |
|
|
1156
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1157
|
-
| `request` | [components.RiskYieldCollectRequest](../../models/components/riskyieldcollectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1158
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1159
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1160
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1161
|
-
|
|
1162
|
-
### Response
|
|
1163
|
-
|
|
1164
|
-
**Promise\<[components.RiskYieldLiquidityResponse](../../models/components/riskyieldliquidityresponse.md)\>**
|
|
1165
|
-
|
|
1166
|
-
### Errors
|
|
1167
|
-
|
|
1168
|
-
| Error Type | Status Code | Content Type |
|
|
1169
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
1170
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
1171
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1172
|
-
|
|
1173
|
-
## riskYieldRebalance
|
|
1174
|
-
|
|
1175
|
-
Move a position to a new range, in one transaction.
|
|
1176
|
-
|
|
1177
|
-
**`NOOP` is a real answer and often the right one.** Rebalancing realizes
|
|
1178
|
-
the impermanent loss the position has taken so far, pays gas twice and a
|
|
1179
|
-
swap, and puts the position back at risk from a new price. If the position
|
|
1180
|
-
is already centred at the requested width, that is what you will get.
|
|
1181
|
-
|
|
1182
|
-
When there is something to do, the transaction unwinds the old position,
|
|
1183
|
-
sweeps it together with the fees, opens the new range and burns the empty
|
|
1184
|
-
NFT. Every leg is sized from the **floor** the previous one guarantees
|
|
1185
|
-
rather than from its quote — they execute in the same transaction, and a
|
|
1186
|
-
mint sized from a quote reverts when the decrease comes back a wei short,
|
|
1187
|
-
leaving the owner having paid gas to dismantle a position. `estimated_dust`
|
|
1188
|
-
is what that safety costs.
|
|
1189
|
-
|
|
1190
|
-
The default `vol_scaled` strategy sizes the new range from the pair's own
|
|
1191
|
-
measured volatility: two standard deviations over the horizon. A range
|
|
1192
|
-
narrower than the asset's ordinary movement spends most of its life out of
|
|
1193
|
-
range earning nothing, which is the most common way to lose money doing
|
|
1194
|
-
this on purpose.
|
|
1195
|
-
|
|
1196
|
-
### Example Usage
|
|
1197
|
-
|
|
1198
|
-
<!-- UsageSnippet language="typescript" operationID="v2_risk_yield_rebalance" method="post" path="/v2/risk_yield/rebalance" -->
|
|
1199
|
-
```typescript
|
|
1200
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
1201
|
-
|
|
1202
|
-
const compassApiSDK = new CompassApiSDK({
|
|
1203
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1204
|
-
});
|
|
1205
|
-
|
|
1206
|
-
async function run() {
|
|
1207
|
-
const result = await compassApiSDK.riskYield.riskYieldRebalance({
|
|
1208
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1209
|
-
chain: "robinhood",
|
|
1210
|
-
positionId: 1076416,
|
|
1211
|
-
strategy: "vol_scaled",
|
|
1212
|
-
horizonDays: 7,
|
|
1213
|
-
});
|
|
1214
|
-
|
|
1215
|
-
console.log(result);
|
|
1216
|
-
}
|
|
1217
|
-
|
|
1218
|
-
run();
|
|
1219
|
-
```
|
|
1220
|
-
|
|
1221
|
-
### Standalone function
|
|
1222
|
-
|
|
1223
|
-
The standalone function version of this method:
|
|
1224
|
-
|
|
1225
|
-
```typescript
|
|
1226
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
1227
|
-
import { riskYieldRiskYieldRebalance } from "@compass-labs/api-sdk/funcs/riskYieldRiskYieldRebalance.js";
|
|
1228
|
-
|
|
1229
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
1230
|
-
// You can create one instance of it to use across an application.
|
|
1231
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
1232
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1233
|
-
});
|
|
1234
|
-
|
|
1235
|
-
async function run() {
|
|
1236
|
-
const res = await riskYieldRiskYieldRebalance(compassApiSDK, {
|
|
1237
|
-
owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
|
|
1238
|
-
chain: "robinhood",
|
|
1239
|
-
positionId: 1076416,
|
|
1240
|
-
strategy: "vol_scaled",
|
|
1241
|
-
horizonDays: 7,
|
|
1242
|
-
});
|
|
1243
|
-
if (res.ok) {
|
|
1244
|
-
const { value: result } = res;
|
|
1245
|
-
console.log(result);
|
|
1246
|
-
} else {
|
|
1247
|
-
console.log("riskYieldRiskYieldRebalance failed:", res.error);
|
|
1248
|
-
}
|
|
1249
|
-
}
|
|
1250
|
-
|
|
1251
|
-
run();
|
|
1252
|
-
```
|
|
1253
|
-
|
|
1254
|
-
### Parameters
|
|
1255
|
-
|
|
1256
|
-
| Parameter | Type | Required | Description |
|
|
1257
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1258
|
-
| `request` | [components.RiskYieldRebalanceRequest](../../models/components/riskyieldrebalancerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1259
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1260
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1261
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1262
|
-
|
|
1263
|
-
### Response
|
|
1264
|
-
|
|
1265
|
-
**Promise\<[components.RiskYieldRebalanceResponse](../../models/components/riskyieldrebalanceresponse.md)\>**
|
|
1266
|
-
|
|
1267
|
-
### Errors
|
|
1268
|
-
|
|
1269
|
-
| Error Type | Status Code | Content Type |
|
|
1270
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
1271
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
1272
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|