{"_id":"@dontrolle/mangrove.js","_rev":"3-c96f65d13e1ec24c5afbe60f5900f1ae","name":"@dontrolle/mangrove.js","dist-tags":{"latest":"1.4.25"},"versions":{"1.4.22":{"name":"@dontrolle/mangrove.js","version":"1.4.22","author":{"name":"Mangrove DAO"},"description":"A Typescript SDK for the Mangrove Protocol.","license":"(BSD-2-Clause OR BSD-3-Clause)","main":"dist/nodejs/index.js","browser":"dist/browser/mangrove.min.js","scripts":{"package-version":"echo $npm_package_version","precommit":"lint-staged","prepack":"pinst --disable && yarn run build","postpack":"pinst --enable","postinstall":"husky install","lint":"npx eslint ./src/*.ts","build":"npm-run-all -pn --aggregate-output typechain lint && npm-run-all -pn --aggregate-output tscbuild esbuild && yarn make-cli-executable","make-cli-executable":"shx chmod u+x ./dist/nodejs/cli/mgv.js","clean":"rimraf dist","test-with-dependencies":"yarn workspaces foreach -vpiR --topological-dev --from $npm_package_name run test","test":"npm-run-all --parallel test:unit test:integration","test:integration":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/integration-tests.json --exit","test:unit":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/unit-tests.json --exit","test:coverage":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --config test/mocha/config/coverage-tests.json --exit ","typechain":"ts-node --transpileOnly src/util/runTypechain.ts","doc":"cd src && yarn typedoc --options ../typedoc.json index.ts","tscbuild":"tsc --build","esbuild":"node esbuild.mjs"},"imports":{"#package.json":"./package.json"},"bin":{"mgv":"dist/nodejs/cli/mgv.js"},"repository":{"type":"git","url":"git+https://github.com/mangrovedao/mangrove.js.git"},"keywords":["mangrove","mangrove.js","mangrove exchange","decentralized finance","defi","ethereum"],"nyc":{"include":["src/**/*.ts"]},"lint-staged":{"*.{js,ts,css,md,json,mjs}":"prettier --write"},"dependencies":{"@ethersproject/experimental":"^5.7.0","@mangrovedao/mangrove-core":"^1.5.7","@mangrovedao/reliable-event-subscriber":"1.1.29","@types/object-inspect":"^1.8.1","@types/triple-beam":"^1.3.2","async-mutex":"^0.4.0","big.js":"^6.2.1","deepmerge":"^4.3.1","ethers":"^5.7.2","json-truncate":"^3.0.0","just-clone":"^6.2.0","logform":"^2.5.1","loglevel":"^1.8.1","moize":"^6.1.6","node-cleanup":"^2.1.2","object-inspect":"^1.12.3","triple-beam":"^1.3.0","util":"^0.12.5","yargs":"^17.3.0"},"devDependencies":{"@espendk/json-file-reporter":"^1.4.2","@ethersproject/abi":"^5.7.0","@ethersproject/bytes":"^5.7.0","@ethersproject/hardware-wallets":"^5.7.0","@ethersproject/providers":"^5.7.2","@typechain/ethers-v5":"^10.2.0","@types/big.js":"^6.1.6","@types/chai-as-promised":"^7.1.5","@types/mocha":"^10.0.1","@types/node":"^20.3.1","@types/node-cleanup":"^2.1.2","@types/shelljs":"^0.8.11","@types/yargs":"^17.0.12","@typescript-eslint/eslint-plugin":"^5.59.6","@typescript-eslint/parser":"^5.48.1","chai":"^4.3.7","chai-as-promised":"^7.1.1","chalk":"^4.1.2","cross-env":"^7.0.3","dir-compare":"^4.0.0","esbuild":"^0.18.4","eslint":"^8.31.0","eslint-config-prettier":"^8.8.0","husky":"^8.0.3","lint-staged":"^13.2.0","mkdirp":"^3.0.1","mocha":"^10.2.0","mocha-multi-reporters":"^1.5.1","npm-run-all":"^4.1.5","nyc":"^15.1.0","pinst":"^3.0.0","prettier":"^2.4.1","rimraf":"^5.0.1","shx":"^0.3.4","transparent-proxy":"^1.12.1","ts-essentials":"^9.3.1","ts-mockito":"^2.0.0","ts-node":"^10.9.1","typechain":"^8.1.0","typedoc":"^0.24.7","typescript":"^4.7.0"},"packageManager":"yarn@3.5.0","_id":"@dontrolle/mangrove.js@1.4.22","gitHead":"4f5a8bf8c7d8aea9be2b039b7395be4e4ebc6a28","types":"./dist/nodejs/index.d.ts","bugs":{"url":"https://github.com/mangrovedao/mangrove.js/issues"},"homepage":"https://github.com/mangrovedao/mangrove.js#readme","_nodeVersion":"20.6.1","_npmVersion":"9.8.1","dist":{"integrity":"sha512-gOJrFNzCmOUW3JVvVyjKiBMvvOXg6HHBnG+6crTktR+/v+iuaAyvTVInjv+rut7gQcvp0Th9Ngue5WivK2b5gg==","shasum":"58a67acd5bdb6ddba4b69f0c484431d435c5d7c5","tarball":"https://registry.npmjs.org/@dontrolle/mangrove.js/-/mangrove.js-1.4.22.tgz","fileCount":515,"unpackedSize":6160286,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEsxEGMgrE/1Rcmck9XPkzVAruUCQckXo1VLu9ldqZynAiEA9MAu5mk4NJqDpGLJZd4E85Hsxwi5Vi07xecFWzqlRCQ="}]},"_npmUser":{"name":"dontrolle","email":"troels@mangrove.exchange"},"directories":{},"maintainers":[{"name":"dontrolle","email":"troels@mangrove.exchange"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mangrove.js_1.4.22_1695114035231_0.6156712807708649"},"_hasShrinkwrap":false},"1.4.23":{"name":"@dontrolle/mangrove.js","version":"1.4.23","author":{"name":"Mangrove DAO"},"description":"A Typescript SDK for the Mangrove Protocol.","license":"(BSD-2-Clause OR BSD-3-Clause)","main":"dist/nodejs/index.js","browser":"dist/browser/mangrove.min.js","scripts":{"package-version":"echo $npm_package_version","precommit":"lint-staged","prepack":"pinst --disable && yarn run build","postpack":"pinst --enable","postinstall":"husky install","lint":"npx eslint ./src/*.ts","build":"npm-run-all -pn --aggregate-output typechain lint && npm-run-all -pn --aggregate-output tscbuild esbuild && yarn make-cli-executable","make-cli-executable":"shx chmod u+x ./dist/nodejs/cli/mgv.js","clean":"rimraf dist","test-with-dependencies":"yarn workspaces foreach -vpiR --topological-dev --from $npm_package_name run test","test":"npm-run-all --parallel test:unit test:integration","test:integration":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/integration-tests.json --exit","test:unit":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/unit-tests.json --exit","test:coverage":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --config test/mocha/config/coverage-tests.json --exit ","typechain":"ts-node --transpileOnly src/util/runTypechain.ts","doc":"cd src && yarn typedoc --options ../typedoc.json index.ts","tscbuild":"tsc --build","esbuild":"node esbuild.mjs"},"imports":{"#package.json":"./package.json"},"bin":{"mgv":"dist/nodejs/cli/mgv.js"},"repository":{"type":"git","url":"git+https://github.com/mangrovedao/mangrove.js.git"},"keywords":["mangrove","mangrove.js","mangrove exchange","decentralized finance","defi","ethereum"],"nyc":{"include":["src/**/*.ts"]},"lint-staged":{"*.{js,ts,css,md,json,mjs}":"prettier --write"},"dependencies":{"@ethersproject/experimental":"^5.7.0","@mangrovedao/mangrove-core":"^1.5.7","@mangrovedao/reliable-event-subscriber":"1.1.29","@types/object-inspect":"^1.8.1","@types/triple-beam":"^1.3.2","async-mutex":"^0.4.0","big.js":"^6.2.1","deepmerge":"^4.3.1","ethers":"^5.7.2","json-truncate":"^3.0.0","just-clone":"^6.2.0","logform":"^2.5.1","loglevel":"^1.8.1","moize":"^6.1.6","node-cleanup":"^2.1.2","object-inspect":"^1.12.3","triple-beam":"^1.3.0","util":"^0.12.5","yargs":"^17.3.0"},"devDependencies":{"@espendk/json-file-reporter":"^1.4.2","@ethersproject/abi":"^5.7.0","@ethersproject/bytes":"^5.7.0","@ethersproject/hardware-wallets":"^5.7.0","@ethersproject/providers":"^5.7.2","@typechain/ethers-v5":"^10.2.0","@types/big.js":"^6.1.6","@types/chai-as-promised":"^7.1.5","@types/mocha":"^10.0.1","@types/node":"^20.3.1","@types/node-cleanup":"^2.1.2","@types/shelljs":"^0.8.11","@types/yargs":"^17.0.12","@typescript-eslint/eslint-plugin":"^5.59.6","@typescript-eslint/parser":"^5.48.1","chai":"^4.3.7","chai-as-promised":"^7.1.1","chalk":"^4.1.2","cross-env":"^7.0.3","dir-compare":"^4.0.0","esbuild":"^0.18.4","eslint":"^8.31.0","eslint-config-prettier":"^8.8.0","husky":"^8.0.3","lint-staged":"^13.2.0","mkdirp":"^3.0.1","mocha":"^10.2.0","mocha-multi-reporters":"^1.5.1","npm-run-all":"^4.1.5","nyc":"^15.1.0","pinst":"^3.0.0","prettier":"^2.4.1","rimraf":"^5.0.1","shx":"^0.3.4","transparent-proxy":"^1.12.1","ts-essentials":"^9.3.1","ts-mockito":"^2.0.0","ts-node":"^10.9.1","typechain":"^8.1.0","typedoc":"^0.24.7","typescript":"^4.7.0"},"packageManager":"yarn@3.5.0","types":"./dist/nodejs/index.d.ts","gitHead":"850b14c7f5bc41f9597939fb09ac471ed691a6c8","bugs":{"url":"https://github.com/mangrovedao/mangrove.js/issues"},"homepage":"https://github.com/mangrovedao/mangrove.js#readme","_id":"@dontrolle/mangrove.js@1.4.23","_nodeVersion":"18.17.0","_npmVersion":"9.6.7","dist":{"integrity":"sha512-8bcZZpP1sYRkwaCxPv1+I0SbCX34kF4SMkFulR6Q3mRCQJ65Ie5A1IzpbZt4CvkM6PpUxwp5hWtDAwQPXQ8eNw==","shasum":"75a0f733d14008881e16c9695e6f3d4067a8d0f4","tarball":"https://registry.npmjs.org/@dontrolle/mangrove.js/-/mangrove.js-1.4.23.tgz","fileCount":549,"unpackedSize":6585468,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICc6124dzdihuGGk3V7HxBNAWvlbZZEYsCzB0tP7AGfkAiA7BstupRiYFgRUxrlpysFqlrwEOQ0j8sO16QStOpYG6Q=="}]},"_npmUser":{"name":"dontrolle","email":"troels@mangrove.exchange"},"directories":{},"maintainers":[{"name":"dontrolle","email":"troels@mangrove.exchange"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mangrove.js_1.4.23_1696240621786_0.4182660488434873"},"_hasShrinkwrap":false},"1.4.24":{"name":"@dontrolle/mangrove.js","version":"1.4.24","author":{"name":"Mangrove DAO"},"description":"A Typescript SDK for the Mangrove Protocol.","license":"(BSD-2-Clause OR BSD-3-Clause)","main":"dist/nodejs/index.js","browser":"dist/browser/mangrove.min.js","scripts":{"package-version":"echo $npm_package_version","precommit":"lint-staged","prepack":"pinst --disable && yarn run build","postpack":"pinst --enable","postinstall":"husky install","lint":"npx eslint ./src/*.ts","build":"npm-run-all -pn --aggregate-output typechain lint && npm-run-all -pn --aggregate-output tscbuild esbuild && yarn make-cli-executable","make-cli-executable":"shx chmod u+x ./dist/nodejs/cli/mgv.js","clean":"rimraf dist","test-with-dependencies":"yarn workspaces foreach -vpiR --topological-dev --from $npm_package_name run test","test":"npm-run-all --parallel test:unit test:integration","test:integration":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/integration-tests.json --exit","test:unit":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/unit-tests.json --exit","test:coverage":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --config test/mocha/config/coverage-tests.json --exit ","typechain":"ts-node --transpileOnly src/util/runTypechain.ts","doc":"cd src && yarn typedoc --options ../typedoc.json index.ts","tscbuild":"tsc --build","esbuild":"node esbuild.mjs"},"imports":{"#package.json":"./package.json"},"bin":{"mgv":"dist/nodejs/cli/mgv.js"},"repository":{"type":"git","url":"git+https://github.com/mangrovedao/mangrove.js.git"},"keywords":["mangrove","mangrove.js","mangrove exchange","decentralized finance","defi","ethereum"],"nyc":{"include":["src/**/*.ts"]},"lint-staged":{"*.{js,ts,css,md,json,mjs}":"prettier --write"},"dependencies":{"@ethersproject/experimental":"^5.7.0","@mangrovedao/mangrove-core":"^1.5.7","@mangrovedao/reliable-event-subscriber":"1.1.29","@types/object-inspect":"^1.8.1","@types/triple-beam":"^1.3.2","async-mutex":"^0.4.0","big.js":"^6.2.1","deepmerge":"^4.3.1","ethers":"^5.7.2","json-truncate":"^3.0.0","just-clone":"^6.2.0","logform":"^2.5.1","loglevel":"^1.8.1","moize":"^6.1.6","node-cleanup":"^2.1.2","object-inspect":"^1.12.3","triple-beam":"^1.3.0","util":"^0.12.5","yargs":"^17.3.0"},"devDependencies":{"@espendk/json-file-reporter":"^1.4.2","@ethersproject/abi":"^5.7.0","@ethersproject/bytes":"^5.7.0","@ethersproject/hardware-wallets":"^5.7.0","@ethersproject/providers":"^5.7.2","@typechain/ethers-v5":"^10.2.0","@types/big.js":"^6.1.6","@types/chai-as-promised":"^7.1.5","@types/mocha":"^10.0.1","@types/node":"^20.3.1","@types/node-cleanup":"^2.1.2","@types/shelljs":"^0.8.11","@types/yargs":"^17.0.12","@typescript-eslint/eslint-plugin":"^5.59.6","@typescript-eslint/parser":"^5.48.1","chai":"^4.3.7","chai-as-promised":"^7.1.1","chalk":"^4.1.2","cross-env":"^7.0.3","dir-compare":"^4.0.0","esbuild":"^0.18.4","eslint":"^8.31.0","eslint-config-prettier":"^8.8.0","husky":"^8.0.3","lint-staged":"^13.2.0","mkdirp":"^3.0.1","mocha":"^10.2.0","mocha-multi-reporters":"^1.5.1","npm-run-all":"^4.1.5","nyc":"^15.1.0","pinst":"^3.0.0","prettier":"^2.4.1","rimraf":"^5.0.1","shx":"^0.3.4","transparent-proxy":"^1.12.1","ts-essentials":"^9.3.1","ts-mockito":"^2.0.0","ts-node":"^10.9.1","typechain":"^8.1.0","typedoc":"^0.24.7","typescript":"^4.7.0"},"packageManager":"yarn@3.5.0","types":"./dist/nodejs/index.d.ts","gitHead":"850b14c7f5bc41f9597939fb09ac471ed691a6c8","bugs":{"url":"https://github.com/mangrovedao/mangrove.js/issues"},"homepage":"https://github.com/mangrovedao/mangrove.js#readme","_id":"@dontrolle/mangrove.js@1.4.24","_nodeVersion":"18.17.0","_npmVersion":"9.6.7","dist":{"integrity":"sha512-1NKClAybJyc2hJbyjRror7W6NJlcJwBLa5c/o2Xjw/jyEtsp47gl9dxQhwPpTMU0QT9IEU0TaPggYBITbmyMEg==","shasum":"d1494a392c1841ced8ce5a10fe00edc02d745b4c","tarball":"https://registry.npmjs.org/@dontrolle/mangrove.js/-/mangrove.js-1.4.24.tgz","fileCount":511,"unpackedSize":6157952,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICY4LC/5zpMEdoAKmod4drY8VIBKOVmtw8WbJ1UmWR3mAiBaaQq7frQGItNIXw+3nWbH8kByAawrqAcOyVaVu4kUWQ=="}]},"_npmUser":{"name":"dontrolle","email":"troels@mangrove.exchange"},"directories":{},"maintainers":[{"name":"dontrolle","email":"troels@mangrove.exchange"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mangrove.js_1.4.24_1696246992034_0.7976344592699964"},"_hasShrinkwrap":false},"1.4.25":{"name":"@dontrolle/mangrove.js","version":"1.4.25","author":{"name":"Mangrove DAO"},"description":"A Typescript SDK for the Mangrove Protocol.","license":"(BSD-2-Clause OR BSD-3-Clause)","main":"dist/nodejs/index.js","browser":"dist/browser/mangrove.min.js","scripts":{"package-version":"echo $npm_package_version","precommit":"lint-staged","prepack":"pinst --disable && yarn run build","postpack":"pinst --enable","postinstall":"husky install","lint":"npx eslint ./src/*.ts","build":"npm-run-all -pn --aggregate-output typechain lint && npm-run-all -pn --aggregate-output tscbuild esbuild && yarn make-cli-executable","make-cli-executable":"shx chmod u+x ./dist/nodejs/cli/mgv.js","clean":"rimraf dist","test-with-dependencies":"yarn workspaces foreach -vpiR --topological-dev --from $npm_package_name run test","test":"npm-run-all --parallel test:unit test:integration","test:integration":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/integration-tests.json --exit","test:unit":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --parallel --config test/mocha/config/unit-tests.json --exit","test:coverage":"cross-env NODE_ENV=test nyc --reporter=lcov mocha --config test/mocha/config/coverage-tests.json --exit ","typechain":"ts-node --transpileOnly src/util/runTypechain.ts","doc":"cd src && yarn typedoc --options ../typedoc.json index.ts","tscbuild":"tsc --build","esbuild":"node esbuild.mjs"},"imports":{"#package.json":"./package.json"},"bin":{"mgv":"dist/nodejs/cli/mgv.js"},"repository":{"type":"git","url":"git+https://github.com/mangrovedao/mangrove.js.git"},"keywords":["mangrove","mangrove.js","mangrove exchange","decentralized finance","defi","ethereum"],"nyc":{"include":["src/**/*.ts"]},"lint-staged":{"*.{js,ts,css,md,json,mjs}":"prettier --write"},"dependencies":{"@ethersproject/experimental":"^5.7.0","@mangrovedao/mangrove-core":"^1.5.7","@mangrovedao/reliable-event-subscriber":"1.1.29","@types/object-inspect":"^1.8.1","@types/triple-beam":"^1.3.2","async-mutex":"^0.4.0","big.js":"^6.2.1","deepmerge":"^4.3.1","ethers":"^5.7.2","json-truncate":"^3.0.0","just-clone":"^6.2.0","logform":"^2.5.1","loglevel":"^1.8.1","moize":"^6.1.6","node-cleanup":"^2.1.2","object-inspect":"^1.12.3","triple-beam":"^1.3.0","util":"^0.12.5","yargs":"^17.3.0"},"devDependencies":{"@espendk/json-file-reporter":"^1.4.2","@ethersproject/abi":"^5.7.0","@ethersproject/bytes":"^5.7.0","@ethersproject/hardware-wallets":"^5.7.0","@ethersproject/providers":"^5.7.2","@typechain/ethers-v5":"^10.2.0","@types/big.js":"^6.1.6","@types/chai-as-promised":"^7.1.5","@types/mocha":"^10.0.1","@types/node":"^20.3.1","@types/node-cleanup":"^2.1.2","@types/shelljs":"^0.8.11","@types/yargs":"^17.0.12","@typescript-eslint/eslint-plugin":"^5.59.6","@typescript-eslint/parser":"^5.48.1","chai":"^4.3.7","chai-as-promised":"^7.1.1","chalk":"^4.1.2","cross-env":"^7.0.3","dir-compare":"^4.0.0","esbuild":"^0.18.4","eslint":"^8.31.0","eslint-config-prettier":"^8.8.0","husky":"^8.0.3","lint-staged":"^13.2.0","mkdirp":"^3.0.1","mocha":"^10.2.0","mocha-multi-reporters":"^1.5.1","npm-run-all":"^4.1.5","nyc":"^15.1.0","pinst":"^3.0.0","prettier":"^2.4.1","rimraf":"^5.0.1","shx":"^0.3.4","transparent-proxy":"^1.12.1","ts-essentials":"^9.3.1","ts-mockito":"^2.0.0","ts-node":"^10.9.1","typechain":"^8.1.0","typedoc":"^0.24.7","typescript":"^4.7.0"},"packageManager":"yarn@3.5.0","types":"./dist/nodejs/index.d.ts","gitHead":"850b14c7f5bc41f9597939fb09ac471ed691a6c8","bugs":{"url":"https://github.com/mangrovedao/mangrove.js/issues"},"homepage":"https://github.com/mangrovedao/mangrove.js#readme","_id":"@dontrolle/mangrove.js@1.4.25","_nodeVersion":"18.17.0","_npmVersion":"9.6.7","dist":{"integrity":"sha512-hK0VhsCMuQPgne42YJUhtExKn2hQlW4F0PTMpQHFv+W2AoU6D1EGSIp5BJabMJ1ml12FlswKA5THUD+naGGEuw==","shasum":"958d5ff9b6d0bdfef9710a031707673ae765b673","tarball":"https://registry.npmjs.org/@dontrolle/mangrove.js/-/mangrove.js-1.4.25.tgz","fileCount":511,"unpackedSize":7300792,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDVTkcb+IYPXDMHadqWp/g/x6d/8WhKcV9ryOa03yC4awIgJsST/g9hhfUgLqGDYIwu/SgfQb6U2pJSJSobByCPgFg="}]},"_npmUser":{"name":"dontrolle","email":"troels@mangrove.exchange"},"directories":{},"maintainers":[{"name":"dontrolle","email":"troels@mangrove.exchange"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mangrove.js_1.4.25_1696249618501_0.11084723848092337"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-19T09:00:35.044Z","1.4.22":"2023-09-19T09:00:35.571Z","modified":"2023-10-02T12:26:59.141Z","1.4.23":"2023-10-02T09:57:02.058Z","1.4.24":"2023-10-02T11:43:12.328Z","1.4.25":"2023-10-02T12:26:58.906Z"},"maintainers":[{"name":"dontrolle","email":"troels@mangrove.exchange"}],"description":"A Typescript SDK for the Mangrove Protocol.","homepage":"https://github.com/mangrovedao/mangrove.js#readme","keywords":["mangrove","mangrove.js","mangrove exchange","decentralized finance","defi","ethereum"],"repository":{"type":"git","url":"git+https://github.com/mangrovedao/mangrove.js.git"},"author":{"name":"Mangrove DAO"},"bugs":{"url":"https://github.com/mangrovedao/mangrove.js/issues"},"license":"(BSD-2-Clause OR BSD-3-Clause)","readme":"[![CI](https://github.com/mangrovedao/mangrove.js/actions/workflows/node.js.yml/badge.svg)](https://github.com/mangrovedao/mangrove.js/actions/workflows/node.js.yml) [![Coverage Status](https://coveralls.io/repos/github/mangrovedao/mangrove.js/badge.svg)](https://coveralls.io/github/mangrovedao/mangrove.js)\n\nThis repo contains the SDK for developing TypeScript (and JavaScript) apps using the Mangrove.\n\nThe core contracts for Mangrove with example Solidity offer logics live in the [mangrove-core](https://github.com/mangrovedao/mangrove-core) repo.\n\n# Documentation\n\nIf you are looking for the Mangrove developer documentation, the main site to go to is [docs.mangrove.exchange](https://docs.mangrove.exchange).\n\n# Prerequisites\n\nFor Linux or macOS everything should work out of the box, if you are using Windows, then we recommend installing everything from within WSL2 and expect some quirks.\n\n1. [Node.js](https://nodejs.org/en/) 14.14+, we recommend installation through [nvm](https://github.com/nvm-sh/nvm#installing-and-updating), e.g.:\n\n   ```shell\n   $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash\n   # Reopen shell\n   $ nvm install --lts\n   ```\n\n2. [Yarn 2](https://yarnpkg.com/getting-started/install), with Node.js >= 16.10:\n\n   ```shell\n   $ corepack enable\n   ```\n\n3. [Foundry](https://book.getfoundry.sh/getting-started/installation.html):\n\n   ```shell\n   $ curl -L https://foundry.paradigm.xyz | bash\n   # Reopen shell\n   $ foundryup\n   ```\n\n4. Clone the git repo with sub-modules\n\n   ```shell\n   $ git clone --recurse-submodules https://github.com/mangrovedao/mangrove.js.git\n   # Or set the global git config once: git config --global submodule.recurse true\n   ```\n\n# Usage\n\nThe following sections describe the most common use cases in this repo.\n\n## Initial setup\n\nAfter first cloning the repo, you should run `yarn install` in the root folder.\n\n```shell\n$ yarn install\n```\n\nThen you need to setup the local environment (still in the root folder):\n\n```shell\n$ cp .env.local.example .env.test.local\n```\n\nThen open `.env.test.local` in your favorite editor and put in settings for, e.g., node urls, pointing to a node provider, like, for instance, [Alchemy](https://www.alchemy.com/).\n\n## Build\n\nTo build, run\n\n```shell\n$ yarn build\n```\n\nIf you encounter issues with JavaScript memory consumption, then try increasing the max available space for heap, and try again:\n\n```shell\n$ export NODE_OPTIONS=\"$NODE_OPTIONS --max_old_space_size=4096\"\n$ yarn build\n```\n\n## Test\n\nTo run tests, run\n\n```shell\n$ yarn test\n```\n\n## Yarn usage details\n\n⚠️  Be aware that when googling Yarn commands, it's often not clear whether the results pertain to Yarn 1 (aka 'Classic') or Yarn 2+. Currently (November 2021), most examples and much tool support is implicitly engineered towards Yarn 1.\n\n### Lifecycle scripts and Yarn 2\n\nYarn 2 deliberately only supports a subset of the lifecycle scripts supported by npm. So when adding/modifying lifecycle scripts, you should consult Yarn 2's documentation on the subject: https://yarnpkg.com/advanced/lifecycle-scripts#gatsby-focus-wrapper .\n\n# Git hooks and Husky\n\nWe use [Husky](https://typicode.github.io/husky/#/) to manage our Git hooks.\n\nThe Git hook scripts are in the `.husky/` folder.\n","readmeFilename":"README.md"}