generate js client with codama and add a basic test to confirm works #73
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,10 @@ | ||
| /target | ||
| proptest-regressions/ | ||
| .cargo-root/ | ||
| node_modules/ | ||
| generated/ | ||
|
|
||
| # Make sure no Solana key is uploaded by accident. | ||
| *.json | ||
| !bench-report.json | ||
| !programs/settlement/idl/**/*.json |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| src/generated/ | ||
| pnpm-lock.yaml |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # Same as rustfmt | ||
| printWidth: 100 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| { | ||
| "name": "cow-solana-settlement-client", | ||
| "version": "0.3.0", | ||
| "type": "module", | ||
| "packageManager": "pnpm@11.25.0", | ||
| "description": "A library for interacting with CoW Protocol on Solana", | ||
| "license": "(MIT OR Apache-2.0)", | ||
| "main": "src/index.ts", | ||
| "files": [ | ||
| "./dist/src", | ||
| "./dist/types", | ||
| "./src/" | ||
| ], | ||
|
kaze-cow marked this conversation as resolved.
|
||
| "scripts": { | ||
| "typecheck": "tsc --noEmit", | ||
| "test": "vitest run", | ||
| "format": "prettier --write .", | ||
| "format:check": "prettier --check ." | ||
| }, | ||
| "peerDependencies": { | ||
| "@solana/kit": "^8" | ||
| }, | ||
|
Comment on lines
+20
to
+22
Contributor
There was a problem hiding this comment. Why is this a peer dependency? Peer dependencies have been a huge pain in the past, and we'll be only noticing this once the linked versions start to drift; also indirectly, through people failing to install our package in their project. I suggest getting rid of this unless there's an extremely good reason for it.
Contributor
Author
There was a problem hiding this comment. In the past I used peer dependencies with Cannon to moderate success. It actually helps reduce problems with downloading multiple package versions and ultimately ending up with either type or compatibility errors because you are unknowingly using distinct/separate library versions, especially when working with web applications. also the both of us are not maybe the best resources to decide on this. If it helps, I notice our own cow sdk uses multiple peer dependencies. What I do think we should do is widen the list of available versions to maybe For now I have expanded the scope of the peer dependency to accept all versions (*) be88336
Contributor
There was a problem hiding this comment. Let me explain the pitfalls with peer dependencies with an example. I created two packages (here) that try to import our package:
Now, you could argue "this problem is just because peer and dev deps don't match, the fix is easy!". Now, this is not really something special of this PR. The example in the Codama readme has the same peer dependency. The expectations that Codana puts on us are clear: you must update often. You must stay in sync with The reason I feel so strongly is that I had we did the same for the contracts and so, so many people were struggling installing our package because they used Ethers v6 and we're still at Ethers v5. With a dependency they could have sorted out the issue much more easily compared to a peer dependency, where instead they need to understand both the problem as well as our internals. Look at what error appears when building v6 from above! It's deep inside the imported package and there's no clue as to what's actually going wrong.Note they are all optional.
We absolutely should. And I don't think we can do better, we aren't compatible with other versions other than 8 (not 6). So
What I think it's happening here is that the package is too strict in That said, I'm not a web dev, this is just my frustration with using peer deps in JS. There's certainly another side of the coin, the dependency problem are a thing as well. That said, what next? Two options, I let you pick:
Contributor
Author
There was a problem hiding this comment. ok I don't really consider myself an expert or well knowledged on any of this but it seems wrong to not use a peer dependency here based on all the information available to me so @limitofzero can help us decide
Contributor
There was a problem hiding this comment. Added an issue for testing on our end that the package is good, for now let's keep it as it is and rely on the frontend to tell us if there are issues. #141 |
||
| "dependencies": { | ||
| "@solana/program-client-core": "^8" | ||
| }, | ||
|
kaze-cow marked this conversation as resolved.
|
||
| "devDependencies": { | ||
| "@solana/kit": "^8", | ||
| "@types/node": "^24", | ||
| "litesvm": "^1", | ||
| "prettier": "^3", | ||
| "typescript": "^5", | ||
| "vitest": "^3" | ||
| } | ||
| } | ||
|
kaze-cow marked this conversation as resolved.
|
||
Uh oh!
There was an error while loading. Please reload this page.