polkamarkets-js 1.0.2 → 3.1.0

package/src/models/PolkamarketsSmartAccount.js

@@ -0,0 +1,100 @@
+const { SmartAccount } = require('@particle-network/aa');
+const ethers = require('ethers').ethers;
+
+const { ENTRYPOINT_ADDRESS_V06, providerToSmartAccountSigner } = require('permissionless');
+const { createPublicClient, http } = require('viem');
+const { signerToSimpleSmartAccount } = require('permissionless/accounts');
+
+class PolkamarketsSmartAccount {
+
+  static PIMLICO_FACTORY_ADDRESS = '0x9406Cc6185a346906296840746125a0E44976454';
+  static THIRDWEB_FACTORY_ADDRESS = '0x85e23b94e7F5E9cC1fF78BCe78cfb15B81f0DF00';
+
+  static singleton = (() => {
+    let smartAccount;
+
+    function createInstance(provider, networkConfig, isConnectedWallet) {
+      const options = {
+        projectId: networkConfig.particleProjectId,
+        clientKey: networkConfig.particleClientKey,
+        appId: networkConfig.particleAppId,
+        aaOptions: {
+          accountContracts: {
+            SIMPLE: [{
+              version: '1.0.0',
+              chainIds: [networkConfig.chainId],
+            }],
+          }
+        },
+      };
+
+      const instance = new PolkamarketsSmartAccount();
+      instance.networkConfig = networkConfig;
+      instance.provider = provider
+      instance.isConnectedWallet = isConnectedWallet
+      if (!networkConfig.usePimlico && !networkConfig.useThirdWeb) {
+        instance.smartAccount = new SmartAccount(provider, options);
+        instance.smartAccount.setSmartAccountContract({ name: 'SIMPLE', version: '1.0.0' })
+      }
+      return instance;
+    }
+
+    return {
+      getInstance: (provider, networkConfig, isConnectedWallet) => {
+        if (!smartAccount) {
+          smartAccount = createInstance(provider, networkConfig, isConnectedWallet);
+        }
+        return smartAccount;
+      },
+      getInstanceIfExists: () => smartAccount,
+      clearInstance: () => {
+        smartAccount = null;
+      }
+    };
+  })();
+
+  async providerIsConnectedWallet() {
+    if (this.isConnectedWallet) {
+      const web3Provider = new ethers.providers.Web3Provider(this.provider)
+      const signer = web3Provider.getSigner()
+      const address = await signer.getAddress();
+
+      return { isConnectedWallet: true, address, signer };
+    }
+
+    return { isConnectedWallet: false, address: null, signer: null };
+  }
+
+  async getAddress() {
+    const { isConnectedWallet, address } = await this.providerIsConnectedWallet();
+    if (isConnectedWallet) {
+      return address;
+    }
+
+    if (this.networkConfig.useThirdWeb && this.provider.adminAccount) {
+      // if exists adminAccount it means it's using thirdwebauth
+      return this.provider.smartAccount.address;
+    }
+
+    if (this.networkConfig.usePimlico || this.networkConfig.useThirdWeb) {
+      const publicClient = createPublicClient({
+        chain: this.networkConfig.viemChain,
+        transport: http(this.networkConfig.rpcUrl)
+      });
+
+      const smartAccountSigner = await providerToSmartAccountSigner(this.provider);
+
+      const smartAccount = await signerToSimpleSmartAccount(publicClient, {
+        signer: smartAccountSigner,
+        factoryAddress: PolkamarketsSmartAccount.PIMLICO_FACTORY_ADDRESS,
+        entryPoint: ENTRYPOINT_ADDRESS_V06,
+      })
+
+      return smartAccount.address;
+    }
+
+    return this.smartAccount.getAddress();
+  }
+}
+
+module.exports = PolkamarketsSmartAccount;

package/src/models/PredictionMarketContract.js

