Skip to content

Latest commit

 

History

History
182 lines (130 loc) · 6.54 KB

README.md

File metadata and controls

182 lines (130 loc) · 6.54 KB

Market Seeder

Tool for seeding markets on The Monaco Protocol. The tool makes use of the Monaco Protocol seed-calculator package.

Please aquatint yourself with the parameters outlined in the seed-calculator README as these are the same parameters used for this seeding tool.

Setup

Prerequisites

  • Solana CLI for wallet generation
  • npm to install dependencies
  • A CLI wallet
    • Be sure to note the publicKey of the wallets in order to fund them with SOL and the token(s) used for the markets you are seeding
    • Be sure to securely store your seed phrase
    • Never commit your wallet to a repository
mkdir wallet
solana-keygen new -o wallet/seeder.json

⚠️ The wallet dir is specified in .gitignore to help ensure you do not commit your wallet ⚠️

Installation

npm install

Setting Environment

Environmental settings are configured in .env files in .env/.env-* there are two environments that you can connect to by exporting one of the following values:

export ENVIRONMENT=mainnet-release
export ENVIRONMENT=devnet-release

The examples in this repo use anchor and each .env file sets an RPC-node with ANCHOR_PROVIDER_URL.

  • The default one for devnet is a public example RPC-node subject to rate-limiting.
  • The mainnet one is a placeholders and will need to be changed for a mainnet rpc node.
  • For each, you should set yourself up with your own RPC-node.

RPC-Nodes

Two providers you may wish to consider, who both offer free-tier RPCs are:

Additional Environment Settings

In addition to your wallet path, solana program ID and RPC node information, the .env files also specify default values for your seeding and how you wish the seeder to perform.

  • Include Stake in Returns (true/false)
    • Whether or not to include the stake/risk in the return calculations.
  • True Price
    • The the mid-point on a market between for and against orders, all prices are calculated from this point on the price ladder.
  • Spread
    • The first price on either side of the ladder from the true price.
  • Steps
    • How many rungs up or down the ladder until the next price is determined.
  • To Return
    • Amount to be returned from your for order.
  • To Lose
    • Amount to be returned from your against order.
  • Depth Percentages
    • Percentage of stake to place.
    • For example [100, 75, 50] will use 100%, 75%, 50% of the calculated stake.
    • The number of percentages here also determines the depth of the pricing.

Generate Seeding CSV

In order to generate a CSV to seed from run:

npm run generateSeedCsv <output csv name> <token name>

This will currently get all:

  • Open markets
  • Using the supplied token name for order placement

Some tokens have been mapped so you can pass in a shorthand name for them. Currently mapped tokens:

  • Devnet: wins
  • Mainnet: usdt

For any other token, pass in the full publicKey.

This script will generate a CSV breaking down the outcomes for each market, with default seeding values applied. You can then edit this file prior to running seedOutcomesFromCsv.

Seeding From CSV

Following the generation of the CSv, you should edit the values to fulfil your seeding needs. The csv can be found in /src/csvs/your_csv_name.csv

⚠️ Market outcomes will only be seeded if the seed value in the csv reads TRUE ⚠️

In the example below, only the Mumbai Indians outcome would be seeded on the Top Batter Team market.

marketPk,eventPk,marketTitle,marketType,outcome,outcomeIndex,truePrice,spread,steps,toReturn,toLose,depthPercentages,seed
4k3qx4FwWmoTbHHKoHZGLscQEQe2A6s5sfoFFFEqsxGD,141cYL6JuKMy3FCx9cAdXRohkFhdj6RCosM3aWAp7cB7,Top Batter Team,EventResultFullTime,Gujarat Titans,0,2,2,2,100,100,"100,75,50",FALSE
4k3qx4FwWmoTbHHKoHZGLscQEQe2A6s5sfoFFFEqsxGD,141cYL6JuKMy3FCx9cAdXRohkFhdj6RCosM3aWAp7cB7,Top Batter Team,EventResultFullTime,Mumbai Indians,1,2,3,1,200,100,"100,75,50",TRUE

To preview how your markets would seed, run the seeding script with a false flag.

npm run seedOutcomesFromCsv <csv name> false

Below you can see what stake, prices, and returns, would be used with the following settings:

  • True Price 2
  • Spread 3
  • Steps 1
  • To Return 200
  • To Lose 100
  • Depth percentages of 100,75,50

As there are 3 depth percentages, 3 orders are placed on each side: FOR and AGAINST.

Please note that for AGAINST (lay) bets, risk is calculated from the stake and price on The Monaco Protocol.

Market 4k3qx4FwWmoTbHHKoHZGLscQEQe2A6s5sfoFFFEqsxGD | Outcome: Mumbai Indians | Title: Top Batter Team ℹ️
FOR
[
  { stake: 98.52, price: 2.03, return: 200 },
  { stake: 73.17, price: 2.05, return: 150 },
  { stake: 48.31, price: 2.07, return: 100 }
]
AGAINST
[
  { stake: 50.76, price: 1.97, return: 100 },
  { stake: 38.46, price: 1.95, return: 75 },
  { stake: 25.91, price: 1.93, return: 50 }
]

If, for example you then decided to change settings, perhaps to only seed to a depth of 2 100, 75 and to change your ToLose to 150 then update your csv and try another dry-run.

marketPk,eventPk,marketTitle,marketType,outcome,outcomeIndex,truePrice,spread,steps,toReturn,toLose,depthPercentages,seed
4k3qx4FwWmoTbHHKoHZGLscQEQe2A6s5sfoFFFEqsxGD,141cYL6JuKMy3FCx9cAdXRohkFhdj6RCosM3aWAp7cB7,Top Batter Team,EventResultFullTime,Mumbai Indians,1,2,3,1,200,150,"100,75",TRUE

FOR
[
  { stake: 98.52, price: 2.03, return: 200 },
  { stake: 73.17, price: 2.05, return: 150 }
]
AGAINST
[
  { stake: 76.14, price: 1.97, return: 150 },
  { stake: 57.69, price: 1.95, return: 112.5 }
]

Once happy with the output of the dryrun, and the orders it will place, you can then seed the markets by switching to a true flag.

npm run seedOutcomesFromCsv <csv name> true

This will place the orders, on the market outcomes. If will do so in an asynchronous manner to aid performance.

Cancel Orders

A script has been provided to cancel all orders for your wallet on the specified market at invocation. If a false flag is passed then a list of orders will be returned. If a true flag is passed then an attempt will be made to cancel all the cancellable orders on that market for your wallet.

npm run cancelOrders <marketPk> <true/false>