{"_id":"@benddao/bend-downpayment","name":"@benddao/bend-downpayment","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@benddao/bend-downpayment","version":"1.0.0","description":"BendDAO downpayment smart contracts","author":{"name":"BendDAO"},"license":"MIT","private":false,"keywords":["benddao","downpayment"],"engines":{"node":">=8.3.0"},"homepage":"https://benddao.xyz/","bugs":{"url":"https://github.com/BendDAO/bend-downpayment/issues"},"repository":{"type":"git","url":"git+https://github.com/BendDAO/bend-downpayment.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"scripts":{"typechain":"TS_NODE_TRANSPILE_ONLY=true hardhat typechain","clean":"hardhat clean","compile":"TS_NODE_TRANSPILE_ONLY=true hardhat compile","compile:force":"hardhat compile --force","format:check":"prettier --check '**/*.{js,jsx,ts,tsx,sol,json,yaml,md}'","format:write":"prettier --write '**/*.{js,jsx,ts,tsx,sol,json,yaml,md}'","lint":"yarn lint:sol && yarn lint:ts && yarn format:check","lint:sol":"solhint  'contracts/**/*.sol'","lint:ts":"eslint '**/*.{js,jsx,ts,tsx}'","prepare":"husky install","test":"hardhat test","test:gas":"REPORT_GAS=true hardhat test","test:coverage":"TS_NODE_TRANSPILE_ONLY=true hardhat coverage && hardhat compile --force","release":"release-it","prepublishOnly":"npm run compile"},"devDependencies":{"@commitlint/cli":"^17.0.2","@commitlint/config-conventional":"^16.2.1","@nomicfoundation/hardhat-network-helpers":"^1.0.3","@nomiclabs/hardhat-ethers":"^2.1.0","@nomiclabs/hardhat-etherscan":"^3.0.3","@nomiclabs/hardhat-waffle":"^2.0.3","@openzeppelin/hardhat-upgrades":"^1.20.0","@typechain/ethers-v5":"^10.1.0","@typechain/hardhat":"^6.1.2","@types/chai":"^4.2.21","@types/lowdb":"^1.0.9","@types/mocha":"^9.0.0","@types/node":"^12.0.0","@typescript-eslint/eslint-plugin":"^4.29.1","@typescript-eslint/parser":"^4.29.1","axios-logger":"^2.6.1","chai":"^4.2.0","dotenv":"^10.0.0","eslint":"^7.29.0","eslint-config-prettier":"^8.3.0","eslint-config-standard":"^16.0.3","eslint-plugin-import":"^2.23.4","eslint-plugin-node":"^11.1.0","eslint-plugin-prettier":"^3.4.0","eslint-plugin-promise":"^5.1.0","ethereum-waffle":"^3.4.4","ethereumjs-util":"^7.1.5","ethers":"^5.6.4","hardhat":"^2.9.3","hardhat-abi-exporter":"^2.8.0","hardhat-gas-reporter":"^1.0.8","husky":"^7.0.4","lowdb":"^1.0.0","prettier":"^2.3.2","@opensea/seaport-js":"^1.2.0","prettier-plugin-solidity":"^1.0.0-beta.13","release-it":"^14.14.2","solhint":"^3.3.7","solidity-coverage":"^0.7.21","tmp-promise":"^3.0.3","ts-node":"^10.1.0","typechain":"^8.1.0","typescript":"^4.5.2"},"dependencies":{"@openzeppelin/contracts":"4.6.0","@openzeppelin/contracts-upgradeable":"4.6.0","@x2y2-io/sdk":"^0.1.4"},"gitHead":"dd01a560ffe569d48a987f4d366f3bc739e84662","_id":"@benddao/bend-downpayment@1.0.0","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-doT2SbYjvU4grXpn0qb+LHPG9IFXBOYcue2/xwb6Y5sK4B3syQVSg5w0EY1+zT/RGs9gGb94D6uq2SVP4LGXLw==","shasum":"35829bddac3da58e6b8e8bc0c7455ee3ffb9d93d","tarball":"https://registry.npmjs.org/@benddao/bend-downpayment/-/bend-downpayment-1.0.0.tgz","fileCount":63,"unpackedSize":217226,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCHiv6Uc00kYsaHjt3gM2Mxrbnflf61O9ZMofqfKLtscwIhALVgg1/41NEuWm/jtPj1U8uHAhivonT/psW2BSwJgPlu"}]},"_npmUser":{"name":"developerbend","email":"developer@benddao.xyz"},"directories":{},"maintainers":[{"name":"developerbend","email":"developer@benddao.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bend-downpayment_1.0.0_1693012978096_0.22214039954831777"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-26T01:22:58.006Z","1.0.0":"2023-08-26T01:22:58.302Z","modified":"2023-08-26T01:22:58.634Z"},"maintainers":[{"name":"developerbend","email":"developer@benddao.xyz"}],"description":"BendDAO downpayment smart contracts","homepage":"https://benddao.xyz/","keywords":["benddao","downpayment"],"repository":{"type":"git","url":"git+https://github.com/BendDAO/bend-downpayment.git"},"author":{"name":"BendDAO"},"bugs":{"url":"https://github.com/BendDAO/bend-downpayment/issues"},"license":"MIT","readme":"[![Build pass](https://github.com/BendDAO/bend-downpayment/actions/workflows/tests.yaml/badge.svg)](https://github.com/BendDAO/bend-downpayment/actions/workflows/tests.js.yml)\n[![codecov](https://codecov.io/gh/BendDAO/bend-downpayment/branch/main/graph/badge.svg?token=SduBujdAUN)](https://codecov.io/gh/BendDAO/bend-downpayment)\n\n```\n######                       ######     #    #######\n#     # ###### #    # #####  #     #   # #   #     #\n#     # #      ##   # #    # #     #  #   #  #     #\n######  #####  # #  # #    # #     # #     # #     #\n#     # #      #  # # #    # #     # ####### #     #\n#     # #      #   ## #    # #     # #     # #     #\n######  ###### #    # #####  ######  #     # #######\n```\n\n# BendDAO Downpayment\n\n## Description\n\nThis project contains all smart contracts used for the current BendDAO downpayment features. This includes:\n\n- abstract downpayment contract\n- BendDAO downpayment contract\n- OpenSea downpayment contract\n- LooksRare downpayment contract\n- X2Y2 downpayment contract\n\n## Documentation\n\nThe documentation for the downpayment smart contracts is available [here](https://docs.benddao.xyz/developers/deployed-contracts/down-payment).\n\n## Installation\n\n```shell\n# Yarn\nyarn add @benddao/bend-downpayment\n\n# NPM\nnpm install @benddao/bend-downpayment\n```\n\n## NPM package\n\nThe NPM package contains the following:\n\n- Solidity smart contracts (_\".sol\"_)\n- ABI files (_\".json\"_)\n\n## About this repo\n\n### Structure\n\nIt is a hybrid [Hardhat](https://hardhat.org/) repo that also requires [Foundry](https://book.getfoundry.sh/index.html) to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).\n\n> To install Foundry, please follow the instructions [here](https://book.getfoundry.sh/getting-started/installation.html).\n\n### Run tests\n\n- TypeScript tests are included in the `test` folder at the root of this repo.\n- Solidity tests are included in the `test` folder in the `contracts` folder.\n\n### Example of Foundry/Forge commands\n\n```shell\nforge build\nforge test\nforge test -vv\nforge tree\n```\n\n### Example of Hardhat commands\n\n```shell\nnpx hardhat accounts\nnpx hardhat compile\nnpx hardhat clean\nnpx hardhat test\nnpx hardhat node\nnpx hardhat help\nREPORT_GAS=true npx hardhat test\nnpx hardhat coverage\nnpx hardhat run scripts/deploy.ts\nTS_NODE_FILES=true npx ts-node scripts/deploy.ts\nnpx eslint '**/*.{js,ts}'\nnpx eslint '**/*.{js,ts}' --fix\nnpx prettier '**/*.{json,sol,md}' --check\nnpx prettier '**/*.{json,sol,md}' --write\nnpx solhint 'contracts/**/*.sol'\nnpx solhint 'contracts/**/*.sol' --fix\n```\n\n## Release\n\n- Create a [Personal access token](https://github.com/settings/tokens/new?scopes=repo&description=release-it) (Don't change the default scope)\n- Create an `.env` (copy `.env.template`) and set your GitHub personal access token.\n- `yarn release` will run all the checks, build, and publish the package, and publish the GitHub release note.\n","readmeFilename":"README.md"}