Skip to content

Latest commit

 

History

History
254 lines (194 loc) · 5.9 KB

README.md

File metadata and controls

254 lines (194 loc) · 5.9 KB
Raw

pmarket-cli

Command line interface for Polymarket.

Features

  • List available markets with question filter.
  • Buy tokens/shares.
  • Sell tokens/shares.
  • Set USDC allowance for CTFExchange contract.
  • Show order book for specific token.
  • Cancel all open orders.
  • Generate api key for polymarket.

Installation

Minimum required node version is 16.20.0

npm i pmarket-cli -g

Setup

After successful installation you need to go through four steps in order to place buy and sell orders with the tool. Setup requires editing config.json file which is located under ~/.pmarket-cli/config.json where ~ is your home directory.

  1. You need to generate api key to access polygon network. I recommend using infura.io but you can use any other provider you like Steps to generate key. Once you generate the key set rpcProvider value in config.json file to your rpc provider url. Url should look something like this: https://polygon-mainnet.infura.io/v3/your-api-key

  2. Generate your private key and set it in config.json file (privateKey entry). You can use metamask to generate private key. Steps to generate private key

  3. You will need to generate an api key for polymarket. You can do this by running the following command:

pmarket-cli -k

Take values from the response and set them in config.json file (apiKey, apiSecret and passphrase entries).

  1. Set allowance for CTFExchange contract. You can do this by running the following command. This will allow CTFExchange contract to spend your USDC tokens.
pmarket-cli -a 500

After all 4 steps your config.json file should have all entries filled with values.

Usage examples:

List available markets with question filter Command 
pmarket-cli -l "Will Trump attend the first RNC debate?"

Response

[
  {
    token_0: {
      token_id: '12110463059584809904811790486163860991533989713640269122405796144537637099628',
      outcome: 'Yes'
    },
    token_1: {
      token_id: '29339358161683554702930216891507179890535004654000050338417989709558351328832',
      outcome: 'No'
    },
    question: 'Will Trump attend the first RNC debate?'
  }
]
Buy token order Command 
pmarket-cli -b 12110463059584809904811790486163860991533989713640269122405796144537637099628 30 0.5

Response

  {
    "success": true,
    "errorMsg": "",
    "orderID": "0x556d3864c64d851462b2f378f5e6dcec7d31ba1632dfe44bfdcaa3cc685b45cc",
    "transactionsHashes": [
      "0x23d3b0f75446128bff33fd750870a1ea03a210de863ed7efd836ab3d18d83609"
    ],
    "status": "matched"
  }
Sell token order Command 
pmarket-cli -s 12110463059584809904811790486163860991533989713640269122405796144537637099628 30 0.5

Response

  {
    "success": true,
    "errorMsg": "",
    "orderID": "0x556d3864c64d851462b2f378f5e6dcec7d31ba1632dfe44bfdcaa3cc685b45cc",
    "transactionsHashes": [
      "0x23d3b0f75446128bff33fd750870a1ea03a210de863ed7efd836ab3d18d83609"
    ],
    "status": "matched"
  }
Set USDC allowance for CTFExchange contract Command 
pmarket-cli -a 500

Response

Block Gas Limit: 30323827
{
  type: 2,
  chainId: 137,
  nonce: 164,
  maxPriorityFeePerGas: BigNumber { _hex: '0xabcd', _isBigNumber: true },
  maxFeePerGas: BigNumber { _hex: '0xabcd', _isBigNumber: true },
  gasPrice: null,
  gasLimit: BigNumber { _hex: '0xabcd', _isBigNumber: true },
  to: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
  value: BigNumber { _hex: '0x00', _isBigNumber: true },
  data: '0x000ea7b30000000000000000000000004bfb41d5b3570defd03c39a9a4d8de6bd8b8982e00000000000000000000000000000000000000000000000000000000300aca00',
  accessList: [],
  hash: '0x6d409ef667f20807599ff2c1495df8f1ab71b7810a83e001a20196e43f469299',
  v: 0,
  r: '0xe9afafb7a4e036f4d1b06945afb5a08b8e0eb368daa5efa3b800c443e4f4113a',
  s: '0x084689146316314ad56868d3161438b31ed04a748fc008a5ac2c93f1f778779f',
  from: '0x01819b106DBfFD451bbE00ED1e3CE2fBD13CC947',
  confirmations: 0,
  wait: [Function (anonymous)]
}
Show order book for specific tokenId Command 
pmarket-cli -o 12110463059584809904811790486163860991533989713640269122405796144537637099628

Response

{
  market: '0x6f662d9d965d0b01d08ee284a58e1dd866296729801c0cdc6867459760bd33ab',
  asset_id: '12110463059584809904811790486163860991533989713640269122405796144537637099628',
  bids: [
    { price: '0.03', size: '100' },
    { price: '0.45', size: '200' },
    { price: '0.51', size: '2000' },
    { price: '0.55', size: '200' }
  ],
  asks: [
    { price: '0.99', size: '1000' },
    { price: '0.97', size: '100' },
    { price: '0.95', size: '200' },
    { price: '0.9', size: '200' },
    { price: '0.75', size: '200' },
    { price: '0.72', size: '19' },
    { price: '0.7', size: '15' },
    { price: '0.69', size: '1022.76' },
    { price: '0.68', size: '191.52' }
  ],
  hash: '6993a77070f72dccda117544c72eb1ca4cef4bf7'
}
Get or generate api keys Command 
pmarket-cli -k

Response

{
  apiKey: 'your-api-key',
  secret: 'your-api-key-secret',
  passphrase: 'your-api-key-passphrase'
}
Cancel all open orders Command 
pmarket-cli -c

Response

{ canceled: [], not_canceled: {} }

Issues

Please use the Issue Tracker to report any issues or bugs.

License

This project is licensed under the MIT License.