npm - @meterio/sumer-js - Versions diffs - 0.0.12 → 0.1.0 - Mend

@meterio/sumer-js 0.0.12 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1062) hide show

package/examples/web/ropstenNative.html DELETED Viewed

@@ -1,581 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <!-- USE CDN, PUBLIC BUILD -->
-  <!-- <script type="text/javascript" src="sumer.min.js"></script> -->
-  <!-- USE LOCAL BUILD (be sure `npm install`) -->
-  <script type="text/javascript" src="./sumer.min.js"></script>
-  <link rel="stylesheet"
-      href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/default.min.css">
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
-  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.2/languages/javascript.min.js"></script>
-  <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.2/styles/night-owl.min.css">
-  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/picnic" />
-  <style type="text/css">
-    p { margin: 0px }
-    pre { padding: 0px }
-    .red { color: #e60000; }
-    .container {
-      margin: 0px 25px;
-      width: 800px;
-    }
-    .spinner { /* credit https://codepen.io/mandelid/pen/vwKoe */
-      display: inline-block;
-      width: 20px;
-      height: 20px;
-      border: 3px solid rgba(0,0,0,.3);
-      border-radius: 50%;
-      border-top-color: #000;
-      animation: spin 1s ease-in-out infinite;
-      -webkit-animation: spin 1s ease-in-out infinite;
-    }
-    @keyframes spin { to { -webkit-transform: rotate(360deg); } }
-    @-webkit-keyframes spin { to { -webkit-transform: rotate(360deg); } }
-  </style>
-  <title>Sumer.js Examples</title>
-</head>
-<body>
-  <div class="container">
-    <h1>Sumer.js Examples on Ropsten [Alpha]</h1>
-    <p>
-      Code examples for client interaction with the <a href="https://docs.sumer.io/sumer-js/">Sumer</a> protocol via Sumer.js.
-    </p>
-    &nbsp;
-    <p>
-        Run <a href="https://www.trufflesuite.com/ganache">Ganache</a> with a <b>fork of main net</b> on your local machine and set MetaMask to <b>Localhost 8545</b> to test writing transactions.
-    </p>
-    &nbsp;
-    <p class="red">
-      <b>
-        DO NOT use this web page with Ethereum main net or with your funded Ethereum keys / wallet!
-      </b>
-    </p>
-    &nbsp;
-    <div class="item">
-      <h2>Ethereum Read (JSON RPC eth_call)</h2>
-      <p>Generic Ethereum blockchain read with JSON RPC. This example fetches the supply rate per block for sdrHT using the <b>read</b> method.</p>
-      <button id="eth-call-button">Get Supply Rate Per Block</button>
-      <br />
-      <div id="eth-call-content"></div>
-      <pre><code class="js">// mainnet
-const sdrUSDTAddress = '0x70725e4DFb6fCb1fDF0717dB09D98C95da960Bf8';
-(async function() {
-  const srpb = await Sumer.eth.read(
-    sdrHTAddress,
-    'function supplyRatePerBlock() returns (uint256)',
-    // [], // [optional] parameters
-    // {}  // [optional] call options, provider, network, plus Ethers.js "overrides"
-  );
-  console.log('sdrUSDT market supply rate per block:', srpb.toString());
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Ethereum Send Transaction (JSON RPC eth_sendTransaction)</h2>
-      <p>Create and send an Ethereum transaction with JSON RPC. This button's transaction transfers your Ether to the Sumer protocol using the <b>trx</b> method.</p>
-      <button id="eth-sendTransaction-button">Supply 1 USDT</button>
-      <br />
-      <div id="eth-sendTransaction-content"></div>
-      <pre><code class="js">const oneInWei = '1000000';
-const sdrHTAddress = '0x70725e4DFb6fCb1fDF0717dB09D98C95da960Bf8';
-const provider = window.ethereum;
-(async function() {
-  console.log('Supplying HT to the Sumer Protocol...');
-  // Mint some sdrUSDT by supplying USDT to the Sumer Protocol
-  const trx = await Sumer.eth.trx(
-    sdrHTAddress,
-    'function mint() payable',
-    [],
-    {
-      provider,
-      value: oneInWei
-    }
-  );
-  // const result = await trx.wait(1); // JSON object of trx info, once mined
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Supply</h2>
-      <p>This button's transaction transfers your Ether to the Sumer protocol using the <b>supply</b> method.</p>
-      <button id="supply-button">Supply 1 MTRG</button>
-      <br />
-      <div id="supply-content"></div>
-      <pre><code class="js">const sumer = new Sumer(window.ethereum);
-// Ethers.js overrides are an optional 3rd parameter for `supply`
-// const trxOptions = { gasLimit: 250000, mantissa: false };
-(async function() {
-  console.log('Supplying MTRG to the Sumer protocol...');
-  const trx = await sumer.supply(Sumer.MTRG, 1);
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Redeem</h2>
-      <p>This button's transaction redeems your Ether from the Sumer protocol using the <b>redeem</b> method.</p>
-      <button id="redeem-button">Redeem 1 MTRG</button>
-      <br />
-      <div id="redeem-content"></div>
-      <pre><code class="js">const sumer = new Sumer(window.ethereum);
-(async function() {
-  console.log('Redeeming MTRG...');
-  const trx = await sumer.redeem(Sumer.MTRG, 1); // also accepts cToken args
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);
-</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Enter Markets</h2>
-      <p>This button's transaction enables supplied assets to be used as collateral using the <b>enterMarkets</b> method. Note that there is a corresponding <b>exitMarket</b> method for exiting a single market.</p>
-      <button id="enter-market-button">Enter MTRG Market</button>
-      <br />
-      <div id="enter-market-content"></div>
-      <pre><code class="js">const sumer = new Sumer(window.ethereum);
-(async function() {
-  console.log('Entering MTRG market (use as collateral)...');
-  const trx = await sumer.enterMarkets(Sumer.MTRG); // also accepts []
-  console.log('Ethers.js transaction object', trx);
-  // Exit a market (string argument of only 1 market at a time)
-  // const trx = await sumer.exitMarket(Sumer.MTRG);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Borrow</h2>
-      <p>This button's transaction borrows 0.01 MTRG, against collateral, using the <b>borrow</b> method. Remember to supply a supported asset as collateral and enter that market prior to borrowing.</p>
-      <button id="borrow-button">Borrow 0.01 MTRG</button>
-      <br />
-      <div id="borrow-content"></div>
-      <pre><code class="js">const sumer = new Sumer(window.ethereum);
-(async function() {
-  const daiScaledUp = '1'+'0'.repeat(16);
-  const trxOptions = { mantissa: true };
-  console.log('Borrowing 0.01 MTRG...');
-  const trx = await sumer.borrow(Sumer.MTRG, daiScaledUp, trxOptions);
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Repay Borrow</h2>
-      <p>This button's transaction repays 0.01 borrowed MTRG using the <b>repayBorrow</b> method. This won't work unless you have an open borrow.</p>
-      <button id="repay-borrow-button">Repay 0.01 MTRG</button>
-      <br />
-      <div id="repay-borrow-content"></div>
-      <pre><code class="js">const sumer = new Sumer(window.ethereum);
-(async function() {
-  console.log('Repaying Dai borrow...');
-  const address = null; // set this to any address to repayBorrowBehalf
-  const trx = await sumer.repayBorrow(Sumer.MTRG, 0.01, address);
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Get Price</h2>
-      <p>Fetches the MTRG price in USDT using the <b>getPrice</b> method.</p>
-      <button id="get-price-button">Get MTRG Price</button>
-      <br />
-      <div id="get-price-content"></div>
-      <pre><code class="js">(async function() {
-  // Accepts 2 args, cTokens or underlyings. Second arg defaults to USDC.
-  const price = await sumer.getPrice(Sumer.MTRG, Sumer.USDT);
-  console.log('MTRG in USDT', price);
-})().catch(console.error);</code></pre>
-    </div>
-    &nbsp;
-    <div class="item">
-      <h2>Get Address</h2>
-      <p>Fetches a relevant contract address using <b>getAddress</b> method.</p>
-      <button id="get-address-button">Get sdrMTRG Address</button>
-      <br />
-      <div id="get-address-content"></div>
-      <pre><code class="js">// Accepts vTokens or underlyings. Second arg defaults to main net.
-const vSXPAddressRopsten = Sumer.util.getAddress(Sumer.sdrMTRG, 'ropsten');</code></pre>
-    </div>
-    &nbsp;
-  </div>
-</body>
-<script type="text/javascript">
-const ethCallButton = document.getElementById('eth-call-button');
-const ethCallContent = document.getElementById('eth-call-content');
-const ethSendTransactionButton = document.getElementById('eth-sendTransaction-button');
-const ethSendTransactionContent = document.getElementById('eth-sendTransaction-content');
-const supplyButton = document.getElementById('supply-button');
-const supplyContent = document.getElementById('supply-content');
-const redeemButton = document.getElementById('redeem-button');
-const redeemContent = document.getElementById('redeem-content');
-const enterMarketButton = document.getElementById('enter-market-button');
-const enterMarketContent = document.getElementById('enter-market-content');
-const borrowButton = document.getElementById('borrow-button');
-const borrowContent = document.getElementById('borrow-content');
-const repayBorrowButton = document.getElementById('repay-borrow-button');
-const repayBorrowContent = document.getElementById('repay-borrow-content');
-const getPriceButton = document.getElementById('get-price-button');
-const getPriceContent = document.getElementById('get-price-content');
-const getAddressButton = document.getElementById('get-address-button');
-const getAddressContent = document.getElementById('get-address-content');
-const spin = (element) => {
-  element.innerText = '';
-  element.classList.add('spinner');
-};
-const unspin = (element) => element.classList.remove('spinner');
-const ethCallExample = () => {
-  spin(ethCallContent);
-  // mainnet
-  const sdrUSDTAddress = '0x70725e4DFb6fCb1fDF0717dB09D98C95da960Bf8';
-  (async function() {
-    const srpb = await Sumer.eth.read(
-      sdrUSDTAddress,
-      'function supplyRatePerBlock() returns (uint256)',
-      [], // [], // [optional] parameters
-      {provider: window.ethereum} // {} [optional] call options, provider, network, plus Ethers.js "overrides"
-    );
-    ethCallContent.innerText = srpb.toString();
-    console.log('sdrUSDT market supply rate per block:', srpb.toString());
-  })().catch((err) => {
-    ethCallContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(ethCallContent) });
-};
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const ethSendTransactionExample = () => {
-  spin(ethSendTransactionContent);
-  const oneInWei = '1000000';
-  const sdrUSDTAddress = '0x70725e4DFb6fCb1fDF0717dB09D98C95da960Bf8';
-  const provider = window.ethereum;
-  (async function() {
-    console.log('Supplying HT to the Sumer Protocol...');
-    const sumer = new Sumer(window.ethereum);
-    const tokenAddr = Sumer.util.getAddress(Sumer.sdrUSDT, 'ropsten')
-    console.log('token addr: ', tokenAddr);
-    // Mint some sdrHT by supplying HT to the Sumer Protocol
-    const trx = await Sumer.eth.trx(
-      tokenAddr,
-      'function mint() payable',
-      [],
-      {
-        provider,
-        value: oneInWei
-      }
-    );
-    // const result = await trx.wait(1); // JSON object of trx info, once mined
-    ethSendTransactionContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-    console.log('Ethers.js transaction object', trx);
-  })().catch((err) => {
-    ethSendTransactionContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(ethSendTransactionContent) });
-}
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const supplyExample = () => {
-  spin(supplyContent);
-  console.log("CLICKED!!!")
-  const sumer = new Sumer(window.ethereum);
-  const token = Sumer.ETH;
-  // Ethers.js overrides are an optional 3rd parameter for `supply`
-  const trxOptions = { gasLimit: 250000, mantissa: false };
-  (async function() {
-    console.log("OOOOOO")
-    console.log(`Supplying ${token} to the Sumer protocol...`);
-    const trx = await sumer.supply(token, 0.001, false, trxOptions);
-    supplyContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-    console.log('Ethers.js transaction object', trx);
-  })().catch((err) => {
-    supplyContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(supplyContent) });
-};
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const redeemExample = () => {
-  spin(redeemContent);
-  const sumer = new Sumer(window.ethereum);
-  const token = Sumer.MTRG;
-  (async function() {
-    console.log('Redeeming ${token}...');
-    const trx = await sumer.redeem(token, 1); // also accepts cToken args
-    console.log('Ethers.js transaction object', trx);
-    redeemContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-  })().catch((err) => {
-    redeemContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(redeemContent) });
-};
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const enterMarketExample = () => {
-  spin(enterMarketContent);
-  const sumer = new Sumer(window.ethereum);
-  (async function() {
-    console.log('Entering MTRG market (use as collateral)...');
-    const trx = await sumer.enterMarkets(Sumer.MTRG); // also accepts []
-    console.log('Ethers.js transaction object', trx);
-    // Exit a market (string parameter of only 1 market at a time)
-    // const trx = await sumer.exitMarket(Sumer.HT);
-    enterMarketContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-  })().catch((err) => {
-    enterMarketContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(enterMarketContent) });
-};
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const borrowExample = () => {
-  spin(borrowContent);
-  const sumer = new Sumer(window.ethereum);
-  (async function() {
-    const daiScaledUp = '1'+'0'.repeat(16);
-    const trxOptions = { mantissa: true };
-    console.log('Borrowing 0.01 MTRG...');
-    const trx = await sumer.borrow(Sumer.MTRG, daiScaledUp, trxOptions);
-    borrowContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-    console.log('Ethers.js transaction object', trx);
-  })().catch((err) => {
-    borrowContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(borrowContent) });
-};
-/**
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const repayBorrowExample = () => {
-  spin(repayBorrowContent);
-  const sumer = new Sumer(window.ethereum);
-  const token = Sumer.MTRG;
-  (async function() {
-    console.log(`Repaying ${token} borrow...`);
-    const address = null; // set this to any address to repayBorrowBehalf
-    const trx = await sumer.repayBorrow(Sumer.MTRG, 1, address);
-    repayBorrowContent.innerText = 'Success, see the developer console for the Ethers.js transaction object.';
-    console.log('Ethers.js transaction object', trx);
-  })().catch((err) => {
-    repayBorrowContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(repayBorrowContent) });
-};
-// get a price using the open price feed
-const getPriceExample = () => {
-  spin(getPriceContent);
-  const sumer = new Sumer();
-  (async function() {
-    // Accepts 2 args, cTokens or underlyings. Second arg defaults to USDC.
-    const price = await sumer.getPrice(Sumer.MTRG, Sumer.sdrUSDT);
-    console.log('MTRG in USDT', price);
-    getPriceContent.innerText = price.toString();
-  })().catch((err) => {
-    getPriceContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(getPriceContent) });
-};
-// get a relevant address of a supported protocol contract
-const getAddressExample = () => {
-  spin(getAddressContent);
-  const sumer = new Sumer();
-  (async function() {
-    // Accepts vTokens or underlyings. Second arg defaults to main net.
-    const addr = Sumer.util.getAddress(Sumer.sdrMTRG, 'ropsten');
-    getAddressContent.innerText = addr.toString();
-  })().catch((err) => {
-    getAddressContent.innerText = 'Error occured; See developer console for details.';
-    console.error(err);
-  }).finally(() => { unspin(getAddressContent) });
-};
-window.addEventListener('load', (event) => {
-  // syntax highlight code snippets
-  document.querySelectorAll('pre code').forEach((block) => {
-    hljs.highlightBlock(block);
-  });
-  window.ethereum.enable().then(() => {
-    ethCallButton.onclick = ethCallExample;
-    ethSendTransactionButton.onclick = ethSendTransactionExample;
-    supplyButton.onclick = supplyExample;
-    redeemButton.onclick = redeemExample;
-    enterMarketButton.onclick = enterMarketExample;
-    borrowButton.onclick = borrowExample;
-    repayBorrowButton.onclick = repayBorrowExample;
-    getPriceButton.onclick = getPriceExample;
-    getAddressButton.onclick = getAddressExample;
-  });
-});
-</script>
-</html>

package/rollup.config.ts DELETED Viewed

@@ -1,41 +0,0 @@
-// Rollup builds only the browser version using the Node.js build.
-import { nodeResolve as resolve } from '@rollup/plugin-node-resolve';
-import commonjs from 'rollup-plugin-commonjs';
-import minify from 'rollup-plugin-babel-minify';
-import json from '@rollup/plugin-json';
-const BrowserBuildPath = './dist/browser/sumer.min.js';
-export default [{
-  input: './dist/nodejs/index.js',
-  onwarn: (message) => {
-    if (message.code === 'MISSING_NODE_BUILTINS') return;
-  },
-  output: {
-    name: 'Sumer',
-    file: BrowserBuildPath,
-    format: 'iife',
-    sourcemap: false,
-    globals: {
-      'http': '{}',
-      'https': '{}',
-    },
-  },
-  plugins: [
-    resolve({
-      preferBuiltins: true,
-      jsnext: true,
-      main: true,
-      browser: true,
-    }),
-    commonjs({
-      namedExports: { Sumer: ['Sumer'] },
-    }),
-    minify({ comments: false, mangle: false }),
-    json(),
-  ],
-  external: [
-    'http',
-    'https',
-  ]
-}];

package/scripts/README.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Scripts
-These are scripts for build functionality.
-## Sumer Docs
-To build the Sumer docs, `npm run sumer_docs` or `node ./scripts/sumer-docs.js`. Move the contents of `/scripts/out.md` into the internal project `/src/elm/LandingSite/Docs/SumerJsDoc.elm`.