@simbachain/libsimba-js/dist/docs/lint.json

libsimba-js is a library simplifying the use of SIMBAChain APIs. We aim to abstract away the various blockchain concepts, reducing the necessary time needed to get to working code.

[
  {
    "name": "Simbachain#callMethodWithFile",
    "filePath": "src/simba/simba.js",
    "lines": [
      {
        "lineNumber": 250,
        "line": "    /**"
      },
      {
        "lineNumber": 251,
        "line": "     * @override"
      },
      {
        "lineNumber": 252,
        "line": "     * Call a method on the API with files"
      },
      {
        "lineNumber": 253,
        "line": "     * @param {string} method - the method to call"
      },
      {
        "lineNumber": 254,
        "line": "     * @param {Object} parameters- the parameters for the method"
      },
      {
        "lineNumber": 255,
        "line": "     * @param {Array<Blob|File>} files - the files"
      },
      {
        "lineNumber": 256,
        "line": "     * @return {Promise<Object>} - a promise resolving with the transaction details"
      },
      {
        "lineNumber": 257,
        "line": "     */"
      },
      {
        "lineNumber": 258,
        "line": "    async callMethodWithFile(method, parameters, files) {"
      }
    ],
    "codeParams": [
      "method",
      "parameters",
      "files"
    ],
    "docParams": [
      "method",
      "parameters-",
      "files"
    ]
  },
  {
    "name": "Simbachain#submitTxn",
    "filePath": "src/simba/simba.js",
    "lines": [
      {
        "lineNumber": 279,
        "line": "    /**"
      },
      {
        "lineNumber": 280,
        "line": "     * @private"
      },
      {
        "lineNumber": 281,
        "line": "     * Internal method for submitting method calls and retrying on nonce errors"
      },
      {
        "lineNumber": 282,
        "line": "     * @param {string} txnId - the txnId"
      },
      {
        "lineNumber": 283,
        "line": "     * @param {string} signed - The signed txn"
      },
      {
        "lineNumber": 284,
        "line": "     * @returns {Promise<Response>} - The response with transaction data"
      },
      {
        "lineNumber": 285,
        "line": "     */"
      },
      {
        "lineNumber": 286,
        "line": "    async submitTxn(txnId, payload, maxTries, currentTry){"
      }
    ],
    "codeParams": [
      "txnId",
      "payload",
      "maxTries",
      "currentTry"
    ],
    "docParams": [
      "txnId",
      "signed"
    ]
  },
  {
    "name": "Simbachain#sendMethodRequest",
    "filePath": "src/simba/simba.js",
    "lines": [
      {
        "lineNumber": 325,
        "line": "    /**"
      },
      {
        "lineNumber": 326,
        "line": "     * @private"
      },
      {
        "lineNumber": 327,
        "line": "     * Internal method for sending method calls"
      },
      {
        "lineNumber": 328,
        "line": "     * @param {string} url - the url"
      },
      {
        "lineNumber": 329,
        "line": "     * @param {FormData} formdata - Formdata for the POST"
      },
      {
        "lineNumber": 330,
        "line": "     * @returns {Promise<Response>} - The response with transaction data"
      },
      {
        "lineNumber": 331,
        "line": "     */"
      },
      {
        "lineNumber": 332,
        "line": "    async sendMethodRequest(method, formdata){"
      }
    ],
    "codeParams": [
      "method",
      "formdata"
    ],
    "docParams": [
      "url",
      "formdata"
    ]
  },
  {
    "name": "PKWallet#generateWallet",
    "filePath": "src/wallet/pkwallet.js",
    "lines": [
      {
        "lineNumber": 33,
        "line": "    /**"
      },
      {
        "lineNumber": 34,
        "line": "     * @override"
      },
      {
        "lineNumber": 35,
        "line": "     * Generate a wallet"
      },
      {
        "lineNumber": 36,
        "line": "     * @param {string} passkey - The pass key to lock the wallet"
      },
      {
        "lineNumber": 37,
        "line": "     * @param {function} [progressCB] - A callback, accepting a number between 0-1, indicating decryption progress"
      },
      {
        "lineNumber": 38,
        "line": "     * @returns {Promise} - Returns a promise resolving with the private key when the wallet is created"
      },
      {
        "lineNumber": 39,
        "line": "     */"
      },
      {
        "lineNumber": 40,
        "line": "    generateWallet(progressCB){"
      }
    ],
    "codeParams": [
      "progressCB"
    ],
    "docParams": [
      "passkey",
      "progressCB"
    ]
  }
]