guide.helper.js

const commandLineUsage = require("command-line-usage");
const sections = [
  {
    header: "The Crypto Farm Toolkit",
    content: "A toolkit for interacting with smart contracts",
  },
  {
    content: "Usage: node app COMMAND [OPTIONS]",
  },
  {
    header: "Options",
    optionList: [
      {
        name: "env",
        typeLabel: "{underline file}",
        description: "JSON file to use [defaults to env.json]",
      },
      {
        name: "token",
        typeLabel: "{underline string}",
        description: "Token contract address to interact with",
      },
      {
        name: "wbnb",
        typeLabel: "{underline string}",
        description:
          "WBNB Token contract to interact with [defaults to mainnet contract]",
      },
      {
        name: "router",
        typeLabel: "{underline string}",
        description: "Router contract to interact with [defaults to PCSv2]",
      },
      {
        name: "factory",
        typeLabel: "{underline string}",
        description: "Factory contract to interact with [defaults to PCS]",
      },
      {
        name: "gasLimit",
        typeLabel: "{underline integer}",
        description: "Gas limit to use [defaults to 2,000,000]",
      },
      {
        name: "gasPrice",
        typeLabel: "{underline integer}",
        description: "Gas Price to use [defaults to 7]",
      },
      {
        name: "deadline",
        typeLabel: "{underline integer}",
        description:
          "Seconds to allow transaction to process before revert [defaults to 120]",
      },
      {
        name: "slippage",
        typeLabel: "{underline integer}",
        description: "Slippage to use (percentage) [defaults to 1]",
      },
      {
        name: "depositAmount",
        typeLabel: "{underline float}",
        description: "Amount of BNB to Wrap",
      },
      {
        name: "withdrawAmount",
        typeLabel: "{underline float}",
        description: "Amount of BNB to Unrwap",
      },
      {
        name: "purchaseAmount",
        typeLabel: "{underline float}",
        description: "Amount of [token] to buy in BNB",
      },
      {
        name: "sellAmount",
        typeLabel: "{underline float}",
        description: "Amount of [token] to sell for BNB",
      },
      {
        name: "sellDelay",
        typeLabel: "{underline integer}",
        description: "SOON: Delay (in ms) to add before selling (EXPERT)",
      },
      {
        name: "sellPercent",
        typeLabel: "{underline integer}",
        description: "SOON: Percentage of [token] to sell (EXPERT)",
      },
    ],
  },
  {
    header: "Command List",
    content: [
      {
        name: "approve",
        summary: "Approve your Tokens for sale on [router]",
      },
      {
        name: "buy",
        summary: "Buy tokens using [router]",
      },
      {
        name: "sell",
        summary: "Sell tokens using [router]",
      },
      {
        name: "balance",
        summary: "Balance of BNB in wallet",
      },
      {
        name: "tokenBalance",
        summary: "Balance of [token] in wallet",
      },
      {
        name: "deposit",
        summary: "Wrap BNB",
      },
      {
        name: "withdraw",
        summary: "UnWrap BNB",
      },
      {
        name: "getPair",
        summary: "Get Pancake Pair contract from [token]",
      },
      {
        name: "getReserves",
        summary: "Get Reserves for [token]",
      },
      {
        name: "txpool",
        summary: "SOON: EXPERT: Snipe direct liquidity events using [router]",
      },
      {
        name: "dxsale",
        summary: "SOON: ELITE: Snipe dxSale finalizations",
      },
    ],
  },
];
const displayGuide = () => {
  console.log(commandLineUsage(sections));
  process.exit();
};

module.exports = displayGuide;