Skip to content

Commit

Permalink
Squash
Browse files Browse the repository at this point in the history
  • Loading branch information
wjthieme committed Aug 22, 2024
1 parent 8857739 commit a11aeff
Show file tree
Hide file tree
Showing 54 changed files with 8,629 additions and 163 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Checks

on:
pull_request:
branches: [main]
branches: "*"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,11 @@ The program has been audited several times by different security firms.

***The new whirlpool SDKs are still in development and are not recommended for production use yet. Please see [Legacy](#legacy)***

This repository contains several libraries that can be used to interact with the Whirlpools contract. For most purposes you can use the full library (`@orca-so/whirlpools` and `orca-whirlpools`).
This repository contains several libraries that can be used to interact with the Whirlpools contract. For most purposes you can use the full library (`@orca-so/whirlpools` and `orca_whirlpools`).

For specific use-cases you can opt for integrating with lower level packages such as:
* `@orca-so/whirlpools-client` & `orca-whirlpools-client` - auto-generated client for the Whirlpools program that contains account, instruction and error parsing.
* `@orca-so/whirlpools-quoting` & `orca-whirlpools-quoting` - math lib used to calculate a quote for a given trade or liquidity action.
* `@orca-so/whirlpools-composite` & `orca-whirlpools-composite` - helper package for compositing instructions together for executing common actions.
* `@orca-so/whirlpools-utils` & `orca-whirlpools-utils` - utility and math functions used by other packages.
* `@orca-so/whirlpools-client` & `orca_whirlpools_client` - auto-generated client for the Whirlpools program that contains account, instruction and error parsing.
* `@orca-so/whirlpools-core` & `orca_whirlpools_core` - utility and math functions used by other packages.

### Legacy

Expand Down Expand Up @@ -90,8 +88,6 @@ If you look closely, the commands just call individual commands specified in the

If you want to stream the logs of a specific command you can add the `--output-style stream` flag to the command. This allows you to view the logs of the command as they are being produced which can be useful for longer running tasks like integration tests.

---

# Support

### Questions
Expand Down
1 change: 1 addition & 0 deletions docs/legacy/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"clean": "rimraf dist"
},
"devDependencies": {
"@orca-so/whirlpools": "*",
"@orca-so/whirlpools-sdk": "*",
"typedoc": "^0.26.6",
"typescript": "^5.5.4"
Expand Down
1 change: 1 addition & 0 deletions docs/ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
},
"devDependencies": {
"@orca-so/whirlpools": "*",
"@orca-so/whirlpools-sdk": "*",
"typedoc": "^0.26.6",
"typescript": "^5.5.4"
}
Expand Down
3 changes: 2 additions & 1 deletion docs/whirlpool/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ export default {
docs: {
routeBasePath: "/",
sidebarPath: "./sidebars.js",
editUrl: "https://github.com/orca-so/whirlpools/tree/main/docs/whirlpool",
editUrl:
"https://github.com/orca-so/whirlpools/tree/main/docs/whirlpool",
},
theme: {
customCss: "./static/index.css",
Expand Down
4 changes: 2 additions & 2 deletions programs/whirlpool/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"scripts": {
"build": "anchor build -p whirlpool",
"test": "cargo test -p whirlpool --lib",
"format": "cargo clippy -p whirlpool --fix --allow-dirty --allow-staged -- -D clippy::all && cargo fmt -p whirlpool",
"lint": "cargo clippy -p whirlpool -- -D clippy::all",
"format": "cargo clippy -p whirlpool --fix --allow-dirty --allow-staged && cargo fmt -p whirlpool",
"lint": "cargo clippy -p whirlpool",
"clean": "anchor clean"
}
}
5 changes: 3 additions & 2 deletions rust-sdk/client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version = "0.1.0"
edition = "2021"

[features]
default = []
anchor = ["dep:anchor-lang"]
anchor-idl-build = []
test-sbf = []
Expand All @@ -16,5 +17,5 @@ num-derive = { version = "^0.4.2" }
num-traits = { version = "^0.2.19" }
solana-program = { version = "^1.18.21" }
thiserror = { version = "^1.0.63" }
serde = { version = "^1.0", features = ["derive"], optional = true }
serde_with = { version = "^3.0", optional = true }
serde = { version = "^1.0.207", features = ["derive"], optional = true }
serde_with = { version = "^3.9.0", optional = true }
4 changes: 2 additions & 2 deletions rust-sdk/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"scripts": {
"build": "node ./kinobi.js && cargo build",
"test": "cargo test --lib",
"format": "cargo clippy --fix --allow-dirty --allow-staged -- -D clippy::all && cargo fmt",
"lint": "cargo clippy -- -D clippy::all",
"format": "cargo clippy --fix --allow-dirty --allow-staged && cargo fmt",
"lint": "cargo clippy",
"clean": "cargo clean"
},
"devDependencies": {
Expand Down
Loading

0 comments on commit a11aeff

Please sign in to comment.