@jup-ag/crema-sdk-v2
Advanced tools
Comparing version 2.0.4 to 2.1.0
{ | ||
"name": "@jup-ag/crema-sdk-v2", | ||
"version": "2.0.4", | ||
"version": "2.1.0", | ||
"scripts": { | ||
"idl:generate": "./scripts/parse-idls.sh && ./scripts/generate-idl-types.sh", | ||
"lint:fix": "eslint --fix --ext .ts --ignore-path .gitignore .", | ||
"test": "jest", | ||
"pools": "ts-node ./src/cli/cli.ts", | ||
"build": "tsup" | ||
}, | ||
"license": "AGPL-3.0", | ||
@@ -21,5 +28,10 @@ "dependencies": { | ||
"@types/mocha": "^9.1.1", | ||
"@typescript-eslint/eslint-plugin": "^5.43.0", | ||
"chai": "^4.3.4", | ||
"eslint": "^8.27.0", | ||
"eslint-config-standard-with-typescript": "^23.0.0", | ||
"eslint-import-resolver-node": "^0.3.6", | ||
"eslint-plugin-import": "^2.26.0", | ||
"eslint-plugin-n": "^15.5.1", | ||
"eslint-plugin-promise": "^6.1.1", | ||
"jest": "^27.0.6", | ||
@@ -31,3 +43,3 @@ "mocha": "^10.0.0", | ||
"tsup": "^6.5.0", | ||
"typescript": "^4.4.4", | ||
"typescript": "^4.9.3", | ||
"yaml": "^2.1.1" | ||
@@ -41,10 +53,3 @@ }, | ||
"module": "dist/index.mjs", | ||
"packageManager": "yarn@3.2.2", | ||
"scripts": { | ||
"idl:generate": "./scripts/parse-idls.sh && ./scripts/generate-idl-types.sh", | ||
"lint:fix": "eslint --fix --ext .ts --ignore-path .gitignore .", | ||
"test": "jest", | ||
"pools": "ts-node ./src/cli/cli.ts", | ||
"build": "tsup" | ||
} | ||
} | ||
"packageManager": "yarn@3.2.2" | ||
} |
@@ -6,2 +6,3 @@ [![LICENSE](https://img.shields.io/badge/license-Apache2-green)](./LICENSE) | ||
# What is Crema-SDK-V2 | ||
CLMM means concentrated liquidity market maker, it's crema sdk for new swap protocal. **[Crema](https://www.crema.finance/)** is a open-source concentrated liquidity market maker on the **Solana BlockChain** . The new version of crema increases the capital efficiency of decentralized exchanges. | ||
@@ -11,23 +12,20 @@ | ||
# Community | ||
You can join these groups and chats to discuss and ask clmm-sdk-v2 related questions: | ||
# How to use Crema-SDK-V2? | ||
- [Discard](https://discord.com/channels/898196754678284308/910120408785760266) | ||
- [Twitter Channel](https://twitter.com/Crema_Finance) | ||
- [Medium](https://medium.com/@Crema.finance) | ||
- [Telegram Community](https://t.me/cremafinance) | ||
## Installation | ||
# How to use Crema-SDK-V2? | ||
## Installation | ||
``` | ||
yarn add @cremafinance/crema-sdk-v2 | ||
npm add @cremafinance/crema-sdk-v2 | ||
``` | ||
## Test | ||
You can use `yarn test` to test crema instructions in `./test/instructions`. | ||
You can use `npm test` to test crema instructions in `./test/instructions`. | ||
## Use case: | ||
We will show you the pseudocode example, specific method of application you can read `./integration/jupiter/example` or `./tests/instructions/xx.test.ts` | ||
### Pseudocode Example | ||
``` | ||
@@ -49,3 +47,3 @@ // swap quote structa | ||
aToB, // weather change token_a for token_b | ||
byAmountIn, // weather amount of fixed input | ||
byAmountIn, // weather amount of fixed input | ||
amount, // the amount of token | ||
@@ -72,3 +70,3 @@ amountLimit, // calculate by simulate swap quote result and slippage | ||
// Get tick arrays address by createTickArrayRange first, then get theirs account data by fetcher,getTickData(). | ||
remainingAccounts, | ||
remainingAccounts, | ||
} | ||
@@ -79,2 +77,3 @@ ); | ||
# Structure | ||
``` | ||
@@ -93,3 +92,2 @@ |____integration | ||
| |____quotes | ||
| | |____swap | ||
| | |____public | ||
@@ -110,22 +108,33 @@ | |____types | ||
## Folder Details | ||
- intergation: the sdk interface of the dex intergation, such as jupiter. | ||
- src: the main content of crema sdk v2. | ||
- cli: The cli to develop complete applications. | ||
- error: The error type in crema program. | ||
- idls: Definition Language–IDL–specification. | ||
- impl: The functions implemented for frontbank. | ||
- math: All math arithmetic funcitions. | ||
- network: All functions about get some information from solana newwork. | ||
- quotes: Some functions about swap and increase/decrease liquidity. | ||
- types: All type definition about program. | ||
- utils: All helpful utils. | ||
- context: The functions of clmmpool context. | ||
- ix.ts: All instruction definition interfaces. | ||
- cli: The cli to develop complete applications. | ||
- error: The error type in crema program. | ||
- idls: Definition Language–IDL–specification. | ||
- impl: The functions implemented for frontbank. | ||
- math: All math arithmetic funcitions. | ||
- network: All functions about get some information from solana newwork. | ||
- quotes: Some functions about increase/decrease liquidity. | ||
- types: All type definition about program. | ||
- utils: All helpful utils. | ||
- context: The functions of clmmpool context. | ||
- ix.ts: All instruction definition interfaces. | ||
- test: the test case of crema instruction. | ||
- instructions: Some test case of crema instructions. | ||
- utils: Some utils function used to test. | ||
- instructions: Some test case of crema instructions. | ||
- utils: Some utils function used to test. | ||
- package.json | ||
- README.md | ||
# Community | ||
You can join these groups and chats to discuss and ask clmm-sdk-v2 related questions: | ||
- [Discard](https://discord.com/channels/898196754678284308/910120408785760266) | ||
- [Twitter Channel](https://twitter.com/Crema_Finance) | ||
- [Medium](https://medium.com/@Crema.finance) | ||
- [Telegram Community](https://t.me/cremafinance) | ||
# License | ||
Crema-SDK-V2 is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details. | ||
Crema-SDK-V2 is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details. |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
134
788972
22
10861