@meterio/sumer-js 0.0.13 → 0.1.0

package/scripts/venus-docs.js

@@ -1,236 +0,0 @@
-const fs = require('fs');
-const docblockParser = require('docblock-parser');
-
-String.prototype.toSingleLine = function () {
-  return this.replace(/\n {4}/g, ' ');
-}
-
-// Credit https://stackoverflow.com/a/7225450/6193736
-String.prototype.toTitleCase = function () {
-  const result = this.replace(/([A-Z])/g, ' $1');
-  return result.charAt(0).toUpperCase() + result.slice(1);
-}
-
-String.prototype.toKebabCase = function () {
-  const title = this.toTitleCase();
-  return title.replace(/\s/g, '-').toLowerCase();
-}
-
-// remove trailing slash due to docblock-parser bug
-function unSlashBug(parsed) {
-  const tags = parsed.tags;
-
-  if (!tags) {
-    return parsed;
-  }
-
-  let keys = Object.keys(parsed.tags);
-
-  let str = parsed.tags[keys[keys.length-1]];
-
-  if (str[str.length-2] === '\n' && str[str.length-1] === '\/') {
-    str = str.slice(0, str.length-2);
-  }
-
-  parsed.tags[keys[keys.length-1]] = str;
-
-  return parsed;
-}
-
-function reduceParamString(param) {
-  param = param.toSingleLine();
-  const docBlockItems = (/({.+}) ([^\ ])+ /g).exec(param);
-
-  const toRemove = docBlockItems[0];
-  let name = docBlockItems[0].split(' ');
-  name = name[name.length-2];
-  let type = docBlockItems[1];
-  type = '(' + type.slice(1, type.length-1) + ')';
-
-  param = `- \`${name}\` ${type} ${param.split(toRemove)[1]}`;
-
-  // HTML escape < and >
-  param = param.replace(/\</g, '&lt;').replace(/\>/g, '&gt;');
-
-  return param;
-}
-
-function markdownify(block, functionName) {
-  let result = '';
-  const tags = block.tags;
-
-  // don't render doc blocks marked hidden
-  if (tags.hidden !== undefined) {
-    return result;
-  }
-
-  // for the header of a file
-  if (tags.file && tags.desc) {
-    const file = `${tags.file} Methods`;
-    const id = `${tags.file.toLowerCase()}-methods`;
-    result += `<section id="${id}" name="${file}">\n\n`
-    result += `## ${file}\n\n`;
-    result += `${tags.desc.toSingleLine()}\n\n`;
-    result += `</section>\n\n`;
-
-    return result;
-  }
-
-  let id = functionName.toKebabCase();
-  let title = functionName.toTitleCase();
-
-  // handle special cases
-  if (functionName === 'vToken') {
-    id = 'vToken';
-    title = 'vToken';
-  }
-
-  if (functionName === 'function') {
-    id = 'constructor';
-    title = 'Sumer Constructor';
-  }
-
-  if (title === 'Get Abi') {
-    title = 'Get ABI';
-  }
-
-  if (title === 'Get Net Name With Chain Id') {
-    title = 'Get Network Name With Chain ID';
-  }
-
-  // create section header
-  result += `<section id="${id}" name="${title}">\n\n`;
-  result += `## ${title}\n\n`;
-
-  // description
-  const description = block.text.toSingleLine();
-  result += description + '\n\n';
-
-  // parameters
-  if (tags.param) {
-    tags.param = Array.isArray(tags.param) ? tags.param : [ tags.param ];
-
-    tags.param.forEach((param) => {
-      result += reduceParamString(param) + '\n';
-    });
-  }
-
-  // return
-  if (tags.returns) {
-    let _return = tags.returns.toSingleLine().replace('{', '(').replace('}', ')');
-    _return = _return.replace(/\</g, '&lt;').replace(/\>/g, '&gt;');
-    result += '- `RETURN` ' + _return + '\n\n';
-  }
-
-  // example
-  if (tags.example) {
-    const example = tags.example
-      .replace('```', "```js")
-      .replace(/&/g, '&amp;');
-    result += example + '\n\n';
-  }
-
-  result += '</section>\n\n';
-
-  return result;
-}
-
-function getDocBlocks(fileContents) {
-  const docBlocks = [];
-  const startVal = '/**';
-  const endVal = ' */';
-
-  const lines = fileContents.toString().split('\n');
-
-  let startIndex;
-  for (let i = 0; i < lines.length; i++) {
-    const line = lines[i];
-
-    if (line === startVal) {
-      startIndex = i;
-    }
-
-    if (line === endVal) {
-      const functionNameLine = lines[i+1];
-      const rgx = /\ ([^\s]+)\(/g;
-
-      const functionNameResult = rgx.exec(functionNameLine);
-
-      let functionName;
-      if (functionNameResult !== null) {
-        functionName = functionNameResult[1];
-      }
-
-      let contents = '';
-      for (let j = startIndex; j <= i; j++) {
-        const _line = lines[j];
-        contents += _line + '\n';
-      }
-
-      docBlocks.push({
-        functionName,
-        contents
-      });
-    }
-
-  }
-
-  return docBlocks;
-}
-
-function getAllFilePaths(srcPath, resultPaths) {
-  dirOrFileNames = fs.readdirSync(srcPath);
-
-  resultPaths = resultPaths || [];
-
-  dirOrFileNames.forEach((name) => {
-    if (fs.statSync(srcPath + name).isDirectory()) {
-      resultPaths = getAllFilePaths(srcPath + name + '/', resultPaths);
-    } else {
-      resultPaths.push(srcPath + name);
-    }
-  });
-
-  return resultPaths;
-}
-
-let intro = '';
-intro += '<section id="introduction" name="Introduction">\n\n';
-intro += '# Sumer.js\n\n';
-intro += '## Introduction\n\n';
-intro += '[Sumer.js](https://github.com/meterio/sumer-js) is a ';
-intro += 'JavaScript SDK for Ethereum and the Sumer Protocol. It wraps ';
-intro += 'around Ethers.js, which is its only dependency. It is designed for ';
-intro += 'both the web browser and Node.js.\n\n';
-intro += 'The SDK is currently in open beta. For bugs reports and feature ';
-intro += 'requests, either create an issue in the GitHub repository or send a';
-intro += ' message in the Development channel of the Sumer Discord.\n\n';
-intro += '</section>\n\n';
-
-const srcDir = './src/';
-const outFilePath = './scripts/out.md';
-
-const srcFilePaths = getAllFilePaths(srcDir);
-
-// Move `index.ts` to the front
-const indexTs = './src/index.ts';
-const idx = srcFilePaths.findIndex((el) => el === indexTs);
-srcFilePaths.splice(idx, 1);
-srcFilePaths.unshift(indexTs);
-
-let mdResult = '';
-mdResult += intro;
-
-srcFilePaths.forEach((f) => {
-  const fileContents = fs.readFileSync(f);
-  const blocks = getDocBlocks(fileContents);
-
-  if (blocks.length > 0) {
-    blocks.forEach((b) => {
-      const parsed = unSlashBug(docblockParser.parse(b.contents));
-      mdResult += markdownify(parsed, b.functionName);
-    });
-  }
-});
-
-fs.writeFileSync(outFilePath, mdResult);

package/src/EIP712.ts

@@ -1,153 +0,0 @@
-// Based on
-// https://github.com/ethereum/EIPs/blob/master/assets/eip-712/Example.js
-
-import { ethers } from 'ethers';
-import {
-  SimpleEthersSigner,
-  EIP712Domain,
-  EIP712Message,
-  EIP712Types,
-  Signature,
-} from './types';
-
-function abiRawEncode(encTypes, encValues) {
-  const hexStr = ethers.utils.defaultAbiCoder.encode(encTypes, encValues);
-  return Buffer.from(hexStr.slice(2, hexStr.length), 'hex');
-}
-
-function keccak256(arg) {
-  const hexStr = ethers.utils.keccak256(arg);
-  return Buffer.from(hexStr.slice(2, hexStr.length), 'hex');
-}
-
-// Recursively finds all the dependencies of a type
-function dependencies(primaryType, found = [], types = {}) {
-  if (found.includes(primaryType)) {
-    return found;
-  }
-  if (types[primaryType] === undefined) {
-    return found;
-  }
-  found.push(primaryType);
-  for (const field of types[primaryType]) {
-    for (const dep of dependencies(field.type, found)) {
-      if (!found.includes(dep)) {
-        found.push(dep);
-      }
-    }
-  }
-  return found;
-}
-
-function encodeType(primaryType, types = {}) {
-  // Get dependencies primary first, then alphabetical
-  let deps = dependencies(primaryType);
-  deps = deps.filter(t => t != primaryType);
-  deps = [primaryType].concat(deps.sort());
-
-  // Format as a string with fields
-  let result = '';
-  for (const type of deps) {
-    if (!types[type])
-      throw new Error(`Type '${type}' not defined in types (${JSON.stringify(types)})`);
-    result += `${type}(${types[type].map(({ name, type }) => `${type} ${name}`).join(',')})`;
-  }
-  return result;
-}
-
-function typeHash(primaryType, types = {}) {
-  return keccak256(Buffer.from(encodeType(primaryType, types)));
-}
-
-function encodeData(primaryType, data, types = {}) {
-  const encTypes = [];
-  const encValues = [];
-
-  // Add typehash
-  encTypes.push('bytes32');
-  encValues.push(typeHash(primaryType, types));
-
-  // Add field contents
-  for (const field of types[primaryType]) {
-    let value = data[field.name];
-    if (field.type == 'string' || field.type == 'bytes') {
-      encTypes.push('bytes32');
-      value = keccak256(Buffer.from(value));
-      encValues.push(value);
-    } else if (types[field.type] !== undefined) {
-      encTypes.push('bytes32');
-      value = keccak256(encodeData(field.type, value, types));
-      encValues.push(value);
-    } else if (field.type.lastIndexOf(']') === field.type.length - 1) {
-      throw 'TODO: Arrays currently unimplemented in encodeData';
-    } else {
-      encTypes.push(field.type);
-      encValues.push(value);
-    }
-  }
-
-  return abiRawEncode(encTypes, encValues);
-}
-
-function domainSeparator(domain) {
-  const types = {
-    EIP712Domain: [
-      {name: 'name', type: 'string'},
-      {name: 'version', type: 'string'},
-      {name: 'chainId', type: 'uint256'},
-      {name: 'verifyingContract', type: 'address'},
-      {name: 'salt', type: 'bytes32'}
-    ].filter(a => domain[a.name])
-  };
-  return keccak256(encodeData('EIP712Domain', domain, types));
-}
-
-function structHash(primaryType, data, types = {}) {
-  return keccak256(encodeData(primaryType, data, types));
-}
-
-function digestToSign(domain, primaryType, message, types = {}) {
-  return keccak256(
-    Buffer.concat([
-      Buffer.from('1901', 'hex'),
-      domainSeparator(domain),
-      structHash(primaryType, message, types),
-    ])
-  );
-}
-
-export async function sign(
-  domain: EIP712Domain,
-  primaryType: string,
-  message: EIP712Message,
-  types: EIP712Types,
-  signer: SimpleEthersSigner
-) : Promise<Signature> {
-  let signature;
-
-  try {
-    if (signer._signingKey) {
-      const digest = digestToSign(domain, primaryType, message, types);
-      signature = signer._signingKey().signDigest(digest);
-      signature.v = '0x' + (signature.v).toString(16);
-    } else {
-      const address = await signer.getAddress();
-      const msgParams = JSON.stringify({ domain, primaryType, message, types });
-
-      signature = await signer.provider.jsonRpcFetchFunc(
-        'eth_signTypedData_v4',
-        [ address, msgParams ]
-      );
-
-      const r = '0x' + signature.substring(2).substring(0, 64);
-      const s = '0x' + signature.substring(2).substring(64, 128);
-      const v = '0x' + signature.substring(2).substring(128, 130);
-
-      signature = { r, s, v };
-    }
-  } catch(e) {
-    throw new Error(e);
-  }
-
-  return signature;
-}

package/src/api.ts

@@ -1,212 +0,0 @@
-/**
- * @file API
- * @desc These methods facilitate HTTP requests to the Sumer API.
- */
-
-import { request } from './util';
-import {
-  APIRequest,
-  APIResponse,
-  AccountServiceRequest,
-  CTokenServiceRequest,
-  MarketHistoryServiceRequest,
-  GovernanceServiceRequest,
-} from './types';
-
-// import { version } from '../package.json';
-
-// let userPlatform;
-
-// try {
-//   if (typeof document !== 'undefined') {
-//     userPlatform = 'web';
-//   } else if (
-//     typeof navigator !== 'undefined' &&
-//     navigator.product === 'ReactNative'
-//   ) {
-//     userPlatform = 'react-native';
-//   } else if (
-//     typeof navigator !== 'undefined' && 
-//     navigator.userAgent.toLowerCase().indexOf('electron') > -1
-//   ) {
-//     userPlatform = 'electron-js';
-//   } else {
-//     userPlatform = 'node-js';
-//   }
-// } catch (e) {
-//   userPlatform = 'unknown';
-// }
-
-/**
- * Makes a request to the AccountService API. The Account API retrieves
- *     information for various accounts which have interacted with the protocol.
- *     For more details, see the Sumer API documentation.
- *
- * @param {object} options A JavaScript object of API request parameters.
- *
- * @returns {object} Returns the HTTP response body or error.
- *
- * @example
- *
- * ```
- * (async function() {
- *   const account = await Sumer.api.account({
- *     "addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307",
- *     "network": "testnet"
- *   });
- * 
- *   let sxpBorrowBalance = 0;
- *   if (Object.isExtensible(account) && account.accounts) {
- *     account.accounts.forEach((acc) => {
- *       acc.tokens.forEach((tok) => {
- *         if (tok.symbol === Sumer.vSXP) {
- *           sxpBorrowBalance = +tok.borrow_balance_underlying.value;
- *         }
- *       });
- *     });
- *   }
- * 
- *   console.log('sxpBorrowBalance', sxpBorrowBalance);
- * })().catch(console.error);
- * ```
- */
-// TODO -- this will be updated when api is ready
-export function account(options: AccountServiceRequest): Promise<APIResponse> {
-  return queryApi(options, 'account', '/api/v2/account');
-}
-
-/**
- * Makes a request to the CTokenService API. The vToken API retrieves
- *     information about vToken contract interaction. For more details, see the 
- *     Sumer API documentation.
- *
- * @param {object} options A JavaScript object of API request parameters.
- *
- * @returns {object} Returns the HTTP response body or error.
- *
- * @example
- *
- * ```
- * (async function() {
- *   const vSxpData = await Sumer.api.vToken({
- *     "addresses": Sumer.util.getAddress(Sumer.vSXP)
- *   });
- * 
- *   console.log('vSxpData', vSxpData); // JavaScript Object
- * })().catch(console.error);
- * ```
- */
-export function vToken(options: CTokenServiceRequest): Promise<APIResponse> {
-  return queryApi(options, 'vToken', '/api/vtoken');
-}
-
-/**
- * Makes a request to the MarketHistoryService API. The market history service
- *     retrieves information about a market. For more details, see the Sumer
- *     API documentation.
- *
- * @param {object} options A JavaScript object of API request parameters.
- *
- * @returns {object} Returns the HTTP response body or error.
- *
- * @example
- *
- * ```
- * (async function() {
- *   const vUsdcMarketData = await Sumer.api.marketHistory({
- *     "asset": Sumer.util.getAddress(Sumer.vUSDC),
- *     "min_block_timestamp": 1559339900,
- *     "max_block_timestamp": 1598320674,
- *     "num_buckets": 10,
- *   });
- * 
- *   console.log('vUsdcMarketData', vUsdcMarketData); // JavaScript Object
- * })().catch(console.error);
- * ```
- */
-export function marketHistory(options: MarketHistoryServiceRequest): Promise<APIResponse> {
-  // return queryApi(options, 'Market History', '/api/v2/market_history/graph');
-  return queryApi(options, 'Market History', '/api/market_history/graph');
-}
-
-/**
- * Makes a request to the GovernanceService API. The Governance Service includes
- *     three endpoints to retrieve information about COMP accounts. For more 
- *     details, see the Sumer API documentation.
- *
- * @param {object} options A JavaScript object of API request parameters.
- * @param {string} endpoint A string of the name of the corresponding governance
- *     service endpoint. Valid values are `proposals`, `voteReceipts`, or
- *     `accounts`.
- *
- * @returns {object} Returns the HTTP response body or error.
- *
- * @example
- *
- * ```
- * (async function() {
- *   const proposal = await Sumer.api.governance(
- *     { "proposal_ids": [ 20 ] }, 'proposals'
- *   );
- * 
- *   console.log('proposal', proposal); // JavaScript Object
- * })().catch(console.error);
- * ```
- */
-export function governance(options: GovernanceServiceRequest, endpoint: string): Promise<APIResponse> {
-  if (endpoint === 'proposals') {
-    // endpoint = '/api/v2/governance/proposals';
-    endpoint = '/api/governance/proposals';
-  } else if (endpoint === 'voteReceipts') {
-    // endpoint = '/api/v2/governance/proposal_vote_receipts';
-    endpoint = '/api/governance/proposal_vote_receipts';
-  } else {
-    // endpoint = '/api/v2/governance/accounts';
-    endpoint = '/api/governance/accounts';
-  }
-
-  return queryApi(options, 'GovernanceService', endpoint);
-}
-
-function queryApi(options: APIRequest, name: string, path: string): Promise<APIResponse> {
-  return new Promise((resolve, reject) => {
-    const errorPrefix = `Sumer [api] [${name}] | `;
-    let responseCode, responseMessage;
-
-    // TODO -- api service endpoint should be updated.
-    let hostname = 'https://mainnetapi.sumer.io';
-    if (options && (options.network === 'testnet')) hostname = 'https://testnetapi.sumer.io';
-
-    request({
-      hostname,
-      path,
-      method: 'POST',
-      headers: {
-        'Content-type': 'application/json',
-        // 'sumer-js': `[${version}]_[${userPlatform}]`,
-      },
-      body: options
-    }).then((response) => {
-      responseCode = response.status;
-      responseMessage = response.statusText;
-
-      const responseBody = JSON.parse(response.body);
-
-      if (responseCode >= 200 && responseCode <= 299) {
-        resolve(responseBody);
-      } else {
-        throw 'Invalid request made to the Sumer API.';
-      }
-    }).catch((error) => {
-      let errorMessage = '';
-
-      if (error.name === 'SyntaxError') {
-        errorMessage = errorPrefix + `Unable to parse response body.`;
-      } else {
-        errorMessage = errorPrefix + error.toString();
-      }
-
-      reject({ error: errorMessage, responseCode, responseMessage });
-    });
-  });
-}