{"_id":"@0x-klaytn/orderbook","_rev":"2-b35b1560a011df769916a243777b93cb","name":"@0x-klaytn/orderbook","dist-tags":{"latest":"2.2.3"},"versions":{"2.2.2":{"name":"@0x-klaytn/orderbook","version":"2.2.2","description":"Library for retrieving and syncing a remote orderbook locally","main":"lib/src/index.js","types":"lib/src/index.d.ts","bugs":{"url":"https://github.com/0xProject/0x-monorepo/issues"},"homepage":"https://github.com/0xProject/0x-monorepo/packages/orderbook/README.md","repository":{"type":"git","url":"https://github.com/0xProject/0x-monorepo.git"},"publishConfig":{"access":"public"},"scripts":{"clean":"shx rm -rf lib generated_docs","test":"jest","test:coverage":"jest --coverage","build":"tsc -p tsconfig.json","build:ci":"yarn build","watch":"tsc -w -p tsconfig.json","prettier":"prettier --write 'src/**/*.ts' --config .prettierrc","test:circleci":"yarn test:coverage","lint":"tslint --project . --format stylish","docs:md":"ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json","docs:json":"typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"},"author":{"name":"Jacob Evans"},"license":"Apache-2.0","devDependencies":{"@0x/ts-doc-gen":"^0.0.22","@0x/tslint-config":"^4.0.0","@0x/types":"^3.1.2","@types/jest":"^24.0.17","@types/sinon":"^2.2.2","@types/websocket":"^0.0.39","jest":"^24.8.0","shx":"^0.2.2","sinon":"^4.0.0","ts-jest":"^24.0.2","typedoc":"^0.15.0","typescript":"3.0.1","websocket":"^1.0.26"},"dependencies":{"@0x/assert":"^3.0.6","@0x/connect":"^6.0.6","@0x/mesh-rpc-client":"^9.0.1","@0x-klaytn/order-utils":"^10.2.6","@0x-klaytn/utils":"^5.4.3"},"_id":"@0x-klaytn/orderbook@2.2.2","dist":{"shasum":"174b547f5beda5c8656763e98b8004f75a8500d1","integrity":"sha512-8BQMKx068CG9gUm3MYrWH7Hhw7jmmRG5TWHx+VbWDoQUqO9vnzPohRKLeE0lFAP2nwby9uw9d9UDaZorI8Bzcg==","tarball":"https://registry.npmjs.org/@0x-klaytn/orderbook/-/orderbook-2.2.2.tgz","fileCount":113,"unpackedSize":358133,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeW+SdCRA9TVsSAnZWagAAOmgP/iDK/qdvs9ol4a3keU+O\ni3AWRjEdpZL2rTZagpTsfp2nZ5FUiHeefJZ/wJE4ybbx0C8cNRWrCZ0ZEw6l\nvGjQ0hKA9g57uxsE7yMpYQDa32vJqHkEgCaqM/KECLMr96mQZMrXPtKwi8LH\nBCf/qjjZgvhEVWZFZSCmkoTWvZkT5/HEPwKPIcTQ5b0SgtUPZAHWtm3B/Wvx\n16mYQiYvylJOzxr+PWses8xDUQ12XrXJi0lmUIwtA3GBSao1oDaQ1CthhmNO\n/tyQmvuO0BpiMNSmVsWTeqVGHk9Qe+TOUqMjuWJ7ghFtBCKD/soH5a9zQmq8\nPYRhOTjUHhSwJIGgcgUBHbml3L4O2+2VREZUcCzHL1VXkusxuUXVqWvhACMT\nBAic1rF1a7ojRfdi1CqBr3AihrFGGXaM6g4PP/drFD9F4yn5+qHKx4l1Ow7D\nMpojToaSsj/M9/RHc8qbY0wrw0jJ2Jq//LRDRPtFH2xuyuhTl2QOgh5PSRRF\nNCEbuiDXE932lLW5Ug0gnDaf0w9Vx7laiJk7zGrbT7O7LV337bT1B2P/7gAO\ns7aGsplcB+Jza+ULWgkcy+eixkEAeGll0+DtQwuoKSA/GsVDA3wYNSIH8C8Z\nmOerHMkuxxzG0bdLkSCFVbyknN92xx05PNdvoVW/iEN76fu5pg1P/2F5B/Qs\nq7Zq\r\n=q3m5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEizB991WgLMBUdHIFkUUVwcHi/dkINXtqIxAC4s1mzzAiA7odHzrhSRwniViaNfIGAieFSnw8Ugwmyp7WBAbyC57Q=="}]},"maintainers":[{"name":"xlab_is","email":"max@kc.vc"}],"_npmUser":{"name":"xlab_is","email":"max@kc.vc"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/orderbook_2.2.2_1583080604577_0.558789222911777"},"_hasShrinkwrap":false},"2.2.3":{"name":"@0x-klaytn/orderbook","version":"2.2.3","description":"Library for retrieving and syncing a remote orderbook locally","main":"lib/src/index.js","types":"lib/src/index.d.ts","bugs":{"url":"https://github.com/0xProject/0x-monorepo/issues"},"homepage":"https://github.com/0xProject/0x-monorepo/packages/orderbook/README.md","repository":{"type":"git","url":"https://github.com/0xProject/0x-monorepo.git"},"publishConfig":{"access":"public"},"scripts":{"clean":"shx rm -rf lib generated_docs","test":"jest","test:coverage":"jest --coverage","build":"tsc -p tsconfig.json","build:ci":"yarn build","watch":"tsc -w -p tsconfig.json","prettier":"prettier --write 'src/**/*.ts' --config .prettierrc","test:circleci":"yarn test:coverage","lint":"tslint --project . --format stylish","docs:md":"ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json","docs:json":"typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"},"author":{"name":"Jacob Evans"},"license":"Apache-2.0","devDependencies":{"@0x/ts-doc-gen":"^0.0.22","@0x/tslint-config":"^4.0.0","@0x/types":"^3.1.2","@types/jest":"^24.0.17","@types/sinon":"^2.2.2","@types/websocket":"^0.0.39","jest":"^24.8.0","shx":"^0.2.2","sinon":"^4.0.0","ts-jest":"^24.0.2","typedoc":"^0.15.0","typescript":"3.0.1","websocket":"^1.0.26"},"dependencies":{"@0x-klaytn/order-utils":"^10.3.2","@0x-klaytn/utils":"^5.4.5","@0x-klaytn/assert":"^3.0.7","@0x/connect":"^6.0.6"},"_id":"@0x-klaytn/orderbook@2.2.3","dist":{"shasum":"2c2c2c8c089edaafcd5286e431ad265ef9abbccf","integrity":"sha512-GsQH4ewrmkTriHCP0O98vk8Ii9nbwM5dFnC+uMHI14ckcVO201H3FT86sjkzqVwBfR6f2neRs1YAIIGqx4bBcg==","tarball":"https://registry.npmjs.org/@0x-klaytn/orderbook/-/orderbook-2.2.3.tgz","fileCount":90,"unpackedSize":242958,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfEQp8CRA9TVsSAnZWagAA8bwP/3/C3wbyEc1DZdiYWjWq\n1S/4sUYOKNHY3PdttjHmzKSdbnT4UOWmqiuEjgoGTVTOKWfoPqF6rzZocNCL\nwfexlnA1sSMBCYfMxEJB3rn/Vdq43giIFlBow42a3IVIvjaELmLE6aX0176t\nlJswZi+nnzlAvoW+yRgXMnEJNdVkCpkEn+Cm3AsAx9FsPtKzbtuNuX3+xZFF\n1H2DBLRqL8fjAUUR78m3JZqOEsNax0EeV00zFZr+3c0uRCj82PiObOLQuwCr\nhXqEHmRYObcDz1WKT6yC3/Q2uetcJI3lQqFi/IxaKy0a0qkWLqpOgkWwu2u8\nVDVFLLSTJ3D18hX3Q72BE40V1MqdVs1VvqVFIfFFkW9HnjorQVzUnzMwDkr8\nNompe8K1UX0c6b/5ZzIFSCa2XGDCUOY9pnysspWDDv432mCI9+c6LrxfRftd\nT1a/j8OAb65Il90Yll36o0UDPu6nRDjT+1eByCIohIcvX6wdnKxA13DL5wQ3\nJfTohEsIptKEU+C8ut9FAZhMl/wSkrW11cUFFnPbjBoDvXB0xCz21qfphwVU\nzQr86N94Uq0UqWglgi6n/J4HCFwqpM2r9xa2UgTKO8dkokhSTNL9dfjrgvPJ\nGqOmkhXoO4IbvdbxbJJyod2rqchCP1vjD5db6Je7GuL+NMXPAagm3oTf/IZq\nsL02\r\n=x+NN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGbggF01KameIlNAGhoACHA5PAAwOuG60NHLfp1OMRoVAiEA4czscALNIANZEsQvInT/Z2sUVl3Sh20Wg06vCOZTs8g="}]},"maintainers":[{"name":"xlab_is","email":"max@kc.vc"}],"_npmUser":{"name":"xlab_is","email":"max@kc.vc"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/orderbook_2.2.3_1594952315661_0.38085487023184994"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-01T16:36:44.339Z","2.2.2":"2020-03-01T16:36:44.879Z","modified":"2022-04-04T10:26:20.510Z","2.2.3":"2020-07-17T02:18:35.846Z"},"maintainers":[{"name":"xlab_is","email":"max@kc.vc"}],"description":"Library for retrieving and syncing a remote orderbook locally","homepage":"https://github.com/0xProject/0x-monorepo/packages/orderbook/README.md","repository":{"type":"git","url":"https://github.com/0xProject/0x-monorepo.git"},"author":{"name":"Jacob Evans"},"bugs":{"url":"https://github.com/0xProject/0x-monorepo/issues"},"license":"Apache-2.0","readme":"## @0x-klaytn/orderbook\n\nPackage to help fetch orders from a remote source ([Standard Relayer API](https://github.com/0xProject/standard-relayer-api), Mesh) and keep the local orderbook synced and up-to-date.\n\nSupported Order Providers:\n\n-   SRA HTTP Polling\n-   SRA Websocket\n-   Mesh\n\n## Installation\n\n```bash\nyarn add @0x-klaytn/orderbook\n```\n\n**Import**\n\n```typescript\nimport { Orderbook } from '@0x-klaytn/orderbook';\n```\n\nor\n\n```javascript\nvar Orderbook = require('@0x-klaytn/orderbook').Orderbook;\n```\n\nIf your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:\n\n```json\n\"compilerOptions\": {\n    \"typeRoots\": [\"node_modules/@0x-klaytn/typescript-typings/types\", \"node_modules/@types\"],\n}\n```\n\n## Usage\n\n```typescript\n// Create an orderbook for makerAssetData, takerAssetData using the SRA Polling Order Provider\n// This Provider polls the SRA endpoint automatically every 5 seconds on the supplied asset pairs\nconst orderbook = Orderbook.getOrderbookForPollingProvider({\n    httpEndpoint: 'https://sra.0x.org/v2',\n    pollingIntervalMs: 5000,\n});\nconst orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);\n\n// Create an orderbook for makerAssetData, takerAssetData using the SRA Websocket Order Provider\n// This provider subscribes via websocket to receive order updates on the supplied asset pairs\nconst orderbook = Orderbook.getOrderbookForWebsocketProvider({\n    httpEndpoint: 'https://sra.0x.org/v2',\n    websocketEndpoint: 'wss://ws.sra.0x.org',\n});\nconst orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);\n\n// Create an orderbook for makerAssetData, takerAssetData using the Mesh Order Provider\n// This provider subscribes via websocket to receive order updates on all orders stored in Mesh\nconst orderbook = Orderbook.getOrderbookForMeshProvider({\n    websocketEndpoint: 'wss://MESH_ENDPOINT',\n});\nconst orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);\n```\n\n## Contributing\n\nWe welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.\n\nPlease read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.\n\n### Install dependencies\n\nIf you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:\n\n```bash\nyarn config set workspaces-experimental true\n```\n\nThen install dependencies\n\n```bash\nyarn install\n```\n\n### Build\n\nTo build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:\n\n```bash\nPKG=@0x-klaytn/orderbook yarn build\n```\n\nOr continuously rebuild on change:\n\n```bash\nPKG=@0x-klaytn/orderbook yarn watch\n```\n\n### Clean\n\n```bash\nyarn clean\n```\n\n### Lint\n\n```bash\nyarn lint\n```\n\n### Run Tests\n\n```bash\nyarn test\n```\n","readmeFilename":"README.md"}