{"_id":"@polymarket/liquidity-requests-sdk","_rev":"114-986469ad083cae6a21b4ff0464b0bc5e","name":"@polymarket/liquidity-requests-sdk","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@polymarket/liquidity-requests-sdk","version":"1.0.0","author":{"name":"Dylan Golow","email":"dylangolow@gmail.com"},"license":"MIT","_id":"@polymarket/liquidity-requests-sdk@1.0.0","maintainers":[{"name":"dylangolow","email":"dylangolow@gmail.com"},{"name":"cristiangpr","email":"cristiangp777@gmail.com"},{"name":"esinger93457","email":"ethan@polymarket.com"},{"name":"smhtm","email":"sam.hatem17@gmail.com"},{"name":"jonamen","email":"jon@polymarket.com"},{"name":"l-kov","email":"ljkovatch@gmail.com"},{"name":"sherrbss","email":"sheldontaylor.7@gmail.com"},{"name":"mttwlkr","email":"mttwlkr@gmail.com"}],"contributors":[{"url":"https://github.com/dylangolow","name":"Dylan Golow"}],"homepage":"https://github.com/Polymarket/polymarket-liquidity-requests/tree/main/packages/sdk","bugs":{"url":"https://github.com/Polymarket/polymarket-liquidity-requests/issues"},"dist":{"shasum":"9fc944736b241817239ff3e09379a6739ca27a58","tarball":"https://registry.npmjs.org/@polymarket/liquidity-requests-sdk/-/liquidity-requests-sdk-1.0.0.tgz","fileCount":27,"integrity":"sha512-jJQysE4BqEt/PozSSDbP2CjFnr6aWaf4FEUTPsm/JoLWJITJvLPju1aDnrd6QD0p1Fz4/sJgCaNj6cktl1x1fg==","signatures":[{"sig":"MEQCIC76u6ZuURJm3zPQEBtj7sOCkgp3AqeEhSJ7fhUmF/XkAiALMi4a3/Wh0B4noQE4bv/FJTWZSh+NjBlY3I7P4CufCQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59960,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhMU6DCRA9TVsSAnZWagAA1HUQAKPKB6YMOl9wxjS0msen\ncGPGpDVRusFjG65pU+J/BTNSx+izc26SHzEU4m8IDibmWt0LpkKDe8BLLN07\nKV4QxRRRpFDw/s8kJ6a1BmIwYMiSN7IKBeU3EWecgDAF6BTQ/HrJ67/u0LNF\ne8PIvHqJghztpZX+LogWlR64UU35e7sOns5mNZNmoksZJC17dlI57wzt4MBd\nuccVW79sX7ihK8j14eHaeQktNUhxiTKwZIqQDzkcFRdueEHIkq8nxbxwQF75\nINW0wRMQVTrxq9sH+2H10TIDCuLvN/8IzbeSJG7Ov/nEvcJMXzH3nrPlrH33\ns+HbJy6gUjvNXCXs76EFMTGdEIbKZ+AOI0YH5Palb0RnRrHLOaFSNlLfgI9N\nzP219MzgkDrIvyS7zo7xl4NlVZh548vQXOOAjr5zKnoN74XiB9Og5OgmQnJT\n65eCm9L5gaCDC6uINybNCEVsOzQhzkfMIOXn8vvI07Q7esbYfuXonxWkZcyM\nFuBF6b9CWFYNA9TxC5sYeleKCyrC/7f3S6NeS6noLMS7Mre7dSROnQPxbxg5\nbIK9BCCe/S8QY3CAtw4iYIQJmx9B1t0F15hpa3VWVkjTs3AGaanM4OrA52Yl\nlaQBwDC7mjBOv2aKsXIOirNc6FeigAphScWn1NqLNvw3fZm8zu+5D5NgunLe\n+E88\r\n=Tgeu\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc"},"_npmUser":{"name":"dylangolow","email":"dylangolow@gmail.com"},"repository":{"url":"git+ssh://git@github.com/Polymarket/polymarket-liquidity-requests.git","type":"git","directory":"@polymarket/polymarket-liquidity-requests/packages/sdk"},"description":"Polymarket Liquidity Request Log SDK","directories":{},"dependencies":{"ethers":"^5.4.5","@ethersproject/providers":"^5.4.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/liquidity-requests-sdk_1.0.0_1630621315448_0.60369880977591","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@polymarket/liquidity-requests-sdk","version":"1.0.1","author":{"name":"Dylan Golow","email":"dylangolow@gmail.com"},"license":"MIT","_id":"@polymarket/liquidity-requests-sdk@1.0.1","maintainers":[{"name":"dylangolow","email":"dylangolow@gmail.com"},{"name":"cristiangpr","email":"cristiangp777@gmail.com"},{"name":"esinger93457","email":"ethan@polymarket.com"},{"name":"smhtm","email":"sam.hatem17@gmail.com"},{"name":"jonamen","email":"jon@polymarket.com"},{"name":"l-kov","email":"ljkovatch@gmail.com"},{"name":"sherrbss","email":"sheldontaylor.7@gmail.com"},{"name":"mttwlkr","email":"mttwlkr@gmail.com"}],"contributors":[{"url":"https://github.com/dylangolow","name":"Dylan Golow"}],"homepage":"https://github.com/Polymarket/polymarket-liquidity-requests/tree/main/packages/sdk","bugs":{"url":"https://github.com/Polymarket/polymarket-liquidity-requests/issues"},"dist":{"shasum":"644780b46f19522e616191b2a30a9edc5f22db01","tarball":"https://registry.npmjs.org/@polymarket/liquidity-requests-sdk/-/liquidity-requests-sdk-1.0.1.tgz","fileCount":27,"integrity":"sha512-rtvI7iImfzbvbU9XKmCZpGjL4GD9x0B/MVS/3VP/yd/F+xqfe1xD2kELgRiSQRz7OLzqZVwLl2RWf462wzbK5A==","signatures":[{"sig":"MEUCIQCofO+bdfGgnhian1nE7Y7QsznbREiY/9h/ciwH4gteIgIgTilPVAoW4FTTbeELabIW0d5ms7Wu85DrLSuDM0bZxgI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":60865,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhOmPXCRA9TVsSAnZWagAA8gcP/1R5TXdco92Jju1ANI4u\nvwvkw7GT4TktKaROXQxAbdvvCOMAF/h/J3L/McXjneej+mq9NIr6Gt9mFtwn\nlXuvV+yr76KMGyuZkd1pqNPKDvZjtzi5sxwVUcc36gB9HJMJ7q5mtXJlNFpr\nyGqNKDy34PUzRw+ieqJn4WO1tP8D3xO+D2RJrfFa2jae2czX/Apg9FOX961O\n1jXopN5fxOrBSCAhDG/Po3CKPVhFlsI+VRlYtv/m8Dukx5Tyi6IujKbtQmAm\n7GlG0V8hZuhwjvz1gpR6ZJYlU6b4mLppoWqirytEwZ0H5XsI5H/L5zSR1YW3\nAXT6zqP9lgGqCplR264WmXv4WRyIMxy5kWmdRt6SDD1dUPSX/CHtU1vV03Kp\npeu6fTPblubdES5UjCCI5rYj9wBKZd3DaJHNlM9r7x4kgX8loyUBR8bjghaa\nrjJA+nYu+Nk0mkdIC4rqHwRNnoDHmyc3q8b7YL0Sx8o8YGOAb/+Bd6x62N/J\nU/9PxUS5yPkJOSnWFOUZQ5P1SB3I9erGqPrYgs4iyrMCuiQb2g+LVxWDUNMo\ncXsFm4nW2Wklie60SEkV2N39PV93meLD5F62fX9mEZpJ+BBnZcDeSQ8cC9z1\nngd/jsO064oSzkL+IwNV29vzG/EAQ+xy7rXWnYPUAJrXF5ct4u9t+DWBJrDO\n+vny\r\n=ljvy\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc"},"_npmUser":{"name":"dylangolow","email":"dylangolow@gmail.com"},"repository":{"url":"git+ssh://git@github.com/Polymarket/polymarket-liquidity-requests.git","type":"git","directory":"@polymarket/polymarket-liquidity-requests/packages/sdk"},"description":"Polymarket Liquidity Request Log SDK","directories":{},"dependencies":{"ethers":"^5.4.5","@ethersproject/providers":"^5.4.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/liquidity-requests-sdk_1.0.1_1631216599192_0.27143140949433997","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@polymarket/liquidity-requests-sdk","version":"1.0.2","author":{"name":"Dylan Golow","email":"dylangolow@gmail.com"},"license":"MIT","_id":"@polymarket/liquidity-requests-sdk@1.0.2","maintainers":[{"name":"dylangolow","email":"dylangolow@gmail.com"},{"name":"cristiangpr","email":"cristiangp777@gmail.com"},{"name":"esinger93457","email":"ethan@polymarket.com"},{"name":"smhtm","email":"sam.hatem17@gmail.com"},{"name":"jonamen","email":"jon@polymarket.com"},{"name":"l-kov","email":"ljkovatch@gmail.com"},{"name":"sherrbss","email":"sheldontaylor.7@gmail.com"},{"name":"mttwlkr","email":"mttwlkr@gmail.com"}],"contributors":[{"url":"https://github.com/dylangolow","name":"Dylan Golow"}],"homepage":"https://github.com/Polymarket/polymarket-liquidity-requests/tree/main/packages/sdk","bugs":{"url":"https://github.com/Polymarket/polymarket-liquidity-requests/issues"},"dist":{"shasum":"3172035b61ed175db7e1966d0eb59db04f17dc15","tarball":"https://registry.npmjs.org/@polymarket/liquidity-requests-sdk/-/liquidity-requests-sdk-1.0.2.tgz","fileCount":27,"integrity":"sha512-gM6N20dk3yNaeyNSbV6U/Lv7poEOOFomX2jU9WgXNV9Uun0kUdAxhAVDWn3ZXI7MyTL7Wpc4PlPU8IqsEbWUnA==","signatures":[{"sig":"MEUCIQD9r+/ZnWUic1vDS74y6tk2p/MjUqOV/qFZ/aX0OuwdWwIgEEDCdopDTav+WIK/7sZkd4bzdLbvRot1eEQolwKgjzg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61389,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQBxcCRA9TVsSAnZWagAAnIMP/0aYkXjooQPR/7hMm9qE\nhdWH8B2CGN00CbAOCXdfutm6nFgoN8m/inSxTQj5kTIAUlalYbY3YNuXw7HD\nNX/zJeKKLUefLnLzQC4syoK1pB3nOD1rZwUXinyN6OpGfvNQdccefx1kFNO2\nfiFG34gnOZuY8hAXT/8oAM+czqh0S6few2f0Emr6U6sattxbZePP8weteMQ0\nyfzlLzqVPKJbAkS4HQ2WbABTrqjJ7lDT6FPYt6WUUPTSSpoOBDwMs301vBPe\nXd1eMQLvOREVw5yrFu7dYfy/CcBXwCgmmB6A0f/Dx5ZRo+0OqcZlM2t6xPLC\nDz14k035ZGVBq9cEmrRmyaE8njpPzYI5+kFtFXg+pe2GxSN2L38duLjahPFP\nksTDLYixWQcuSxkGisU5PZOloC5OxPtXyRDzoxSwiSLMHePa2PPDkdPLvug8\nTGJtpXs1b7uKnSadYLVO8sQ8Uf0iQ++dgLFnabVIu2tnmRoFOO98RU7amGQF\n8CJK14ua0dsAlbdIfO9ktJnb9R7CBTbhluk7LBw87dZr669sE36s2nsqh1Ze\nGv9FRjURswQ3PonmE3XSTLyeJs9hrA4e9/ydDUxsnDEWCGy/mulAHSJMLw/x\n3aCruL2JsjKfTOcojZHFs7Q8gCQAf56p88RlA/43vnxKo+Dp83PuzvqKjOU/\nq61H\r\n=CuPI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc"},"_npmUser":{"name":"dylangolow","email":"dylangolow@gmail.com"},"repository":{"url":"git+ssh://git@github.com/Polymarket/polymarket-liquidity-requests.git","type":"git","directory":"@polymarket/polymarket-liquidity-requests/packages/sdk"},"description":"Polymarket Liquidity Request Log SDK","directories":{},"dependencies":{"ethers":"^5.4.5","@ethersproject/providers":"^5.4.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/liquidity-requests-sdk_1.0.2_1631591516311_0.23177851958613127","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-09-02T22:21:55.408Z","modified":"2026-09-29T19:48:05.554Z","1.0.0":"2021-09-02T22:21:55.599Z","1.0.1":"2021-09-09T19:43:19.370Z","1.0.2":"2021-09-14T03:51:56.593Z"},"bugs":{"url":"https://github.com/Polymarket/polymarket-liquidity-requests/issues"},"author":{"name":"Dylan Golow","email":"dylangolow@gmail.com"},"license":"MIT","homepage":"https://github.com/Polymarket/polymarket-liquidity-requests/tree/main/packages/sdk","repository":{"url":"git+ssh://git@github.com/Polymarket/polymarket-liquidity-requests.git","type":"git","directory":"@polymarket/polymarket-liquidity-requests/packages/sdk"},"description":"Polymarket Liquidity Request Log SDK","contributors":[{"url":"https://github.com/dylangolow","name":"Dylan Golow"}],"maintainers":[{"email":"bapi@polymarket.com","name":"bapi-poly"},{"email":"agupta@polymarket.com","name":"ad1-poly"},{"email":"prayuj@polymarket.com","name":"prayujt"},{"email":"ethan@polymarket.com","name":"esinger93457"},{"email":"jon@polymarket.com","name":"jonamen"},{"email":"sheldontaylor.7@gmail.com","name":"sherrbss"},{"email":"arun@polymarket.com","name":"devstardude-poly"},{"email":"julian@polymarket.com","name":"juliankoh"},{"email":"neesh@polymarket.com","name":"neesh-polymarket"},{"email":"carlos@polymarket.com","name":"carlos-poly"},{"email":"william@polymarket.com","name":"poly-william"},{"email":"kurush@polymarket.com","name":"kurushdubash-poly"},{"email":"kevin.costello@polymarket.com","name":"elvisc0stell0"},{"email":"matthew.wilson@polymarket.com","name":"mwilson-poly"},{"email":"srdjan.rakic@polymarket.com","name":"srdjan.rakic"},{"email":"christian.conforti@polymarket.com","name":"christian-poly"},{"email":"balint@polymarket.com","name":"balintpoly"},{"email":"pradeep@polymarket.com","name":"pradeep-poly"},{"email":"zannis.kalampoukis@polymarket.com","name":"zannis-poly"},{"email":"shrenuj@polymarket.com","name":"shrenuj-polymarket"},{"email":"danny.nam@polymarket.com","name":"danny.nam"},{"email":"cesare@polymarket.com","name":"cesare-poly"},{"email":"mohamed@polymarket.com","name":"mohamed-polymarket"},{"email":"ash.bhimasani@polymarket.com","name":"ash-polymarket"},{"email":"ruben.sospedra@polymarket.com","name":"sospedra-poly"},{"email":"bartek.legiec@polymarket.com","name":"bartek-poly"},{"email":"joe@polymarket.com","name":"polyjsmth"},{"email":"chaz@polymarket.com","name":"chaz-polymarket"},{"email":"khaidar.kairbek@polymarket.com","name":"khaidar-poly"},{"email":"npm@legate.me","name":"legate"},{"email":"george.visconti@polymarket.com","name":"georgevisconti"},{"email":"ryan.hall@polymarket.com","name":"ryanrhall-pm"},{"email":"benedek.gobolos@polymarket.com","name":"gbls.bndk.poly"},{"email":"worktrial1@polymarket.com","name":"work-trial"},{"email":"franky@polymarket.com","name":"franky-poly"},{"email":"aswin.nair@polymarket.com","name":"aswinnairpm"},{"email":"ivan+polymarket@3perf.com","name":"iamakulov-poly"},{"email":"suhail@polymarket.com","name":"suhail-polymarket"},{"email":"ethan.goldberg@polymarket.com","name":"ethangold3"},{"email":"antonio.simeonov@polymarket.com","name":"tonyatpolymarket"},{"email":"siddharth.sharma@polymarket.com","name":"sidd-poly"},{"email":"jason.fieldman@polymarket.com","name":"jason.fieldman.poly"},{"email":"steven@polymarket.com","name":"itsstevenwal"},{"email":"anthony.khaiat@polymarket.com","name":"polykha"},{"email":"shivkanth.bagavathy@polymarket.com","name":"shivkanthb-poly"},{"email":"gyula.halmos@polymarket.com","name":"gyula-poly"},{"email":"vedant.patel@polymarket.com","name":"vedantpatel101"},{"email":"samuel.davies@polymarket.com","name":"samueldaviespolymarket"},{"email":"matheus.silva@polymarket.com","name":"matt-poly"},{"email":"marco.cornacchia@polymarket.com","name":"marco-poly"},{"email":"oliver.cai@polymarket.com","name":"oliver-cai-gh"},{"email":"louis@polymarket.com","name":"louisferraropm"},{"email":"dan@polymarket.com","name":"dthomas-poly"},{"email":"daniel.im@polymarket.com","name":"daniel.im"},{"email":"jacob.tieshue@polymarket.com","name":"jacob.tieshue"},{"email":"troy.nguyen@polymarket.com","name":"tnguyenpolymarket"},{"email":"alice.zhao@polymarket.com","name":"azpoly"},{"email":"lucille@polymarket.com","name":"lucilleh"},{"email":"chris.scott+npm@polymarket.com","name":"chris.scott.pm"},{"email":"graydon.driver@polymarket.com","name":"graydondriver"},{"email":"jeshua.sharkey@polymarket.com","name":"jeshfrompoly"},{"email":"nickrice@polymarket.com","name":"nickrice"},{"email":"viktar.naumik@polymarket.com","name":"vicnaum_poly"},{"email":"namik.mesic@polymarket.com","name":"namikmesic-hub"},{"email":"rob@polymarket.com","name":"rob-poly"},{"email":"fedner@polymarket.com","name":"fednerj"},{"email":"kevin+2@polymarket.com","name":"kshaynpm2"},{"email":"martin@polymarket.com","name":"martin-poly"},{"email":"harley@polymarket.com","name":"harley-poly"}],"readme":"# Liquidity Requests SDK ![npm](https://img.shields.io/npm/v/@polymarket/liquidity-requests-sdk)\n\nThe Polymarket Liquidity Requests sdk (`@polymarket/liquidity-requests-sdk`) provides an easy-to-use, lightweight wrapper around the `LiquidityRequestLog` contract.\n\n## Installation\n\nThe sdk can be easily installed using yarn with the following command:\n\n```bash\nyarn add @polymarket/liquidity-requests-sdk\n```\n\n## Usage\n\nThe sdk provides importable types.\n\n```typescript\nimport { LiquidityRequest } from \"@polymarket/liquidity-requests-sdk\";\n```\n\nPrimarily though, the sdk allows a `LiquidityRequestLog` object to be initialized with a `signer` (`JsonRpcSigner`) and a `chainID` (`number`). This object provides a simple interface to various registry contract functions and utilities.\n\n```typescript\nimport { LiquidityRequestLog, LiquidityRequest } from \"@polymarket/liquidity-requests-sdk\";\n\nconst liquidityRequestLog = new LiquidityRequestLog(signer, 137); // deployed to Polygon and Mumbai\n\nconst liquidityRequest: LiquidityRequest = {\n    marketMakerAddress: \"0x0000000000000000000000000000000000000001\",\n    reason: \"trade\",\n    tradeAmount: 2000000000000000000000,\n};\n\nawait liquidityRequestLog.submitLiquidityRequest(liquidityRequest);\n```\n\n## Interpreting Events\n\nClient implementations of this sdk will vary, and direct interaction with the contracts themselves could result in other values for `reason` and `tradeAmount`, however the [polymarket.com](https://polymarket.com/) site uses the following client implementation of reasons and trade amounts for each liquidity request submitted.\n\nThe event to subscribe to with the relevant struct are listed below, see the complete contract here: [`LiquidityRequestLog.sol`](../contracts/contracts/LiquidityRequestLog.sol)\n\n```solidity\ninterface LiquidityRequestLog {\n    \n    struct LiquidityRequest {\n        address requesterAddress;\n        uint256 requestDate;\n        string reason;\n        address marketMakerAddress;\n        uint256 tradeAmount;\n    }\n\n    event LiquidityRequestAdded(address indexed requesterAddress, LiquidityRequest liquidityRequest);\n}\n```\n\n### Reasons  \n  \n| Option | Description |  \n| --- | --- |   \n| `\"TRADE\"` | User indicating they want to place a large trade (liquidity is low) |\n| `\"INFO\"` | User has information to trade on |\n| `\"OTHER\"` | Other reason (text box allows user to submit reason, maximum 100 characters, will show custom reason and not `\"OTHER\"`) |\n\n### Trade Amounts (USDC)\n\n| Option | USDC BigNumber Value |\n| --- | --- |\n| < 500 | `500000000` |\n| 501 - 1,000 | `1000000000` |\n| 1,001 - 10,000 | `10000000000` |\n| 10,000+ | `10001000000` |\n| I prefer not to say | `0` |\n\nYou can refer to the liquidity requests sdk source code for available [functions](https://github.com/Polymarket/polymarket-liquidity-requests/blob/main/packages/sdk/src/liquidityRequestLog.ts) and [types](https://github.com/Polymarket/polymarket-liquidity-requests/blob/main/packages/sdk/src/types.ts).\n","readmeFilename":"README.md"}