polkamarkets-js 1.0.2 → 3.1.0

package/help.txt

@@ -0,0 +1,8 @@
+// Update Github
+``git push origin master``
+
+// Create a new version 
+``npm version VERSION```
+
+// Publish new version
+``npm publish``

package/index.js

@@ -0,0 +1,3 @@
+const Application = require('./src/Application.js');
+
+module.exports = { Application };

package/migrations/10_deploy_weth.js

@@ -0,0 +1,5 @@
+const WETH9 = artifacts.require("WETH9");
+
+module.exports = async function(deployer) {
+  await deployer.deploy(WETH9);
+}

package/migrations/11_deploy_full_flow.js

@@ -0,0 +1,99 @@
+const PredictionMarketV3 = artifacts.require("PredictionMarketV3");
+const PredictionMarketV3Manager = artifacts.require("PredictionMarketV3Manager");
+const ERC20PresetMinterPauser = artifacts.require("ERC20PresetMinterPauser");
+const RealityETH_ERC20_v3_0 = artifacts.require("RealityETH_ERC20_v3_0");
+const FantasyERC20 = artifacts.require("FantasyERC20");
+
+let {
+  TOKEN,
+  REALITIO_ADDRESS,
+  LOCK_AMOUNT,
+  WETH,
+  PM3_ADDRESS,
+  ERC20_USER,
+  PM3_MANAGER_ADDRESS,
+  LAND_TOKEN
+} = process.env;
+
+module.exports = async function(deployer) {
+
+  let ERC20;
+  // Comment block if you want to use an existing token
+  await deployer.deploy(ERC20PresetMinterPauser, "PM3 Token", "PM3TOKEN");
+  ERC20 = await ERC20PresetMinterPauser.deployed();
+  await ERC20.mint(ERC20_USER, '1000000000000000000000');
+  TOKEN = ERC20.address;
+
+  ERC20 = await ERC20PresetMinterPauser.at(TOKEN);
+
+  // Comment block if you want to use existing realitio
+  await deployer.deploy(RealityETH_ERC20_v3_0);
+  const realitio = await RealityETH_ERC20_v3_0.deployed(RealityETH_ERC20_v3_0);
+  await realitio.setToken(TOKEN);
+  REALITIO_ADDRESS = realitio.address;
+
+  let PM3;
+  // Comment block if you want to use existing PM3
+  await deployer.deploy(
+    PredictionMarketV3,
+    WETH, // weth
+  );
+  PM3 = await PredictionMarketV3.deployed(PredictionMarketV3);
+  PM3_ADDRESS = PM3.address;
+
+  PM3 = await PredictionMarketV3.at(PM3_ADDRESS);
+
+  let PM3Manager;
+  // Comment block if you want to use existing PM3Manager
+  await deployer.deploy(
+    PredictionMarketV3Manager,
+    PM3_ADDRESS,
+    TOKEN,
+    LOCK_AMOUNT,
+    REALITIO_ADDRESS
+  );
+  PM3Manager = await PredictionMarketV3Manager.deployed(PredictionMarketV3Manager);
+  PM3_MANAGER_ADDRESS = PM3Manager.address;
+
+  PM3Manager = await PredictionMarketV3Manager.at(PM3_MANAGER_ADDRESS);
+
+  // Comment block if approve was already performed
+  await ERC20.approve(PM3_MANAGER_ADDRESS, '1000000000000000000000');
+
+  let LandERC20;
+  // Comment block if you want to use a land already created
+  await PM3Manager.createLand(
+    'PM3 Land Token',
+    'LAND',
+    '1000000000000000000',
+    TOKEN
+  )
+  LAND_TOKEN = await PM3Manager.landTokens(0);
+
+  LandERC20 = await FantasyERC20.at(LAND_TOKEN);
+
+  // Comment block if approve was already performed
+  await LandERC20.approve(PM3_ADDRESS, '1000000000000000000000');
+
+  // Comment block if market was already created
+  const land = await PM3Manager.lands(LAND_TOKEN);
+  const landRealitio = land.realitio;
+  await PM3.mintAndCreateMarket(
+    {
+      value: '1000000000000000000',
+      closesAt: 1735689600,
+      outcomes: 2,
+      token: LAND_TOKEN,
+      distribution: [50000000,50000000],
+      question: 'Will this market be created?;This is a test market.␟"Yes","No"␟Test;Testing;https://google.pt/␟',
+      image: "",
+      arbitrator: '0x000000000000000000000000000000000000dead',
+      fee: 0,
+      treasuryFee: 0,
+      treasury: '0x000000000000000000000000000000000000dead',
+      realitio: landRealitio,
+      realitioTimeout: 300,
+      manager: PM3_MANAGER_ADDRESS,
+    }
+  )
+}

package/migrations/12_deploy_pm_v3_querier.js

@@ -0,0 +1,7 @@
+const PredictionMarketV3Querier = artifacts.require("PredictionMarketV3Querier");
+
+const { PM3_ADDRESS } = process.env;
+
+module.exports = async function(deployer) {
+  await deployer.deploy(PredictionMarketV3Querier, PM3_ADDRESS);
+}

package/migrations/13_deploy_pm_v3_factory.js

@@ -0,0 +1,14 @@
+const PredictionMarketV3Factory = artifacts.require("PredictionMarketV3Factory");
+
+const { TOKEN, PM3_ADDRESS, REALITIO_ADDRESS } = process.env;
+
+module.exports = async function(deployer) {
+  await deployer.deploy(
+    PredictionMarketV3Factory,
+    TOKEN,
+    '1000000000000000000',
+    PM3_ADDRESS,
+    REALITIO_ADDRESS,
+    { gas: 10000000 }
+  );
+}

package/migrations/1_initial_migration.js

@@ -0,0 +1,5 @@
+const Migrations = artifacts.require("Migrations");
+
+module.exports = function(deployer) {
+  deployer.deploy(Migrations);
+};

package/migrations/2_deploy_erc20.js

@@ -0,0 +1,10 @@
+const PredictionMarket = artifacts.require("PredictionMarket");
+const ERC20PresetMinterPauser = artifacts.require("ERC20PresetMinterPauser");
+const ERC20_USER = process.env.ERC20_USER;
+
+module.exports = async function(deployer, network, accounts) {
+  // NOTE: USE THIS ONLY FOR DEV PURPOSES!!
+  await deployer.deploy(ERC20PresetMinterPauser, "Test Token", "TEST");
+  const token = await ERC20PresetMinterPauser.deployed();
+  await token.mint(ERC20_USER, '100000000000000000000000000');
+}

package/migrations/3_deploy_realitio.js

@@ -0,0 +1,11 @@
+const RealityETH_ERC20_v3_0 = artifacts.require("RealityETH_ERC20_v3_0");
+
+const {
+  TOKEN
+} = process.env;
+
+module.exports = async function (deployer) {
+  await deployer.deploy(RealityETH_ERC20_v3_0);
+  const realitio = await RealityETH_ERC20_v3_0.deployed(RealityETH_ERC20_v3_0);
+  await realitio.setToken(TOKEN);
+};

package/migrations/4_deploy_pm.js

@@ -0,0 +1,20 @@
+const PredictionMarket = artifacts.require("PredictionMarket");
+const {
+  FEE,
+  TOKEN,
+  REQUIRED_BALANCE,
+  REALITIO_ADDRESS,
+  REALITIO_TIMEOUT,
+} = process.env;
+
+
+module.exports = async function(deployer) {
+  await deployer.deploy(
+    PredictionMarket,
+    FEE, // fee
+    TOKEN, // token
+    REQUIRED_BALANCE, // requiredBalance
+    REALITIO_ADDRESS, // realitioAddress
+    REALITIO_TIMEOUT, // realitioTimeout,
+  );
+};

package/migrations/5_seed_markets.js

@@ -0,0 +1,51 @@
+const PredictionMarket = artifacts.require("PredictionMarket");
+const realitioLib = require('@reality.eth/reality-eth-lib/formatters/question');
+const web3 = require('web3');
+
+module.exports = async function(deployer) {
+  const predictionMarket = await PredictionMarket.deployed();
+
+  const markets = [
+    {
+      name: 'Will Bitcoin price be above $100,000 by January 1st 2024?',
+      outcomes: ['Yes', 'No'],
+      category: 'Crypto;Bitcoin',
+      image: 'QmXUiapNZUbxfWpNYMtbT8Xpyk4EdF6gKWa7cw8SBX5gm9',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Will PSG win the champions league?',
+      outcomes: ['Yes', 'No'],
+      category: 'Sports;Football',
+      image: 'QmVbL7tKGeJUcv7KCMYSmz961JdzeMnVAoicnMqNSjyReh',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Will Ethereum price be above $10,000 by January 1st 2024?',
+      outcomes: ['Yes', 'No'],
+      category: 'Crypto;Ethereum',
+      image: 'QmQMWVzqkXrizpiLFqGLvx6ruWzTWUGiUpP2r26jVtDoqT',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Hello world',
+      outcomes: ['Yes', 'No'],
+      category: 'Foo;Bar',
+      image: 'QmRufywuLNzd7xVUwRzp3wBFnFUJ1EmzVH1R5Hq9xMWfkX',
+      closesAt: new Date().getTime() + 300, // expiring 5 minutes after creation
+    },
+  ]
+
+  for (const market of markets) {
+		const question = realitioLib.encodeText('single-select', market.name, market.outcomes, market.category);
+
+    await predictionMarket.createMarket(
+      question,
+      market.image,
+      market.closesAt,
+      '0x000000000000000000000000000000000000dead',
+      2,
+      { value: '10000000000000000' }
+    );
+  }
+};

package/migrations/6_deploy_achievements.js

@@ -0,0 +1,5 @@
+const Achievements = artifacts.require("Achievements");
+
+module.exports = async function(deployer) {
+  await deployer.deploy(Achievements, "Polky", "POLKY");
+};

package/migrations/7_deploy_voting.js

@@ -0,0 +1,14 @@
+const Voting = artifacts.require("Voting");
+
+const {
+  TOKEN,
+  REQUIRED_BALANCE,
+} = process.env;
+
+module.exports = async function (deployer) {
+  await deployer.deploy(
+    Voting,
+    TOKEN,
+    REQUIRED_BALANCE
+  );
+};

package/migrations/8_deploy_pm_v2.js

@@ -0,0 +1,20 @@
+const PredictionMarketV2 = artifacts.require("PredictionMarketV2");
+const {
+  TOKEN,
+  REQUIRED_BALANCE,
+  REALITIO_ADDRESS,
+  REALITIO_TIMEOUT,
+  WETH,
+} = process.env;
+
+
+module.exports = async function(deployer) {
+  await deployer.deploy(
+    PredictionMarketV2,
+    TOKEN, // token
+    REQUIRED_BALANCE, // requiredBalance
+    REALITIO_ADDRESS, // realitioAddress
+    REALITIO_TIMEOUT, // realitioTimeout,
+    WETH, // weth
+  );
+};

package/migrations/9_seed_markets_v2.js

@@ -0,0 +1,68 @@
+const PredictionMarketV2 = artifacts.require("PredictionMarketV2");
+const realitioLib = require('@reality.eth/reality-eth-lib/formatters/question');
+const web3 = require('web3');
+
+module.exports = async function(deployer) {
+  const predictionMarket = await PredictionMarketV2.deployed();
+
+  const markets = [
+    {
+      name: 'Will Bitcoin price be above $100,000 by January 1st 2024?',
+      outcomes: ['Yes', 'No'],
+      category: 'Crypto;Bitcoin',
+      image: 'QmXUiapNZUbxfWpNYMtbT8Xpyk4EdF6gKWa7cw8SBX5gm9',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Market with 3 outcomes',
+      outcomes: ['Outcome A', 'Outcome B', 'Outcome C'],
+      category: 'Other;Misc',
+      image: 'QmdRGv8odwsnafpz49ZayQNhmJzJTaT2kjXrrm6aBMJ1Qw',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Market with 4 outcomes',
+      outcomes: ['Outcome A', 'Outcome B', 'Outcome C', 'Outcome D'],
+      category: 'Other;Misc',
+      image: 'QmdRGv8odwsnafpz49ZayQNhmJzJTaT2kjXrrm6aBMJ1Qw',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Market with 3 outcomes uneven',
+      outcomes: ['Outcome A', 'Outcome B', 'Outcome C'],
+      category: 'Other;Misc',
+      image: 'QmdRGv8odwsnafpz49ZayQNhmJzJTaT2kjXrrm6aBMJ1Qw',
+      closesAt: 1704067200,
+      distribution: [300000000, 975000000, 1300000000],
+    },
+    {
+      name: 'Market with 10 outcomes',
+      outcomes: ['Outcome A', 'Outcome B', 'Outcome C', 'Outcome D', 'Outcome E', 'Outcome F', 'Outcome G', 'Outcome H', 'Outcome I', 'Outcome J'],
+      category: 'Other;Misc',
+      image: 'QmdRGv8odwsnafpz49ZayQNhmJzJTaT2kjXrrm6aBMJ1Qw',
+      closesAt: 1704067200,
+    },
+    {
+      name: 'Market with 32 outcomes',
+      outcomes: ['Outcome A', 'Outcome B', 'Outcome C', 'Outcome D', 'Outcome E', 'Outcome F', 'Outcome G', 'Outcome H', 'Outcome I', 'Outcome J', 'Outcome K', 'Outcome L', 'Outcome M', 'Outcome N', 'Outcome O', 'Outcome P', 'Outcome Q', 'Outcome R', 'Outcome S', 'Outcome T', 'Outcome U', 'Outcome V', 'Outcome W', 'Outcome X', 'Outcome Y', 'Outcome Z', 'Outcome AA', 'Outcome BB', 'Outcome CC', 'Outcome DD', 'Outcome EE', 'Outcome FF'],
+      category: 'Other;Misc',
+      image: 'QmdRGv8odwsnafpz49ZayQNhmJzJTaT2kjXrrm6aBMJ1Qw',
+      closesAt: 1704067200,
+    },
+  ]
+
+  for (const market of markets) {
+		const question = realitioLib.encodeText('single-select', market.name, market.outcomes, market.category);
+
+    await predictionMarket.createMarket({
+        value: '10000000000000000000',
+        closesAt: market.closesAt,
+        outcomes: market.outcomes.length,
+        token: '0x7895b8d634709dd810e384df27a8c989c907fc4a',
+        distribution: market.distribution || [],
+        question,
+        image: market.image,
+        arbitrator: '0x000000000000000000000000000000000000dead',
+      });
+  }
+};

package/package.json

@@ -1,15 +1,108 @@
 {
-  "name": "polkamarkets-js",
-  "version": "1.0.2",
-  "description": "Polkamarkets Javascript SDK",
-  "engines": {
-    "node": "^14.15.0"
-  },
-  "dependencies": {
-    "bepro-js": "bepronetwork/bepro-js#feature/prediction-markets"
-  },
-  "main": "polkamarkets.js",
-  "repository": "https://github.com/Polkamarkets/polkamarkets-js",
-  "author": "Ricardo Marques <ricardo@polkamarkets.com>",
-  "license": "MIT"
+    "name": "polkamarkets-js",
+    "version": "3.1.0",
+    "description": "",
+    "main": "index.js",
+    "directories": {
+        "test": "test"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Polkamarkets/polkamarkets-js.git"
+    },
+    "scripts": {
+        "test": "npm run compile && ./node_modules/.bin/mocha ./tests/index.js --timeout 3000000 --require babel-core/register --require babel-polyfill --exit",
+        "index": "babel-node ./index.js --presets es2015,stage-2",
+        "build": "npm run compile && babel ./src --out-dir lib --copy-files -d ./build",
+        "compile": "truffle compile",
+        "postcompile": "node ./cleanContracts.js",
+        "docs:api": "jsdoc2md --configure tooling/docs/jsdoc.json --files src/**/*.js > docs/README.md",
+        "docs:prepare": "gitbook install",
+        "docs:build": "npm run docs:prepare && npm run docs:api && gitbook build",
+        "docs:serve": "npm run docs:prepare && npm run docs:api && gitbook serve",
+        "docs:clean": "rimraf _book",
+        "install": "( [ ! -d ./build ] && [ ! -f ./built ] && echo \"\" > ./built && npm install . && npm run build ) || echo \"Already built\""
+    },
+    "dependencies": {
+        "@metamask/safe-event-emitter": "^2.0.0",
+        "@metamask/utils": "^8.2.1",
+        "@openzeppelin/contracts": "^4.8.2",
+        "@openzeppelin/contracts-upgradeable": "^4.8.2",
+        "@openzeppelin/truffle-upgrades": "^1.7.0",
+        "@particle-network/aa": "^1.2.0",
+        "@reality.eth/reality-eth-lib": "^3.2.10",
+        "axios": "^0.24.0",
+        "babel-cli": "^6.26.0",
+        "babel-plugin-transform-runtime": "^6.23.0",
+        "babel-preset-env": "^1.6.1",
+        "babel-preset-stage-2": "^6.24.1",
+        "chai": "^4.2.0",
+        "dotenv": "^8.2.0",
+        "ethers": "^5.6.9",
+        "html-to-text": "9.0.5",
+        "left-pad": "^1.3.0",
+        "lodash": "^4.17.10",
+        "mocha": "^5.1.1",
+        "moment": "^2.21.0",
+        "node-gyp": "^9.4.0",
+        "permissionless": "0.1.30",
+        "superstruct": "^1.0.3",
+        "thirdweb": "^5.64.3",
+        "viem": "^2.13.3",
+        "web3": "1.9.0"
+    },
+    "devDependencies": {
+        "@truffle/hdwallet-provider": "^1.4.0",
+        "babel-plugin-transform-runtime": "^6.23.0",
+        "babel-preset-env": "^1.6.1",
+        "babel-preset-es2015": "^6.24.1",
+        "babel-register": "^6.26.0",
+        "gitbook-cli": "^2.3.2",
+        "jsdoc-babel": "^0.5.0",
+        "jsdoc-md": "^8.0.0",
+        "jsdoc-to-markdown": "^6.0.1",
+        "prettier": "^2.3.2",
+        "prettier-plugin-solidity": "^1.0.0-beta.14",
+        "should": "^7.1.0",
+        "solc": "^0.6.0",
+        "supertest": "^1.0.0",
+        "truffle-contract-size": "^2.0.1",
+        "truffle-plugin-verify": "^0.5.15"
+    },
+    "babel": {
+        "presets": [
+            "env",
+            "es2015",
+            "stage-2"
+        ],
+        "plugins": [
+            "transform-runtime"
+        ],
+        "sourceMaps": true,
+        "retainLines": true
+    },
+    "author": "",
+    "license": "ISC",
+    "prettier": {
+        "overrides": [
+            {
+                "files": "*.sol",
+                "options": {
+                    "printWidth": 120,
+                    "tabWidth": 2,
+                    "useTabs": false,
+                    "singleQuote": false,
+                    "bracketSpacing": false,
+                    "explicitTypes": "always"
+                }
+            }
+        ]
+    },
+    "resolutions": {
+        "babel-loader": "8.1.0",
+        "webpack": "4.44.2",
+        "styled-components": "^5",
+        "html-to-text": "^7.1.1",
+        "marked": "3.0.8"
+    }
 }