@@ -0,0 +1,562 @@
+const _ = require("lodash");
+const moment = require("moment");
+
+const prediction = require("../interfaces").prediction;
+
+const Numbers = require("../utils/Numbers");
+const IContract = require('./IContract');
+
+const realitioLib = require('@reality.eth/reality-eth-lib/formatters/question');
+
+const actions = {
+  0: 'Buy',
+  1: 'Sell',
+  2: 'Add Liquidity',
+  3: 'Remove Liquidity',
+  4: 'Claim Winnings',
+  5: 'Claim Liquidity',
+  6: 'Claim Fees',
+  7: 'Claim Voided',
+}
+
+/**
+ * PredictionMarket Contract Object
+ * @constructor PredictionMarketContract
+ * @param {Web3} web3
+ * @param {Integer} decimals
+ * @param {Address} contractAddress
+ */
+
+class PredictionMarketContract extends IContract {
+  constructor(params) {
+    super({ abi: prediction, ...params });
+    this.contractName = 'predictionMarket';
+  }
+
+  /* Get Functions */
+  /**
+   * @function getMinimumRequiredBalance
+   * @description Returns minimum required ERC20 balance to create markets
+   * @returns {Integer} requiredBalance
+   */
+  async getMinimumRequiredBalance() {
+    const requiredBalance = await this.params.contract
+      .getContract()
+      .methods
+      .requiredBalance()
+      .call();
+
+    return Numbers.fromDecimalsNumber(requiredBalance, 18)
+  }
+
+  /* Get Functions */
+  /**
+   * @function getFee
+   * @description Returns fee taken from every transaction to liquidity providers
+   * @returns {Integer} fee
+   */
+  async getFee() {
+    const fee = await this.params.contract
+      .getContract()
+      .methods
+      .fee()
+      .call();
+
+    return Numbers.fromDecimalsNumber(fee, 18)
+  }
+
+  /* Get Functions */
+  /**
+   * @function getMarkets
+   * @description Get Markets
+   * @returns {Integer | Array} Get Market Ids
+   */
+  async getMarkets() {
+    let res = await this.params.contract
+      .getContract()
+      .methods
+      .getMarkets()
+      .call();
+    return res.map((marketId) => Number(Numbers.fromHex(marketId)));
+  }
+
+  /**
+   * @function getMarketData
+   * @description Get getMarketData
+   * @param {Integer} marketId
+   * @returns {String} Market Name
+   * @returns {Integer} closeDateTime
+   * @returns {Integer} state
+   * @returns {Address} Oracle Address
+   * @returns {Integer} liquidity
+   * @returns {Array} outcomeIds
+   */
+  async getMarketData({ marketId }) {
+    const marketData = await this.params.contract.getContract().methods.getMarketData(marketId).call();
+    const outcomeIds = await this.__sendTx(this.getContract().methods.getMarketOutcomeIds(marketId), true);
+
+    return {
+      name: '', // TODO: remove; deprecated
+      closeDateTime: moment.unix(marketData[1]).format("YYYY-MM-DD HH:mm"),
+      state: parseInt(marketData[0]),
+      oracleAddress: '0x0000000000000000000000000000000000000000',
+      liquidity: Numbers.fromDecimalsNumber(marketData[2], 18),
+      outcomeIds: outcomeIds.map((outcomeId) => Numbers.fromBigNumberToInteger(outcomeId, 18))
+    };
+  }
+
+  /**
+   * @function getOutcomeData
+   * @description Get Market Outcome Data
+   * @param {Integer} marketId
+   * @param {Integer} outcomeId
+   * @returns {String} name
+   * @returns {Integer} price
+   * @returns {Integer} sahres
+   */
+  async getOutcomeData({ marketId, outcomeId }) {
+    const outcomeData = await this.params.contract.getContract().methods.getMarketOutcomeData(marketId, outcomeId).call();
+
+    return {
+      name: '', // TODO: remove; deprecated
+      price: Numbers.fromDecimalsNumber(outcomeData[0], 18),
+      shares: Numbers.fromDecimalsNumber(outcomeData[1], 18),
+    };
+  }
+
+  /**
+   * @function getMarketDetails
+   * @description getMarketDetails
+   * @param {Integer} marketId
+   * @returns {String} name
+   * @returns {String} category
+   * @returns {String} subcategory
+   * @returns {String} image
+   * @returns {Array} outcomes
+   */
+  async getMarketDetails({ marketId }) {
+    const marketData = await this.params.contract.getContract().methods.getMarketData(marketId).call();
+    const outcomeIds = await this.__sendTx(this.getContract().methods.getMarketOutcomeIds(marketId), true);
+
+    const events = await this.getEvents('MarketCreated', { marketId });
+
+    if (events.length === 0) {
+      // legacy record, returning empty data
+      return { name: '', category: '', subcategory: '', image: '', outcomes: [] };
+    }
+
+    // parsing question with realitio standard
+    const question = realitioLib.populatedJSONForTemplate(
+      '{"title": "%s", "type": "single-select", "outcomes": [%s], "category": "%s", "lang": "%s"}',
+      events[0].returnValues.question
+    );
+
+    return {
+      name: question.title,
+      category: question.category.split(';')[0],
+      subcategory: question.category.split(';')[1],
+      outcomes: question.outcomes,
+      image: events[0].returnValues.image
+    };
+  }
+
+  async getMarketIdsFromQuestions({ questions }) {
+    const events = await this.getEvents('MarketCreated');
+
+    return events.filter((event) => {
+      return questions.includes(event.returnValues.question);
+    }).map((event) => event.returnValues.marketId);
+  }
+
+  /**
+   * @function getMarketQuestionId
+   * @description getMarketQuestionId
+   * @param {Integer} marketId
+   * @returns {Bytes32} questionId
+   */
+  async getMarketQuestionId({ marketId }) {
+    const marketAltData = await this.params.contract.getContract().methods.getMarketAltData(marketId).call();
+
+    return marketAltData[1];
+  }
+
+  /**
+   * @function getAverageOutcomeBuyPrice
+   * @description Calculates average buy price of market outcome based on user events
+   * @param {Array} events
+   * @param {Integer} marketId
+   * @param {Integer} outcomeId
+   * @returns {Integer} price
+   */
+  getAverageOutcomeBuyPrice({ events, marketId, outcomeId }) {
+    // filtering by marketId + outcomeId + buy action
+    events = events.filter(event => {
+      return (
+        event.action === 'Buy' &&
+        event.marketId === marketId &&
+        event.outcomeId === outcomeId
+      );
+    });
+
+    if (events.length === 0) return 0;
+
+    const totalShares = events.map(item => item.shares).reduce((prev, next) => prev + next);
+    const totalAmount = events.map(item => item.value).reduce((prev, next) => prev + next);
+
+    return totalAmount / totalShares;
+  }
+
+  /**
+   * @function getAverageAddLiquidityPrice
+   * @description Calculates average add liquidity of market outcome based on user events
+   * @param {Array} events
+   * @param {Integer} marketId
+   * @returns {Integer} price
+   */
+  getAverageAddLiquidityPrice({ events, marketId }) {
+    // filtering by marketId + add liquidity action
+    events = events.filter(event => {
+      return (
+        event.action === 'Add Liquidity' &&
+        event.marketId === marketId
+      );
+    });
+
+    if (events.length === 0) return 0;
+
+    const totalShares = events.map(item => item.shares).reduce((prev, next) => prev + next);
+    const totalAmount = events.map(item => item.value).reduce((prev, next) => prev + next);
+
+    return totalAmount / totalShares;
+  }
+
+  /**
+   * @function getMyPortfolio
+   * @description Get My Porfolio
+   * @returns {Array} Outcome Shares
+   */
+  async getMyPortfolio() {
+    const account = await this.getMyAccount();
+    if (!account) return [];
+
+    return this.getPortfolio({ user: account });
+  }
+
+  /**
+   * @function getPortfolio
+   * @description Get My Porfolio
+   * @param {Address} user
+   * @returns {Array} Outcome Shares
+   */
+  async getPortfolio({ user }) {
+    const events = await this.getActions({ user });
+    const allMarketIds = await this.getMarkets();
+    const userMarketIds = events.map(e => e.marketId).filter((x, i, a) => a.indexOf(x) == i);
+
+    return await allMarketIds.reduce(async (obj, marketId) => {
+      let portfolio;
+      if (!userMarketIds.includes(marketId)) {
+        // user did not interact with market, no need to fetch holdings
+        portfolio = {
+          liquidity: { shares: 0, price: 0 },
+          outcomes: {
+            0: { shares: 0, price: 0 },
+            1: { shares: 0, price: 0 },
+          },
+          claimStatus: {
+            winningsToClaim: false,
+            winningsClaimed: false,
+            liquidityToClaim: false,
+            liquidityClaimed: false,
+            liquidityFees: 0
+          }
+        };
+      } else {
+        const marketShares = await this.getContract().methods.getUserMarketShares(marketId, user).call();
+        let claimStatus;
+        try {
+          claimStatus = await this.getContract().methods.getUserClaimStatus(marketId, user).call();
+        } catch (err) {
+          // SafeMath subtraction overflow error from Moonriver deployment
+          if (err.message.includes('SafeMath: subtraction overflow')) {
+            claimStatus = [false, false, false, false, 0];
+
+            const marketData = await this.params.contract.getContract().methods.getMarketData(marketId).call();
+            if (parseInt(marketData[0]) === 2) {
+              // market resolved, computing if user has winnings to claim
+              claimStatus[0] = marketShares[parseInt(marketData[5]) + 1] > 0;
+              if (claimStatus[0]) {
+                const events = await this.getEvents('MarketActionTx', { marketId, user, action: 4 });
+                claimStatus[1] = events.length > 0;
+              }
+              claimStatus[2] = marketShares[0] > 0;
+              claimStatus[3] = claimStatus[2];
+            }
+          } else {
+            throw err;
+          }
+        }
+
+        portfolio = {
+          liquidity: {
+            shares: Numbers.fromDecimalsNumber(marketShares[0], 18),
+            price: this.getAverageAddLiquidityPrice({ events, marketId }),
+          },
+          outcomes: {
+            0: {
+              shares: Numbers.fromDecimalsNumber(marketShares[1], 18),
+              price: this.getAverageOutcomeBuyPrice({ events, marketId, outcomeId: 0 }),
+            },
+            1: {
+              shares: Numbers.fromDecimalsNumber(marketShares[2], 18),
+              price: this.getAverageOutcomeBuyPrice({ events, marketId, outcomeId: 1 }),
+            },
+          },
+          claimStatus: {
+            winningsToClaim: claimStatus[0],
+            winningsClaimed: claimStatus[1],
+            liquidityToClaim: claimStatus[2],
+            liquidityClaimed: claimStatus[3],
+            liquidityFees: Numbers.fromDecimalsNumber(claimStatus[4], 18)
+          }
+        };
+      }
+
+      return await {
+        ...(await obj),
+        [marketId]: portfolio,
+      };
+    }, {});
+  }
+
+  /**
+   * @function getMyMarketShares
+   * @description Get My Market Shares
+   * @param {Integer} marketId
+   * @returns {Integer} Liquidity Shares
+   * @returns {Array} Outcome Shares
+   */
+  async getMyMarketShares({ marketId }) {
+    const account = await this.getMyAccount();
+    if (!account) return [];
+
+    const marketShares = await this.getContract().methods.getUserMarketShares(marketId, account).call();
+
+    return {
+      liquidityShares: Numbers.fromDecimalsNumber(marketShares[0], 18),
+      outcomeShares: {
+        0: Numbers.fromDecimalsNumber(marketShares[1], 18),
+        1: Numbers.fromDecimalsNumber(marketShares[2], 18),
+      }
+    };
+  }
+
+  async getMyActions() {
+    const account = await this.getMyAccount();
+    if (!account) return [];
+
+    return this.getActions({ user: account });
+  }
+
+  async getActions({ user }) {
+    const events = await this.getEvents('MarketActionTx', { user });
+
+    // filtering by address
+    return events.map(event => {
+      return {
+        action: actions[Numbers.fromBigNumberToInteger(event.returnValues.action, 18)],
+        marketId: Numbers.fromBigNumberToInteger(event.returnValues.marketId, 18),
+        outcomeId: Numbers.fromBigNumberToInteger(event.returnValues.outcomeId, 18),
+        shares: Numbers.fromDecimalsNumber(event.returnValues.shares, 18),
+        value: Numbers.fromDecimalsNumber(event.returnValues.value, 18),
+        timestamp: Numbers.fromBigNumberToInteger(event.returnValues.timestamp, 18),
+        transactionHash: event.transactionHash,
+      }
+    });
+  }
+
+  /**
+   * @function getMarketOutcomePrice
+   * @description Get Market Price
+   * @param {Integer} marketId
+   * @param {Integer} outcomeId
+   * @return {Integer} price
+   */
+  async getMarketOutcomePrice({ marketId, outcomeId }) {
+    return Numbers.fromDecimals(
+      await this.__sendTx(
+        this.getContract().methods.getMarketOutcomePrice(marketId, outcomeId),
+        true
+      ),
+      18
+    );
+  }
+
+  /**
+   * @function getMarketPrices
+   * @description Get Market Price
+   * @param {Integer} marketId
+   * @return {Object} prices
+   */
+  async getMarketPrices({ marketId }) {
+    const marketPrices = await this.getContract().methods.getMarketPrices(marketId).call();
+
+    return {
+      liquidity: Numbers.fromDecimalsNumber(marketPrices[0], 18),
+      outcomes: {
+        0: Numbers.fromDecimalsNumber(marketPrices[1], 18),
+        1: Numbers.fromDecimalsNumber(marketPrices[2], 18)
+      }
+    };
+  }
+
+  /* POST User Functions */
+
+  /**
+   * @function createMarket
+   * @description Create a µarket
+   * @param {String} name
+   * @param {Integer} duration
+   * @param {Address} oracleAddress
+   * @param {String} outcome1Name
+   * @param {String} outcome2Name
+   * @param {Integer} ethAmount
+   */
+  async createMarket({ name, image, duration, oracleAddress, outcomes, category, ethAmount }) {
+    let ethToWei = Numbers.toSmartContractDecimals(ethAmount, 18);
+    const question = realitioLib.encodeText('single-select', name, outcomes, category);
+
+    return await this.__sendTx(
+      this.getContract().methods.createMarket(
+        question,
+        image,
+        duration,
+        oracleAddress,
+        outcomes.length
+      ),
+      false,
+      ethToWei
+    );
+  };
+
+  /**
+   * @function addLiquidity
+   * @description Add Liquidity from Market
+   * @param {Integer} marketId
+   * @param {Integer} ethAmount
+   */
+  async addLiquidity({ marketId, ethAmount }) {
+    let ethToWei = Numbers.toSmartContractDecimals(ethAmount, 18);
+    return await this.__sendTx(
+      this.getContract().methods.addLiquidity(marketId),
+      false,
+      ethToWei
+    );
+  };
+
+  /**
+   * @function removeLiquidity
+   * @description Remove Liquidity from Market
+   * @param {Integer} marketId
+   * @param {Integer} shares
+   */
+  async removeLiquidity({ marketId, shares }) {
+    shares = Numbers.toSmartContractDecimals(shares, 18);
+    return await this.__sendTx(
+      this.getContract().methods.removeLiquidity(marketId, shares)
+    );
+  };
+
+
+  /**
+   * @function buy
+   * @description Buy Shares of a Market Outcome
+   * @param {Integer} marketId
+   * @param {Integer} outcomeId
+   * @param {Integer} ethAmount
+   */
+  async buy({ marketId, outcomeId, ethAmount, minOutcomeSharesToBuy }) {
+    let ethToWei = Numbers.toSmartContractDecimals(ethAmount, 18);
+    minOutcomeSharesToBuy = Numbers.toSmartContractDecimals(minOutcomeSharesToBuy, 18);
+
+    return await this.__sendTx(
+      this.getContract().methods.buy(marketId, outcomeId, minOutcomeSharesToBuy),
+      false,
+      ethToWei
+    );
+  };
+
+  /**
+   * @function sell
+   * @description Sell Shares of a Market Outcome
+   * @param {Integer} marketId
+   * @param {Integer} outcomeId
+   * @param {Integer} shares
+   */
+  async sell({ marketId, outcomeId, ethAmount, maxOutcomeSharesToSell }) {
+    ethAmount = Numbers.toSmartContractDecimals(ethAmount, 18);
+    maxOutcomeSharesToSell = Numbers.toSmartContractDecimals(maxOutcomeSharesToSell, 18);
+    return await this.__sendTx(
+      this.getContract().methods.sell(marketId, outcomeId, ethAmount, maxOutcomeSharesToSell),
+      false,
+    );
+  };
+
+  async resolveMarketOutcome({ marketId }) {
+    return await this.__sendTx(
+      this.getContract().methods.resolveMarketOutcome(marketId),
+      false,
+    );
+  };
+
+  async claimWinnings({ marketId }) {
+    return await this.__sendTx(
+      this.getContract().methods.claimWinnings(marketId),
+      false,
+    );
+  };
+
+  async claimVoidedOutcomeShares({ marketId, outcomeId }) {
+    return await this.__sendTx(
+      this.getContract().methods.claimVoidedOutcomeShares(marketId, outcomeId),
+      false,
+    );
+  };
+
+  async claimLiquidity({ marketId }) {
+    return await this.__sendTx(
+      this.getContract().methods.claimLiquidity(marketId),
+      false,
+    );
+  };
+
+  async calcBuyAmount({ marketId, outcomeId, ethAmount }) {
+    ethAmount = Numbers.toSmartContractDecimals(ethAmount, 18);
+
+    const amount = await this.getContract()
+      .methods.calcBuyAmount(
+        ethAmount,
+        marketId,
+        outcomeId
+      )
+      .call();
+
+    return Numbers.fromDecimalsNumber(amount, 18);
+  }
+
+  async calcSellAmount({ marketId, outcomeId, ethAmount }) {
+    ethAmount = Numbers.toSmartContractDecimals(ethAmount, 18);
+
+    const amount = await this.getContract()
+      .methods.calcSellAmount(
+        ethAmount,
+        marketId,
+        outcomeId
+      )
+      .call();
+
+    return Numbers.fromDecimalsNumber(amount, 18);
+  }
+}
+
+module.exports = PredictionMarketContract;