Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(orderbook-api): order solution status #216

Merged
merged 5 commits into from
Aug 2, 2024

Conversation

alfetopito
Copy link
Contributor

@alfetopito alfetopito commented Jul 29, 2024

Summary

Add getOrderSolutionStatus to orderbook api.

Based on types generated from openapi definition on cowprotocol/services#2804

TODO: update once backend merge/releases the PR merged, good to go!

https://barn.api.cow.fi/docs/#/default/get_api_v1_orders__UID__status

@alfetopito alfetopito self-assigned this Jul 29, 2024
Copy link

socket-security bot commented Jul 29, 2024

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
Install scripts npm/[email protected]
  • Install script: postinstall
  • Source: echo "Web3.js 4.x alpha has been released for early testing and feedback. Checkout doc at https://docs.web3js.org/ "
🚫
Install scripts npm/[email protected]
  • Install script: postinstall
  • Source: echo "WARNING: the web3-bzz api will be deprecated in the next version"
🚫
Install scripts npm/[email protected]
  • Install script: postinstall
  • Source: echo "WARNING: the web3-shh api will be deprecated in the next version"
🚫

View full report↗︎

Next steps

What is an install script?

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Take a deeper look at the dependency

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 [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

package.json Outdated
@@ -27,7 +27,7 @@
"prepare": "npm run build",
"prepublishOnly": "npm test && npm run lint",
"graphql:codegen": "graphql-codegen --config graphql-codegen.yml",
"swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/varbitrum/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
"swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/hackathon-order-status/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: update to a tagged version once released by the backend

@coveralls
Copy link
Collaborator

coveralls commented Jul 29, 2024

Coverage Status

coverage: 79.409% (-0.2%) from 79.583%
when pulling f026389 on feat/order-solution-status
into 97d0315 on main.

@alfetopito alfetopito marked this pull request as ready for review August 1, 2024 16:12
@alfetopito alfetopito requested a review from a team August 1, 2024 16:12
Copy link

Report too large to display inline

View full report↗︎

@alfetopito
Copy link
Contributor Author

Please post merge review

@alfetopito alfetopito merged commit d7e3c54 into main Aug 2, 2024
6 of 9 checks passed
@alfetopito alfetopito deleted the feat/order-solution-status branch August 2, 2024 11:08
@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants