{"_id":"@aetherio/seaport-js","_rev":"1-0ab877cbed377fcb63c50bba64aa7b98","name":"@aetherio/seaport-js","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@aetherio/seaport-js","version":"1.0.0","description":"[Seaport](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.","license":"MIT","author":{"name":"OpenSea Developers"},"homepage":"https://github.com/ProjectOpenSea/seaport-js#readme","repository":{"type":"git","url":"git+https://github.com/ProjectOpenSea/seaport-js.git"},"bugs":{"url":"https://github.com/ProjectOpenSea/seaport-js/issues"},"main":"lib/index.js","directories":{"doc":"docs","lib":"lib"},"scripts":{"build":"hardhat compile && tsc -p tsconfig.build.json","check-types":"tsc --noEmit -p src/__tests__/tsconfig.json","check-types:incremental":"npm run check-types --incremental","eslint:check":"eslint . --max-warnings 0 --ext .js,.jsx,.ts,.tsx","lint":"concurrently \"npm run check-types\" \"npm run eslint:check\" \"npm run prettier:check\" \"npm run prettier:check:package.json\"","prepare":"husky install && npm run build","test":"hardhat test","prettier:check":"prettier --check .","prettier:check:package.json":"prettier-package-json --list-different","prettier:fix":"prettier --write ."},"types":"lib/index.d.ts","dependencies":{"@0xsequence/multicall":"^0.39.0","ethers":"5.6.7","merkletreejs":"0.2.31"},"devDependencies":{"@nomiclabs/hardhat-ethers":"2.0.5","@nomiclabs/hardhat-waffle":"2.0.3","@rari-capital/solmate":"6.2.0","@typechain/ethers-v5":"9.0.0","@typechain/hardhat":"5.0.0","@types/chai":"4.3.0","@types/chai-as-promised":"7.1.5","@types/mocha":"9.1.0","@types/node":"12.20.47","@typescript-eslint/eslint-plugin":"5.27.1","@typescript-eslint/parser":"5.27.1","chai":"4.3.6","chai-as-promised":"7.1.1","concurrently":"7.1.0","dotenv":"10.0.0","eslint":"8.17.0","eslint-config-prettier":"8.5.0","eslint-config-standard":"17.0.0","eslint-plugin-import":"2.25.4","eslint-plugin-n":"15.2.0","eslint-plugin-prettier":"3.4.1","eslint-plugin-promise":"6.0.0","ethereum-waffle":"3.4.4","hardhat":"2.9.1","hardhat-gas-reporter":"1.0.8","husky":">=6","lint-staged":">=10","prettier":"2.5.1","prettier-package-json":"2.6.3","prettier-plugin-solidity":"1.0.0-beta.13","seaport":"git+https://github.com/ProjectOpenSea/seaport.git#76e508657888e3ec84039e1da269c822826991ef","sinon":"13.0.1","sinon-chai":"3.7.0","solhint":"3.3.7","solidity-coverage":"0.7.20","ts-node":"10.7.0","typechain":"7.0.1","typescript":"4.6.2"},"engines":{"node":">=14.0.0"},"lint-staged":{"package.json":["prettier-package-json --write","git add"],"**/*.{ts,tsx,js,jsx,html,md,mdx,yml,json}":["prettier --write"]},"gitHead":"3d789593e54594acfeef88e83bb0b3a4c1570af9","_id":"@aetherio/seaport-js@1.0.0","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-X/yPkE6LIy1cjVet4J35TaP0j8qdaPRDJEurO7KM9CqddtEMM9ngeEy3fIAxiu52f2JNbfN4NDKn2k0jZQlMwA==","shasum":"85e5eeaec9c43daa011df5875959680c9e8e7619","tarball":"https://registry.npmjs.org/@aetherio/seaport-js/-/seaport-js-1.0.0.tgz","fileCount":74,"unpackedSize":453786,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDaJbX+BH8K8HUjEPBJqjbdYwKJ/78oIIcg9mQwYuhJkAIgE1ZuMbmo1xMvbRwKA+1TDA+Yf3FDGuf/4Sys9AESrCY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiuVf0ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmomLQ/+KEGYxKGPJtY9os1QkLS9hEMGGINj/SGpajSMsx+YNKVkSt1G\r\nimX99ZHsfOf7e3+f/YCsl1Dj5/vuuypnWd0funtz3H8jCY2mK8dRDRlYbyfb\r\nuc+LOJkRdCAvYEuAEN/L1pft3h+GJugVr01abPucowHrjw27YtLtPlektXJd\r\nM8xAzRzhfJo/gMJfyIEhJatsoFEsKSdVq6KPAjMiyWJc3Y/RplzxPdgQuXca\r\nd2FNcO+6TkJJiX6lzhy2m/qT3QlSl+WylPfFewszNHyqEwSfddSFVMbvw5Qm\r\nY8BTxOuN4d2z9qI/FJQWJ2AWi2FA+cq8UIOjQ+7Do7Wk3qf8YJI5RYpZ5g58\r\nOHuDi6mES88bMfhUWhpn4SJCRuyJczTuQ7NJIif/FETw5b1nUrw8YpnHkqrv\r\nY51Dyx4YYMS44gr+tAjPRUSDptYUB6zLpbcb0oqAy38TRl+CtedCzyfNPYDq\r\nz9ASNJ1har7OB+ThP84MXPGedgnuEcAbF2BOI+1HSU5gywpUGG1Suotla5sj\r\n7/fqAYAemyoaJ7laCxmuD8aOrqHgX60aq8EsBFeP81tIPkBRxmGJYPM317kr\r\ns6umj9E5ZST6dsqjnp6KGlnGMjq4aX/iGFrB7dyP/E4bZ5mDCLXCeopxn9gA\r\nnyULz5ZWUHCSd3wFys99iyn9U/9hdNIFKPg=\r\n=yIg2\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"aetherio","email":"admin@aetherindustries.io"},"maintainers":[{"name":"aetherio","email":"admin@aetherindustries.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/seaport-js_1.0.0_1656313844647_0.35582355501626095"},"_hasShrinkwrap":false},"1.0.1":{"name":"@aetherio/seaport-js","version":"1.0.1","description":"[Seaport](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.","license":"MIT","author":{"name":"OpenSea Developers"},"homepage":"https://github.com/ProjectOpenSea/seaport-js#readme","repository":{"type":"git","url":"git+https://github.com/ProjectOpenSea/seaport-js.git"},"bugs":{"url":"https://github.com/ProjectOpenSea/seaport-js/issues"},"main":"lib/index.js","directories":{"doc":"docs","lib":"lib"},"scripts":{"build":"hardhat compile && tsc -p tsconfig.build.json","check-types":"tsc --noEmit -p src/__tests__/tsconfig.json","check-types:incremental":"npm run check-types --incremental","eslint:check":"eslint . --max-warnings 0 --ext .js,.jsx,.ts,.tsx","lint":"concurrently \"npm run check-types\" \"npm run eslint:check\" \"npm run prettier:check\" \"npm run prettier:check:package.json\"","prepare":"husky install && npm run build","test":"hardhat test","prettier:check":"prettier --check .","prettier:check:package.json":"prettier-package-json --list-different","prettier:fix":"prettier --write ."},"types":"lib/index.d.ts","dependencies":{"@0xsequence/multicall":"^0.39.0","ethers":"5.6.7","merkletreejs":"0.2.31"},"devDependencies":{"@nomiclabs/hardhat-ethers":"2.0.5","@nomiclabs/hardhat-waffle":"2.0.3","@rari-capital/solmate":"6.2.0","@typechain/ethers-v5":"9.0.0","@typechain/hardhat":"5.0.0","@types/chai":"4.3.0","@types/chai-as-promised":"7.1.5","@types/mocha":"9.1.0","@types/node":"12.20.47","@typescript-eslint/eslint-plugin":"5.27.1","@typescript-eslint/parser":"5.27.1","chai":"4.3.6","chai-as-promised":"7.1.1","concurrently":"7.1.0","dotenv":"10.0.0","eslint":"8.17.0","eslint-config-prettier":"8.5.0","eslint-config-standard":"17.0.0","eslint-plugin-import":"2.25.4","eslint-plugin-n":"15.2.0","eslint-plugin-prettier":"3.4.1","eslint-plugin-promise":"6.0.0","ethereum-waffle":"3.4.4","hardhat":"2.9.1","hardhat-gas-reporter":"1.0.8","husky":">=6","lint-staged":">=10","prettier":"2.5.1","prettier-package-json":"2.6.3","prettier-plugin-solidity":"1.0.0-beta.13","seaport":"git+https://github.com/ProjectOpenSea/seaport.git#76e508657888e3ec84039e1da269c822826991ef","sinon":"13.0.1","sinon-chai":"3.7.0","solhint":"3.3.7","solidity-coverage":"0.7.20","ts-node":"10.7.0","typechain":"7.0.1","typescript":"4.6.2"},"engines":{"node":">=14.0.0"},"lint-staged":{"package.json":["prettier-package-json --write","git add"],"**/*.{ts,tsx,js,jsx,html,md,mdx,yml,json}":["prettier --write"]},"gitHead":"3d789593e54594acfeef88e83bb0b3a4c1570af9","_id":"@aetherio/seaport-js@1.0.1","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-KkqUh2DsZUcjhvZfDDDXLZwhi/7kEyiYR1eU4tMngpM7RfHGilBBhNEPZrnFrI97DyjEWLVZ+0AJyJtP+QsYpg==","shasum":"d279d151a7acfb53144b222c93ecf667cd4d4b8e","tarball":"https://registry.npmjs.org/@aetherio/seaport-js/-/seaport-js-1.0.1.tgz","fileCount":74,"unpackedSize":453509,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDK9/KoioPeNrh1KDkh2Zq2QeIndxtZ+hbNf3d9yeS0mAiBAMgQcXMok9lSvqeKmE+lYzgdPD7fBHWldHi+GS4rpbw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiuVoEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpEAQ/9EY91wIkr4BW77xB0pep9yzvcRxPnEAbVW5nupIpC5qx8P9Gy\r\ntsRrCw1mSz1jCPFpfeCnPk5jz1RWZKbmYcJTW1s8Qa+nH0VuTE4r7pt/bPrr\r\n+H5wTtEB6iC2MPzxAxjXqQQCveiXD9dG3tcGRPs/7Brg7h1xY6OocTvZJuzI\r\nNEe4TtPBTEvuxphGenAFu0t3uyuQ5Kwt5CmZz1HjkhpA9L1RPCa3p3y5NRgg\r\n892GlshhgKwbE5G4CsT/Ddb/8Q34UhC9r2WGIW1UDnY79fa6yTxDIfooKKhF\r\nYQHVSDXmCWX+NpLGn5sncqlkszBmmsgJKELTfW5OpUZYtgsB4ho+ZIGfiTuy\r\nPcs/IQgZH4Vq/Upuop/Ff4VLshfeADIJ7k0cyRlEKuvRLMW0fTrh8AtlxDYs\r\nvQMmhgvx8B6jOvC0HAwiFGnzrRzbzGcGrSsPKWPIPoX3vdmXX5+BDAaiGKCD\r\n5iOM8I+kb4EMPMn8+XjOIzt26qZK2qplp9FzeEFuJRtXU0eGjNI5jDwNZywx\r\n5aZjHcgy/Sn2KGp5iTN+GN3L7N61w/UlZ2c4yl3gnCszDxrzIcLg5r0hkMMk\r\nS6ZjUIZnKxy39vAsw38dzdKeNVAHBt61wVyPCt8N9Eyyi/4vLzZxyyhZss0L\r\nZGZloik5X4LI6+NUtcnRi3cRt1XFj6UZTwA=\r\n=vhrG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"aetherio","email":"admin@aetherindustries.io"},"maintainers":[{"name":"aetherio","email":"admin@aetherindustries.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/seaport-js_1.0.1_1656314372008_0.7479224529137358"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-27T07:10:44.586Z","1.0.0":"2022-06-27T07:10:44.787Z","modified":"2022-06-27T07:19:32.286Z","1.0.1":"2022-06-27T07:19:32.218Z"},"maintainers":[{"name":"aetherio","email":"admin@aetherindustries.io"}],"description":"[Seaport](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.","homepage":"https://github.com/ProjectOpenSea/seaport-js#readme","repository":{"type":"git","url":"git+https://github.com/ProjectOpenSea/seaport-js.git"},"author":{"name":"OpenSea Developers"},"bugs":{"url":"https://github.com/ProjectOpenSea/seaport-js/issues"},"license":"MIT","readme":"# Seaport.js\r\n\r\n[Seaport](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.\r\n\r\n- [Synopsis](#synopsis)\r\n- [Installation](#installation)\r\n- [Getting Started](#getting-started)\r\n  - [Use Cases](#use-cases)\r\n- [Contributing](#contributing)\r\n\r\n## Synopsis\r\n\r\nThis is a JavaScript library to help interface with Seaport. It includes various helper methods and constants that makes interfacing with Seaport easier. These include creating orders, fulfilling orders, doing the necessary balance and approval checks, and more. We recommend taking a look at the [Seaport](https://github.com/ProjectOpenSea/seaport) docs to get a better understanding of how the Seaport marketplace works.\r\n\r\n## Installation\r\n\r\nWe recommend using [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions. Execute `nvm use`, if you have `nvm` installed.\r\n\r\nThen, in your project, run:\r\n\r\n```\r\nnpm install --save @opensea/seaport-js\r\n```\r\n\r\n## Getting Started\r\n\r\nInstantiate your instance of seaport using your ethers provider:\r\n\r\n```JavaScript\r\nimport { Seaport } from \"@opensea/seaport-js\";\r\n\r\nconst provider = ethers.getDefaultProvider();\r\n\r\nconst seaport = new Seaport(provider);\r\n```\r\n\r\nLook at the relevant definitions in `seaport.ts` in order to see the different functionality this library offers.\r\n\r\n### Use Cases\r\n\r\nMany of the main core flows return _use cases_. What this means is that if you were to create an order (a la `createOrder`), the library helps perform the necessary balance and approval checks based on the `offer` of the order being created. If the `offerer` requires approvals on one asset contract, the `actions` field of the use case would contain an approval action that the user should execute first in order for the trade to succeed in the future.\r\n\r\n## Contributing\r\n\r\nSee [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with this project.\r\n","readmeFilename":"README.md"}