From b793456d557ae93376329e268e09c6afc5433798 Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Mon, 21 Aug 2023 16:46:51 +1000 Subject: [PATCH 1/7] chore: add peer dependency for algosdk --- package.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index cbc1e707..a752ba2d 100644 --- a/package.json +++ b/package.json @@ -32,9 +32,11 @@ "semver": "7.5.2" }, "dependencies": { - "algosdk": "^2.3.0", "buffer": "^6.0.3" }, + "peerDependencies": { + "algosdk": "^2.3.0" + }, "devDependencies": { "@commitlint/cli": "^17.6.5", "@commitlint/config-conventional": "^17.6.5", @@ -44,6 +46,8 @@ "@tsconfig/node16": "^1.0.4", "@types/jest": "^29.5.2", "@types/uuid": "^9.0.2", + "algosdk": "^2.3.0", + "better-npm-audit": "^3.7.3", "conventional-changelog-conventionalcommits": "^6.0.0", "copyfiles": "^2.4.1", "dotenv-cli": "^7.2.1", @@ -58,8 +62,7 @@ "typedoc": "^0.24.8", "typedoc-plugin-markdown": "^3.15.3", "typescript": "^5.1.3", - "uuid": "^9.0.0", - "better-npm-audit": "^3.7.3" + "uuid": "^9.0.0" }, "release": { "branches": [ From f2f9c72ff8e27588e488c21b5edc50d914d53fcc Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Mon, 21 Aug 2023 16:57:59 +1000 Subject: [PATCH 2/7] docs: updated documents --- docs/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/README.md b/docs/README.md index c3b6e4e5..78113de1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,6 +24,22 @@ This library can be installed from NPM using your favourite npm client, e.g.: npm install @algorandfoundation/algokit-utils ``` +## Peer Dependencies + +This library requires `algosdk` as a peer dependency. Ensure you have it installed in your project + +- If you have `check-peer-dependencies` installed: + +``` +npx check-peer-dependencies --install +``` + +- Alternatively, simply use: + +``` +npm install algosdk +``` + # Usage To use this library simply include the following at the top of your file: From ac7cbef719da0c975829f0f3682908454cd20548 Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Mon, 21 Aug 2023 17:11:05 +1000 Subject: [PATCH 3/7] chore: adding the package lock file --- package-lock.json | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 993cd5df..e519908c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,6 @@ "version": "0.1.0", "license": "MIT", "dependencies": { - "algosdk": "^2.3.0", "buffer": "^6.0.3" }, "devDependencies": { @@ -21,6 +20,7 @@ "@tsconfig/node16": "^1.0.4", "@types/jest": "^29.5.2", "@types/uuid": "^9.0.2", + "algosdk": "^2.3.0", "better-npm-audit": "^3.7.3", "conventional-changelog-conventionalcommits": "^6.0.0", "copyfiles": "^2.4.1", @@ -40,6 +40,9 @@ }, "engines": { "node": ">=16.0" + }, + "peerDependencies": { + "algosdk": "^2.3.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -3031,6 +3034,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/algo-msgpack-with-bigint/-/algo-msgpack-with-bigint-2.1.1.tgz", "integrity": "sha512-F1tGh056XczEaEAqu7s+hlZUDWwOBT70Eq0lfMpBP2YguSQVyxRbprLq5rELXKQOyOaixTWYhMeMQMzP0U5FoQ==", + "dev": true, "engines": { "node": ">= 10" } @@ -3039,6 +3043,7 @@ "version": "2.4.0", "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-2.4.0.tgz", "integrity": "sha512-sENe6IyUqvhQprfS/7gJAkPC5sX2LI5uc+gXaKNgzKp72UEyXYSoN3h4MZkOlCrOcTSWTJW7605tYgg8nFkflw==", + "dev": true, "dependencies": { "algo-msgpack-with-bigint": "^2.1.1", "buffer": "^6.0.3", @@ -3359,6 +3364,7 @@ "version": "9.1.1", "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-9.1.1.tgz", "integrity": "sha512-pHm4LsMJ6lzgNGVfZHjMoO8sdoRhOzOH4MLmY65Jg70bpxCKu5iOHNJyfF6OyvYw7t8Fpf35RuzUyqnQsj8Vig==", + "dev": true, "engines": { "node": "*" } @@ -3957,6 +3963,7 @@ "version": "3.1.8", "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.8.tgz", "integrity": "sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==", + "dev": true, "dependencies": { "node-fetch": "^2.6.12" } @@ -5552,7 +5559,8 @@ "node_modules/hi-base32": { "version": "0.5.1", "resolved": "https://registry.npmjs.org/hi-base32/-/hi-base32-0.5.1.tgz", - "integrity": "sha512-EmBBpvdYh/4XxsnUybsPag6VikPYnN30td+vQk+GI3qpahVEG9+gTkG0aXVxTjBqQ5T6ijbWIu77O+C5WFWsnA==" + "integrity": "sha512-EmBBpvdYh/4XxsnUybsPag6VikPYnN30td+vQk+GI3qpahVEG9+gTkG0aXVxTjBqQ5T6ijbWIu77O+C5WFWsnA==", + "dev": true }, "node_modules/hook-std": { "version": "3.0.0", @@ -6861,17 +6869,20 @@ "node_modules/js-sha256": { "version": "0.9.0", "resolved": "https://registry.npmjs.org/js-sha256/-/js-sha256-0.9.0.tgz", - "integrity": "sha512-sga3MHh9sgQN2+pJ9VYZ+1LPwXOxuBJBA5nrR5/ofPfuiJBE2hnjsaN8se8JznOmGLN2p49Pe5U/ttafcs/apA==" + "integrity": "sha512-sga3MHh9sgQN2+pJ9VYZ+1LPwXOxuBJBA5nrR5/ofPfuiJBE2hnjsaN8se8JznOmGLN2p49Pe5U/ttafcs/apA==", + "dev": true }, "node_modules/js-sha3": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/js-sha3/-/js-sha3-0.8.0.tgz", - "integrity": "sha512-gF1cRrHhIzNfToc802P800N8PpXS+evLLXfsVpowqmAFR9uwbi89WvXg2QspOmXL8QL86J4T1EpFu+yUkwJY3Q==" + "integrity": "sha512-gF1cRrHhIzNfToc802P800N8PpXS+evLLXfsVpowqmAFR9uwbi89WvXg2QspOmXL8QL86J4T1EpFu+yUkwJY3Q==", + "dev": true }, "node_modules/js-sha512": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/js-sha512/-/js-sha512-0.8.0.tgz", - "integrity": "sha512-PWsmefG6Jkodqt+ePTvBZCSMFgN7Clckjd0O7su3I0+BW2QWUTJNzjktHsztGLhncP2h8mcF9V9Y2Ha59pAViQ==" + "integrity": "sha512-PWsmefG6Jkodqt+ePTvBZCSMFgN7Clckjd0O7su3I0+BW2QWUTJNzjktHsztGLhncP2h8mcF9V9Y2Ha59pAViQ==", + "dev": true }, "node_modules/js-tokens": { "version": "4.0.0", @@ -6908,6 +6919,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-bigint/-/json-bigint-1.0.0.tgz", "integrity": "sha512-SiPv/8VpZuWbvLSMtTDU8hEfrZWg/mH/nV/b4o0CYbSxu1UIQPLdwKOCIyLQX+VIPO5vrLX3i8qtqFyhdPSUSQ==", + "dev": true, "dependencies": { "bignumber.js": "^9.0.0" } @@ -7566,6 +7578,7 @@ "version": "2.6.12", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.12.tgz", "integrity": "sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g==", + "dev": true, "dependencies": { "whatwg-url": "^5.0.0" }, @@ -13207,7 +13220,8 @@ "node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==" + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "dev": true }, "node_modules/traverse": { "version": "0.6.7", @@ -13379,7 +13393,8 @@ "node_modules/tweetnacl": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-1.0.3.tgz", - "integrity": "sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw==" + "integrity": "sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw==", + "dev": true }, "node_modules/type-check": { "version": "0.4.0", @@ -13683,7 +13698,8 @@ "node_modules/vlq": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/vlq/-/vlq-2.0.4.tgz", - "integrity": "sha512-aodjPa2wPQFkra1G8CzJBTHXhgk3EVSwxSWXNPr1fgdFLUb8kvLV1iEb6rFgasIsjP82HWI6dsb5Io26DDnasA==" + "integrity": "sha512-aodjPa2wPQFkra1G8CzJBTHXhgk3EVSwxSWXNPr1fgdFLUb8kvLV1iEb6rFgasIsjP82HWI6dsb5Io26DDnasA==", + "dev": true }, "node_modules/vscode-oniguruma": { "version": "1.7.0", @@ -13710,12 +13726,14 @@ "node_modules/webidl-conversions": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "dev": true }, "node_modules/whatwg-url": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "dev": true, "dependencies": { "tr46": "~0.0.3", "webidl-conversions": "^3.0.0" From 1d8e0cb132569edb62dc634cfcff57bb30684c6c Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Wed, 23 Aug 2023 10:06:22 +1000 Subject: [PATCH 4/7] docs: removed unnecessary explanation --- docs/README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/README.md b/docs/README.md index 78113de1..8851306c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,19 +26,7 @@ npm install @algorandfoundation/algokit-utils ## Peer Dependencies -This library requires `algosdk` as a peer dependency. Ensure you have it installed in your project - -- If you have `check-peer-dependencies` installed: - -``` -npx check-peer-dependencies --install -``` - -- Alternatively, simply use: - -``` -npm install algosdk -``` +This library requires `algosdk` as a peer dependency. Ensure you have it installed in your project. # Usage From 4dfdeb5f7a3379f5211a6c242dd6b63d96d0713d Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Thu, 24 Aug 2023 10:34:58 +1000 Subject: [PATCH 5/7] chore: update algosdk package to latest version --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index a752ba2d..56f0118b 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "buffer": "^6.0.3" }, "peerDependencies": { - "algosdk": "^2.3.0" + "algosdk": "^2.5.0" }, "devDependencies": { "@commitlint/cli": "^17.6.5", @@ -46,7 +46,7 @@ "@tsconfig/node16": "^1.0.4", "@types/jest": "^29.5.2", "@types/uuid": "^9.0.2", - "algosdk": "^2.3.0", + "algosdk": "^2.5.0", "better-npm-audit": "^3.7.3", "conventional-changelog-conventionalcommits": "^6.0.0", "copyfiles": "^2.4.1", From d4a709e5878dfebd98a942a39cff93e3ccb542c6 Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Thu, 24 Aug 2023 10:39:23 +1000 Subject: [PATCH 6/7] chore: add the package lock file --- package-lock.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index e519908c..d17db8d8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,7 +20,7 @@ "@tsconfig/node16": "^1.0.4", "@types/jest": "^29.5.2", "@types/uuid": "^9.0.2", - "algosdk": "^2.3.0", + "algosdk": "^2.5.0", "better-npm-audit": "^3.7.3", "conventional-changelog-conventionalcommits": "^6.0.0", "copyfiles": "^2.4.1", @@ -42,7 +42,7 @@ "node": ">=16.0" }, "peerDependencies": { - "algosdk": "^2.3.0" + "algosdk": "^2.5.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -3040,14 +3040,14 @@ } }, "node_modules/algosdk": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-2.4.0.tgz", - "integrity": "sha512-sENe6IyUqvhQprfS/7gJAkPC5sX2LI5uc+gXaKNgzKp72UEyXYSoN3h4MZkOlCrOcTSWTJW7605tYgg8nFkflw==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-2.5.0.tgz", + "integrity": "sha512-MlbPjjx4utq5sETOE0okF7/Lz0fgoBtRJRvSbRu3GnoybLTq/n6To2ojDAjJMqi+qMDyUBE9fWu+8jdSvozavA==", "dev": true, "dependencies": { "algo-msgpack-with-bigint": "^2.1.1", "buffer": "^6.0.3", - "cross-fetch": "^3.1.5", + "cross-fetch": "^4.0.0", "hi-base32": "^0.5.1", "js-sha256": "^0.9.0", "js-sha3": "^0.8.0", @@ -3960,9 +3960,9 @@ "dev": true }, "node_modules/cross-fetch": { - "version": "3.1.8", - "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.8.tgz", - "integrity": "sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-4.0.0.tgz", + "integrity": "sha512-e4a5N8lVvuLgAWgnCrLr2PP0YyDOTHa9H/Rj54dirp61qXnNq46m82bRhNqIA5VccJtWBvPTFRV3TtvHUKPB1g==", "dev": true, "dependencies": { "node-fetch": "^2.6.12" From fd6a1095d093e5cbe0465113d10736920316b352 Mon Sep 17 00:00:00 2001 From: Negar Abbasi Date: Wed, 30 Aug 2023 12:55:34 +1000 Subject: [PATCH 7/7] chore: indicating algosdk should be installed --- package-lock.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package-lock.json b/package-lock.json index 3813d379..abc16ed6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3008,6 +3008,7 @@ "version": "2.5.0", "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-2.5.0.tgz", "integrity": "sha512-MlbPjjx4utq5sETOE0okF7/Lz0fgoBtRJRvSbRu3GnoybLTq/n6To2ojDAjJMqi+qMDyUBE9fWu+8jdSvozavA==", + "dev": true, "dependencies": { "algo-msgpack-with-bigint": "^2.1.1", "buffer": "^6.0.3",