Create umbruella package by jeffersonBastos · Pull Request #27 · bleu/cow-sdk

jeffersonBastos · 2025-06-25T15:53:21Z

This PR introduces the umbrella package to simplify SDK usage and centralize the initialization of all packages.

It provides a unified entry point, similar to the CowSdk, giving users streamlined access to all modules through a single interface.

…eed up base branch sync (cowprotocol#354) * chore: switch to pnpm and update Node.js to v20 * chore: reorganize project structure under packages/cow-sdk * feat: init monorepo structure with Turborepo * chore: format codebase with pnpm script * chore: eslint config. * chore: update lint config, .npmrc, and VSCode settings * feat: copy entire src, tests folders, and package/tsconfig files from app-data project into the monorepo * feat: add typescript-config * feat: create common package with abstract adapter and context classes * feat: implement adapters for ethers v5, ethers v6, and viem * chore: update pnpm-lock * chore: remove appdata and cow-sdk from build * feat: create config package * chore: fix eslint tsconfig path * feat: refactor config * chore: update pnpm-lock * feat: add contracts-ts package * feat: refactor contracts-ts * feat: update adapters with new contracts-ts features * feat: add tests for contracts-ts * feat: move order-signing to new package * feat: refactor order-signing * feat: add new order-signing features to adapters * feat: refactor order-signing tests * feat: implement adapter usage in app-data; update app-data config and test files * chore: update pnpm-lock file * chore: fix lint and remove cow-sdk from lint. * chore: update sdk-config tsconfig * feat: add contracts-ts package * feat: refactor contracts-ts * feat: update adapters with new contracts-ts features * feat: add tests for contracts-ts * chore: update contracts-ts config * chore(order-book): move order-book to monorepo package * restore: bring back deleted type files with their history * restore: bring back deleted config and path files with their history * refactor: move cow-error and wallets.ts and remove duplicate types * feat(order-book): setup order-book package, jest and tsconfig * feat(order-book): refact order-book * feat(monorepo-config): adjust all package.json and scripts * chore(lint): lint * chore(subgraph): move subgraph to monorepo package * chore(subgraph): create package, tsconfig and jest config * feat(subgraph): refactor subgraph package * chore(subgraph): update pnpm-lock and run lint * chore: add hashDomain to abstract utils * feat: move composable package from original sdk to refactor sdk * chore(subgraph): move cow-shed to monorepo package * chore(cow-shed): copy wallets.ts * feat(cow-shed): create package.json and tsconfig.json * feat(cow-shed): add estimateGas method to SignerAdapters * feat: refactor composable module to be framework-agnostic * feat: enhance adapters and utils with composable features * chore: move composable tests file to composable/tests * feat: update tests to work with ethersV5 adapter * feat: enhance composable to test the 3 adapters * chore: remove console logs * feat(cow-shed): refact on common and contract-ts * chore(cow-shed): rename CowShedHooks test file * feat(cow-shed): refact cow-she to use adapters and fix tests * fix(cow-shed): fix adapters - estimateGas and encodeAbi * chore: lint files * chore: move constants to sdk-common * feat: update Node.js to version 22 * chore: align settings.json with .editorconfig configuration. * chore: adjust cow-shed hooks test * chore: add check to verify if the signature is the same across all three adapters in cowshedHooks test * chore: apply PR suggestions * chore: update pnpm-lock.json * fix: viemUtils encodeAbi --------- Co-authored-by: Jean Neiverth <jeanneiverth@gmail.com> Co-authored-by: Jean Neiverth <79885562+jean-neiverth@users.noreply.github.com>

linear · 2025-06-25T15:53:24Z

COW-480 Create umbruella package

github-actions · 2025-06-25T15:53:31Z

Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

0 out of 2 committers have signed the CLA.
❌ @alfetopito
❌ @jeffersonBastos
_{You can retrigger this bot by commenting recheck in this Pull Request.}_{Posted by the CLA Assistant Lite bot.}

socket-security · 2025-06-25T15:53:59Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Quality	Maintenance
	@types/semver-sort@0.0.1
	jest@29.7.0
	@graphql-codegen/typescript-operations@4.6.1
	@graphql-codegen/typescript@4.1.6
	@typescript-eslint/parser@5.57.0 ⏵ 8.33.0		⁺²
	@babel/preset-typescript@7.21.0 ⏵ 7.27.1		⁺²
	babel-jest@27.5.1 ⏵ 29.7.0	⁺¹
	@graphql-codegen/cli@5.0.6
	@types/jest@29.5.0 ⏵ 29.5.14
	@babel/preset-env@7.20.2 ⏵ 7.27.2	⁺¹	⁺¹
	@typescript-eslint/utils@5.57.0 ⏵ 8.33.0	⁺¹
	babel-plugin-inline-import@3.0.0
	ipfs-only-hash@4.0.0
	cpx@1.5.0
	deepmerge@4.3.1
	json-stringify-deterministic@1.0.12
	jest-fetch-mock@3.0.3
	@babel/core@7.21.3 ⏵ 7.27.1
	cross-fetch@3.1.5 ⏵ 3.2.0
	@typechain/ethers-v5@11.1.2
	coveralls@3.1.1
	@types/node@22.5.2 ⏵ 20.17.52	⁺¹	⁺¹	⁺²
	@types/node@22.5.2 ⏵ 22.15.24	⁺¹	⁺¹
	json-schema-to-typescript@10.1.5
	json-schema-ref-parser@9.0.9
	@cowprotocol/contracts@1.7.0 ⏵ 1.8.0	⁺¹	⁺¹	^-2
	@cowprotocol/app-data@3.0.0 ⏵ 3.1.0	⁺¹	⁺¹
	eslint-plugin-unused-imports@4.1.4
	exponential-backoff@3.1.1 ⏵ 3.1.2	⁺¹	⁺¹
	@eslint/js@8.36.0 ⏵ 9.27.0		⁺⁵
See 5 more rows in the dashboard

View full report

socket-security · 2025-06-25T15:54:01Z

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action	Severity	Alert (click for details)
Warn		`es5-ext@0.10.64` is Protestware or potentially unwanted behavior. Note: This package prints a protestware console message on install regarding Ukraine for users with Russian language locale From: pnpm-lock.yaml → `npm/json-schema-to-typescript@10.1.5` → `npm/es5-ext@0.10.64` ℹ Read more on: This package \| This alert \| What is protestware? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `support@socket.dev`. Suggestion: Consider that consuming this package may come along with functionality unrelated to its primary purpose. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/es5-ext@0.10.64`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		`es5-ext@0.10.64` is Protestware or potentially unwanted behavior. Note: The script attempts to run a local post-install script, which could potentially contain malicious code. The error handling suggests that it is designed to fail silently, which is a common tactic in malicious scripts. From: pnpm-lock.yaml → `npm/json-schema-to-typescript@10.1.5` → `npm/es5-ext@0.10.64` ℹ Read more on: This package \| This alert \| What is protestware? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `support@socket.dev`. Suggestion: Consider that consuming this package may come along with functionality unrelated to its primary purpose. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/es5-ext@0.10.64`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

yvesfracari · 2025-06-26T17:56:55Z

@@ -0,0 +1 @@
+export * from './CowSdk'


shouldn't we export the types as well ?

Yes, I will add this export. Tks!

yvesfracari

LGTM

ribeirojose · 2025-06-26T18:51:25Z

@@ -0,0 +1,78 @@
+{
+  "name": "@cowprotocol/sdk",


👍 all other ones then are a subspace of this right?

ribeirojose · 2025-06-26T18:51:58Z

@@ -0,0 +1,9 @@
+{
+  "extends": "@repo/typescript-config/base.json",


again this is not referencing anything ❌ https://turborepo.com/docs/crafting-your-repository/structuring-a-repository#name

alfetopito and others added 2 commits June 18, 2025 06:55

feat(sdk): create new umbruella package

e05e377

jeffersonBastos requested a review from yvesfracari June 25, 2025 15:53

jeffersonBastos merged commit 2eea721 into bleu/refactor Jun 26, 2025
3 of 8 checks passed

github-actions Bot locked and limited conversation to collaborators Jun 26, 2025

$yvesfracari$

yvesfracari reviewed Jun 26, 2025

View reviewed changes

ribeirojose reviewed Jun 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create umbruella package#27

Create umbruella package#27
jeffersonBastos merged 2 commits into
bleu/refactorfrom
jefferson/cow-480-create-umbruella-package

jeffersonBastos commented Jun 25, 2025

Uh oh!

linear Bot commented Jun 25, 2025

Uh oh!

github-actions Bot commented Jun 25, 2025

Uh oh!

socket-security Bot commented Jun 25, 2025

Uh oh!

socket-security Bot commented Jun 25, 2025

Uh oh!

Uh oh!

$@yvesfracari$ yvesfracari Jun 26, 2025 •

edited

Loading

Uh oh!

jeffersonBastos Jun 26, 2025

Uh oh!

$@yvesfracari$ yvesfracari left a comment

Uh oh!

ribeirojose Jun 26, 2025

Uh oh!

ribeirojose Jun 26, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -0,0 +1,9 @@
		{
		"extends": "@repo/typescript-config/base.json",

Conversation

jeffersonBastos commented Jun 25, 2025

Uh oh!

linear Bot commented Jun 25, 2025

Uh oh!

github-actions Bot commented Jun 25, 2025

Uh oh!

socket-security Bot commented Jun 25, 2025

Uh oh!

socket-security Bot commented Jun 25, 2025

Uh oh!

Uh oh!

yvesfracari Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffersonBastos Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

yvesfracari left a comment

Choose a reason for hiding this comment

Uh oh!

ribeirojose Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

ribeirojose Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

$@yvesfracari$ yvesfracari Jun 26, 2025 •

edited

Loading

$@yvesfracari$ yvesfracari left a comment

ribeirojose Jun 26, 2025 •

edited

Loading