cowprotocol / cow-sdk

81%

main: 74%

LAST BUILD ON BRANCH small-nit-suggestions

branch: small-nit-suggestions

CHANGE BRANCH

x

Reset

• small-nit-suggestions
• 0.0.9
• 0x-api
• 0x-api-error-tests
• 1.0.0-RC.3
• 1.0.0-RC.4
• 10/eslint-warnings
• 134/fix-auto-generated-enums
• 134/fix-auto-generated-enums_v2
• 2.0-alpha-dist
• 2/unit-tests
• 20/improve-coverage
• 30/sdk-improvements
• 322/quote-id-on-PriceInformation-types
• 322/simplify-quote-metadata
• 332/environment-metadata
• 416-cowswap/add-goerli-chain
• 44/env-variable
• 5/metadata-methods
• 6.x
• 62/export-contract-addresses
• 91/issues-with-app-data-exports
• SDK-AGNOSTIC-LIB
• add-across-draft
• add-cla
• add-executedSurplusFee
• add-id-in-toString
• add-legacy-apis
• add-support-global-imports-jest
• additional-api-optional
• allow-to-set-any-owner
• allow-to-setup-config-for-sdk-polling
• api-util-fns
• audit-yarn
• avsavsavs-patch-1
• base-api
• bridging-sdk
• bridging-sdk-getQuote
• bump-openapi
• change-spelling
• check-order-existance
• chore-pull-abi
• chore/6.0.0-release
• chore/aave-post-order-test
• chore/add-dependabot
• chore/brungee-simplify
• chore/bump-limiter
• chore/bump-version
• chore/bump-version-6.3.0-RC.1
• chore/expose-data-bridging-sdk
• chore/gnosis-bridge-hook-extra-gas
• chore/rc-5.10.0-1
• chore/update-graphql-request
• chore/update-polygon-data
• chore/v5.10.0
• chore/v5.2.1
• chore/v5.3.1
• chore/v6.0.0-RC.22
• chore/verison-5.3.1
• ci-hardening
• clean-quote-metadata-properties
• cli
• composable-cow
• conditional-order-factory
• cow-shed-sdk
• cowsdk-additional-apis
• cowswap-322/quote-metadata
• cowswap-332/generate-doc-hash
• cowswap332/environment-metadata
• cowswap332/fix-ipfs-uploading
• cowswap785/app-data-package
• cowswap977/deprecate-rinkeby
• dependabot/npm_and_yarn/dev-deps-0936415eef
• dependabot/npm_and_yarn/ejs-3.1.7
• dependabot/npm_and_yarn/loader-utils-3.2.1
• devcontainer
• docs/suggested-slippage
• dogfooding
• enforce-interface
• eth-flow/explorer256-ethflow-types
• explorer-prod
• export-more-types
• expose-metadata-methods-from-app-data
• feat/4310_add-arbitrum
• feat/add-gnosis-bridge
• feat/add-polygon-avalanche-networks
• feat/add-tokens-to-new-networks
• feat/add-trading-sdk-to-main
• feat/app-data-3.1.0
• feat/back-off-strategy
• feat/base
• feat/bridge-appData
• feat/bridge-dest-tokens
• feat/bridge-details
• feat/bridge-details-1
• feat/bridge-tx-progress
• feat/bridging-providers-docs
• feat/bridging-sdk-docs
• feat/bunge-order-details
• feat/bungee-provider-dist
• feat/chain-info
• feat/change-snowtrace-to-snowscan
• feat/eth-flow-default-slippage
• feat/executedFee
• feat/export-chain-info
• feat/fix-arbitrum-name
• feat/flexible-request-options
• feat/get-deposit-status
• feat/lens-bnb
• feat/map-supported-networks-util
• feat/monorepo-network-images
• feat/nodejs-build
• feat/order-solution-status
• feat/quote-and-amounts-costs
• feat/quote-limit-order-test
• feat/sc-wallet-order
• feat/sepolia
• feat/shed-and-bridge-update
• feat/sign-step-manager
• feat/subgraph-optional
• feat/swap-for-people
• feat/swap-for-people-cli
• feat/test-branch
• feat/trading-sdk-docs-update
• feat/trading-sdk-dynamic-params
• feat/update-chain-names
• feat/update-examples
• feat/update-node-version
• feat/update-orderbook-api-types
• feature/examples
• feature/examples2
• feature/order-sign-api
• feature/readme-update
• fix-broken-docs
• fix-comment
• fix-editorial
• fix-eth-flow-slippage
• fix-multi-env-queries
• fix-openapi
• fix-publish
• fix-readme
• fix-span-endtimestamp
• fix-t0-set-to-epoc
• fix-t0-set-to-epoc-v5
• fix/add-error-transformer-for-status-information
• fix/add-error-transformer-to-native-price-endpoint
• fix/add-partner-fee
• fix/base-explorer-name
• fix/bnb-bridge-info
• fix/bridge-appData-override
• fix/bridge-custom-receiver
• fix/bridge-hook-gas-estimation
• fix/bridge-quote-errors
• fix/bridge-quote-estimate-gas
• fix/bridge-step-man-async
• fix/bridge-supp-tokens
• fix/bridging-adjustments
• fix/bump-v
• fix/bungee-affiliate-code-fix
• fix/clear-bridge-post-hooks
• fix/cow-shed-types
• fix/cowshed-call-params
• fix/cowshed-creation-gas-limit
• fix/cowshed-version-init-code
• fix/default-slippage
• fix/default-valid-for
• fix/dependencies
• fix/disable-graphql
• fix/docs-build
• fix/export-cowshed
• fix/export-getPartnerFeeBps
• fix/lens-dark-logo
• fix/order-amounts-after-partner-fee
• fix/parner-fee-formula
• fix/presign-flow
• fix/presign-gas
• fix/remove-export
• fix/revert-ethers-update
• fix/subgraph-types
• fix/toggle-trading-logs
• fix/trade-quote-sell-token
• fix/trading-eth-flow
• fix/trading-post-order-add-params
• fix/trading-sdk-amounts
• fix/trading-sdk-docs-update
• fix/trading-sdk-improvements
• fix/trading-sdk-overrides
• fix/trading-sdk-unsigned-order
• fix/ts-compile
• fix/twap-data-params
• fix/update-eth-flow-address
• fix/update-explorer-names
• fix/update-orderbook-open-api
• fix/zksync-flag
• get-state-sdk
• handle-twap-in-orderbook
• handle-unexpected-errors
• hotfix/0.0.16
• hotfix/1.0.1-RC9
• hotfix/update-app-data
• hotfix/v3.1.0
• improve-docs
• is-valid
• jest-node-fetch-refactor
• lens-bsc
• liquidity-order-type
• main
• make-conditional-order-factory-case-insensitive
• marmade-js
• networks-module
• optional-enable-apis
• order-class
• order/total-fee
• paraswap-api
• poll-conditional-orders
• poll-validate
• pr70/follow-up
• preconfigured-orderbook
• price-util-functions
• prices-tests
• proper-cowsdk-types
• properly-export-types
• quote-improvement
• ramirotw/0.0.14
• ramirotw/export-chain-id
• ramirotw/improve-type
• ramirotw/issue-10-subgraph-integration
• ramirotw/mjs-test
• ramirotw/orderId-getTrades
• ramirotw/publish
• ramirotw/subgraph-api
• refactor-appData-tests
• refactoring/dogfooding
• refs/tags/1.0.1-RC.4
• refs/tags/1.0.2-RC.1
• refs/tags/5.10.0-RC.0
• refs/tags/5.3.1-RC.1
• refs/tags/5.8.0-RC.0
• refs/tags/6.1.0-RC.1
• refs/tags/v0.0.10
• refs/tags/v0.0.11
• refs/tags/v0.0.12
• refs/tags/v0.0.15
• refs/tags/v0.0.16
• refs/tags/v0.0.16-RC.0
• refs/tags/v0.1.0
• refs/tags/v1.0.0-RC.1
• refs/tags/v1.0.0-RC.2
• refs/tags/v1.0.0-RC.6
• refs/tags/v1.0.0-RC.7
• refs/tags/v1.0.0-RC.8
• refs/tags/v1.0.1-RC.0
• refs/tags/v1.0.1-RC.1
• refs/tags/v1.0.1-RC.10
• refs/tags/v1.0.1-RC.2
• refs/tags/v1.0.1-RC.3
• refs/tags/v1.0.1-RC.4
• refs/tags/v1.0.1-RC.5
• refs/tags/v1.0.1-RC.6
• refs/tags/v1.0.1-RC.7
• refs/tags/v1.0.1-RC.8
• refs/tags/v1.0.1-RC9
• refs/tags/v1.0.2-RC.0
• refs/tags/v1.0.2-RC.1
• refs/tags/v1.0.2-RC.3
• refs/tags/v1.0.2-RC.4
• refs/tags/v1.0.2-RC.5
• refs/tags/v1.0.2-RC.6
• refs/tags/v1.0.2-RC.7
• refs/tags/v2.0.0
• refs/tags/v2.0.0-alpha.0
• refs/tags/v2.0.0-alpha.1
• refs/tags/v2.0.0-alpha.2
• refs/tags/v2.0.0-alpha.3
• refs/tags/v2.0.0-alpha.4
• refs/tags/v2.0.0-alpha.5
• refs/tags/v2.0.0-alpha.6
• refs/tags/v2.0.1
• refs/tags/v2.0.2
• refs/tags/v2.0.3
• refs/tags/v2.0.4
• refs/tags/v2.0.5
• refs/tags/v2.0.6
• refs/tags/v2.1.0
• refs/tags/v2.2.0
• refs/tags/v2.2.1
• refs/tags/v2.3.0
• refs/tags/v2.3.0-rc.0
• refs/tags/v2.3.0-rc.1
• refs/tags/v2.3.0-rc.10
• refs/tags/v2.3.0-rc.2
• refs/tags/v2.3.0-rc.3
• refs/tags/v2.3.0-rc.4
• refs/tags/v2.3.0-rc.5
• refs/tags/v2.3.0-rc.6
• refs/tags/v2.3.0-rc.7
• refs/tags/v2.3.0-rc.8
• refs/tags/v2.3.1
• refs/tags/v2.4.0-rc.0
• refs/tags/v2.4.0-rc0
• refs/tags/v3.0.0
• refs/tags/v3.0.0-rc.0
• refs/tags/v3.0.0-rc.1
• refs/tags/v3.0.0-rc.3
• refs/tags/v3.0.0-rc.4
• refs/tags/v3.0.0-rc.5
• refs/tags/v3.0.0-rc.6
• refs/tags/v3.0.0-rc.8
• refs/tags/v3.0.0-rc.9
• refs/tags/v3.0.1
• refs/tags/v4.0.0
• refs/tags/v4.0.1
• refs/tags/v4.0.2
• refs/tags/v4.0.3
• refs/tags/v4.0.4
• refs/tags/v4.0.5
• refs/tags/v4.0.6
• refs/tags/v4.0.7
• refs/tags/v4.1.0
• refs/tags/v5.0.0
• refs/tags/v5.1.0
• refs/tags/v5.10.0
• refs/tags/v5.10.0-RC.0
• refs/tags/v5.10.0-RC.1
• refs/tags/v5.10.0-RC.2
• refs/tags/v5.10.1
• refs/tags/v5.10.1-RC.0
• refs/tags/v5.10.2
• refs/tags/v5.10.2-RC.0
• refs/tags/v5.10.3
• refs/tags/v5.11.0-RC.0
• refs/tags/v5.2.0
• refs/tags/v5.2.1
• refs/tags/v5.3.0
• refs/tags/v5.3.0-RC.0
• refs/tags/v5.3.0-RC.1
• refs/tags/v5.3.0-RC.2
• refs/tags/v5.3.1
• refs/tags/v5.3.1-RC.0
• refs/tags/v5.3.1-RC.1
• refs/tags/v5.3.1-RC.2
• refs/tags/v5.3.1-RC.3
• refs/tags/v5.3.2
• refs/tags/v5.3.3
• refs/tags/v5.4.0
• refs/tags/v5.4.0-RC.0
• refs/tags/v5.4.1
• refs/tags/v5.4.1-RC.0
• refs/tags/v5.5.1
• refs/tags/v5.6.0
• refs/tags/v5.7.0
• refs/tags/v5.7.0-RC.0
• refs/tags/v5.7.1
• refs/tags/v5.8.0
• refs/tags/v5.8.0-RC.0
• refs/tags/v5.8.0-RC.1
• refs/tags/v5.8.0-RC.2
• refs/tags/v5.8.0-RC.3
• refs/tags/v5.8.0-RC.4
• refs/tags/v5.8.0-RC.5
• refs/tags/v5.8.0-RC.6
• refs/tags/v5.8.0-RC.7
• refs/tags/v5.8.0-RC.8
• refs/tags/v5.8.0-RC.9
• refs/tags/v5.9.0
• refs/tags/v6.0.0
• refs/tags/v6.0.0-RC-bungee.0
• refs/tags/v6.0.0-RC.0
• refs/tags/v6.0.0-RC.10
• refs/tags/v6.0.0-RC.11
• refs/tags/v6.0.0-RC.12
• refs/tags/v6.0.0-RC.13
• refs/tags/v6.0.0-RC.14
• refs/tags/v6.0.0-RC.16
• refs/tags/v6.0.0-RC.17
• refs/tags/v6.0.0-RC.18
• refs/tags/v6.0.0-RC.19
• refs/tags/v6.0.0-RC.2
• refs/tags/v6.0.0-RC.20
• refs/tags/v6.0.0-RC.21
• refs/tags/v6.0.0-RC.22
• refs/tags/v6.0.0-RC.23
• refs/tags/v6.0.0-RC.25
• refs/tags/v6.0.0-RC.26
• refs/tags/v6.0.0-RC.27
• refs/tags/v6.0.0-RC.28
• refs/tags/v6.0.0-RC.29
• refs/tags/v6.0.0-RC.3
• refs/tags/v6.0.0-RC.30
• refs/tags/v6.0.0-RC.31
• refs/tags/v6.0.0-RC.32
• refs/tags/v6.0.0-RC.34
• refs/tags/v6.0.0-RC.35
• refs/tags/v6.0.0-RC.36
• refs/tags/v6.0.0-RC.37
• refs/tags/v6.0.0-RC.38
• refs/tags/v6.0.0-RC.39
• refs/tags/v6.0.0-RC.4
• refs/tags/v6.0.0-RC.40
• refs/tags/v6.0.0-RC.42
• refs/tags/v6.0.0-RC.43
• refs/tags/v6.0.0-RC.44
• refs/tags/v6.0.0-RC.46
• refs/tags/v6.0.0-RC.47
• refs/tags/v6.0.0-RC.48
• refs/tags/v6.0.0-RC.49
• refs/tags/v6.0.0-RC.5
• refs/tags/v6.0.0-RC.50
• refs/tags/v6.0.0-RC.51
• refs/tags/v6.0.0-RC.60
• refs/tags/v6.0.0-RC.61
• refs/tags/v6.0.0-RC.63
• refs/tags/v6.0.0-RC.64
• refs/tags/v6.0.0-RC.65
• refs/tags/v6.0.0-RC.66
• refs/tags/v6.0.0-RC.67
• refs/tags/v6.0.0-RC.68
• refs/tags/v6.0.0-RC.69
• refs/tags/v6.0.0-RC.7
• refs/tags/v6.0.0-RC.70
• refs/tags/v6.0.0-RC.71
• refs/tags/v6.0.0-RC.72
• refs/tags/v6.0.0-RC.73
• refs/tags/v6.0.0-RC.74
• refs/tags/v6.0.0-RC.75
• refs/tags/v6.0.0-RC.76
• refs/tags/v6.0.0-RC.77
• refs/tags/v6.0.0-RC.78
• refs/tags/v6.0.0-RC.79
• refs/tags/v6.0.0-RC.80
• refs/tags/v6.0.0-RC.9
• refs/tags/v6.1.0
• refs/tags/v6.1.0-RC.0
• refs/tags/v6.1.0-RC.1
• refs/tags/v6.1.0-lens-bsc.0
• refs/tags/v6.1.0-lens-bsc.1
• refs/tags/v6.1.0-lens-bsc.2
• refs/tags/v6.1.0-lens-bsc.3
• refs/tags/v6.1.0-lens-bsc.4
• refs/tags/v6.1.1
• refs/tags/v6.2.0
• refs/tags/v6.2.0-RC.0
• refs/tags/v6.2.0-RC.1
• refs/tags/v6.2.0-RC.2
• refs/tags/v6.2.0-RC.3
• refs/tags/v6.2.0-RC.4
• refs/tags/v6.2.0-RC.5
• refs/tags/v6.2.0-RC.6
• refs/tags/v6.2.0-lens-bsc.0
• refs/tags/v6.3.0
• refs/tags/v6.3.0-RC.0
• refs/tags/v6.3.1
• refs/tags/v6.3.2
• refs/tags/v6.3.2-RC.0
• refs/tags/v6.3.2-RC.1
• refs/tags/v6.3.2-RC.2
• refs/tags/v6.3.3
• refs/tags/vv5.10.0-RC.0
• release/5.10.0-RC.2
• release/v3.0
• release/v3.1.0
• remove-goerli
• rndlabs-chore-editorial2
• rndlabs-chore-repo-prep
• satsuma-replace-url
• satsuma-test
• shoom3301-patch-1
• simplify-constructors
• simplify-readme
• slippage-calculation
• slippage-calculation-implementation
• slippage-calculation-rounding
• slippage-calculation-vol
• slippage-calculation-volume
• slippage-comments
• smarter-twap-indexing
• snyk-fix-562eeeeaccf92a66074357f0d1a40d99
• snyk-fix-62a49c5dd5732eefc91b5764400453cd
• snyk-fix-9096cae2ea175d259a3c099292199c4d
• snyk-fix-d134f11caa18b356d71ece0f290b55d8
• snyk-fix-ffe8171fe0aa6394f622b1cc83c6fc3b
• snyk-upgrade-e471dae60c072e9d5989b6c429f51fa4
• snyk-upgrade-fe83590b2120ab6d3844610845ef9b00
• tag-as-next
• test-cabinet
• test-order-in-orderbook
• test-poll-happy-and-noauth
• test-twap-poll-validate
• throw-for-unknown
• twap-test-structure
• update-app-data-version
• update-contracts-dependency
• update-readme
• update-sdk
• update-sdk-test
• update-services-openapi
• update-totalFee-calculation
• update-types
• update/app-data
• updated-ethflow-api-response
• use-lates-app-data
• v2
• v2-fixes
• v5
• version-eth-flow
• version/5.5.1
• weiroll-utils

Build # 5952509112

Build Type

Pull #147

github

Committed by web-flow

Commit Message

Change jsdoc

Co-authored-by: mfw78 <53399572+mfw78@users.noreply.github.com>

Pull Request Pull Request #147: Small nit suggestions

Run Details

168 of 224 branches covered (75.0%)

Branch coverage included in aggregate %.

38 of 38 new or added lines in 4 files covered. (100.0%)

336 of 395 relevant lines covered (85.06%)

18.44 hits per line