curvance 1.0.16 → 1.0.17
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 +16 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,13 +2,27 @@
|
|
|
2
2
|
<img src="https://pbs.twimg.com/profile_banners/1445781144125857796/1752160592" alt="Curvance"/>
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
+
Features
|
|
6
|
+
- **Efficient RPC Usage:** Preloads all market data with minimal calls.
|
|
7
|
+
- **Typed Contracts:** Uses ethers.js for safe, typed blockchain interactions.
|
|
8
|
+
- **Price Feeds:** Integrates Redstone for on-chain price updates.
|
|
9
|
+
- **Decimal Support:** Handles BigInt and floating-point math with decimal.js.
|
|
10
|
+
- **Flexible Providers:** Works with multiple providers:
|
|
11
|
+
- `ethers.Wallet` - For CLI/Local wallet connections
|
|
12
|
+
- `ethers.JsonRpcSigner` - For browser interactions
|
|
13
|
+
- `ethers.JsonRpcProvider` - For a user configured RPC
|
|
14
|
+
- `null` - We setup a JsonRpcProvider if we configured one for you
|
|
15
|
+
- **Property conversions:** For example getting a users asset balance can optionally be returned in USD or token amount
|
|
16
|
+
- **Contract addresses:** Use this package to pull in curvance contracts & have the latest contract addresses (especially useful on testnet)
|
|
17
|
+
|
|
5
18
|
Dependencies:
|
|
6
19
|
- [Redstone](https://www.npmjs.com/package/@redstone-finance/sdk): Used to attach price updates in a multicall for some actions.
|
|
7
20
|
- [Decimals](https://www.npmjs.com/package/decimal.js): Any floating point path being done with BigInt is done with Decimals.
|
|
8
21
|
- [ethers.js](https://www.npmjs.com/package/ethers): All signers passed into the protocol are using ether.js typed signers.
|
|
9
|
-
- [alchemy](https://dashboard.alchemy.com/apps): We use alchemy chain prefixing to define changes for example. `eth-mainnet` or `arb-sepolia`, you do not need to use a provider with alchemy but you will need to provide a chain using the alchemy naming standard for a chain.
|
|
10
22
|
|
|
11
|
-
|
|
23
|
+
Notes:
|
|
24
|
+
- All values are returned in either BigInt or [Decimals](https://www.npmjs.com/package/decimal.js)
|
|
25
|
+
- We use [alchemy](https://dashboard.alchemy.com/apps) chain prefixing for exaple: `eth-mainnet` or `arb-sepolia` to represents chains
|
|
12
26
|
|
|
13
27
|
## ❯ Install
|
|
14
28
|
|