first beta release

DePayFi · Jun 28, 2021 · 507324e · 507324e
1 parent 028f890
commit 507324e
Show file tree

Hide file tree

Showing 10 changed files with 738 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -11,12 +11,55 @@ npm install --save depay-blockchain-token
 ```
 
 ```javascript
+import { Token } from 'depay-blockchain-token';
 
+let token = new Token({
+  blockchain: 'ethereum',
+  address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
+});
+
+expect(token.address).toEqual('0xa0bEd124a09ac2Bd941b10349d8d224fe3c955eb')
+expect(await token.decimals()).toEqual(18)
+expect(await token.symbol()).toEqual('DEPAY')
+expect(await token.name()).toEqual('DePay')
 ```
 
 ## Functionalities
 
-### 
+### initalize
+
+```javascript
+import { Token } from 'depay-blockchain-token';
+
+let token = new Token({
+  blockchain: 'ethereum',
+  address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
+});
+```
+
+### decimals
+
+Retrieves token decimals
+
+```javascript
+await token.decimals() // 18
+```
+
+### symbol
+
+Retrieves token symbol
+
+```javascript
+await token.symbol() // DEPAY
+```
+
+### name
+
+Retrieves token name
+
+```javascript
+await token.name() // DePay
+```
 
 ## Development
 

diff --git a/dist/cjs/index.js b/dist/cjs/index.js
@@ -0,0 +1,162 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var ethers = require('ethers');
+var depayBlockchainCall = require('depay-blockchain-call');
+
+let ERC20 = [
+  {
+    constant: true,
+    inputs: [],
+    name: 'name',
+    outputs: [{ name: '', type: 'string' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_spender', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'approve',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'totalSupply',
+    outputs: [{ name: '', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_from', type: 'address' },
+      { name: '_to', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'transferFrom',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'decimals',
+    outputs: [{ name: '', type: 'uint8' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [{ name: '_owner', type: 'address' }],
+    name: 'balanceOf',
+    outputs: [{ name: 'balance', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'symbol',
+    outputs: [{ name: '', type: 'string' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_to', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'transfer',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [
+      { name: '_owner', type: 'address' },
+      { name: '_spender', type: 'address' },
+    ],
+    name: 'allowance',
+    outputs: [{ name: '', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  { payable: true, stateMutability: 'payable', type: 'fallback' },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, name: 'owner', type: 'address' },
+      { indexed: true, name: 'spender', type: 'address' },
+      { indexed: false, name: 'value', type: 'uint256' },
+    ],
+    name: 'Approval',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, name: 'from', type: 'address' },
+      { indexed: true, name: 'to', type: 'address' },
+      { indexed: false, name: 'value', type: 'uint256' },
+    ],
+    name: 'Transfer',
+    type: 'event',
+  },
+];
+
+class Token {
+  constructor({ blockchain, address }) {
+    this.blockchain = blockchain;
+    this.address = ethers.ethers.utils.getAddress(address);
+  }
+
+  callBasics() {
+    return {
+      blockchain: 'ethereum',
+      address: this.address,
+      api: ERC20,
+    }
+  }
+
+  async decimals() {
+    return await depayBlockchainCall.call({
+      ...this.callBasics(),
+      method: 'decimals',
+    })
+  }
+
+  async symbol() {
+    return await depayBlockchainCall.call({
+      ...this.callBasics(),
+      method: 'symbol',
+    })
+  }
+
+  async name() {
+    return await depayBlockchainCall.call({
+      ...this.callBasics(),
+      method: 'name',
+    })
+  }
+}
+
+exports.Token = Token;
diff --git a/dist/es/index.js b/dist/es/index.js
@@ -0,0 +1,158 @@
+import { ethers } from 'ethers';
+import { call } from 'depay-blockchain-call';
+
+let ERC20 = [
+  {
+    constant: true,
+    inputs: [],
+    name: 'name',
+    outputs: [{ name: '', type: 'string' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_spender', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'approve',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'totalSupply',
+    outputs: [{ name: '', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_from', type: 'address' },
+      { name: '_to', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'transferFrom',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'decimals',
+    outputs: [{ name: '', type: 'uint8' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [{ name: '_owner', type: 'address' }],
+    name: 'balanceOf',
+    outputs: [{ name: 'balance', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: 'symbol',
+    outputs: [{ name: '', type: 'string' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: '_to', type: 'address' },
+      { name: '_value', type: 'uint256' },
+    ],
+    name: 'transfer',
+    outputs: [{ name: '', type: 'bool' }],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    constant: true,
+    inputs: [
+      { name: '_owner', type: 'address' },
+      { name: '_spender', type: 'address' },
+    ],
+    name: 'allowance',
+    outputs: [{ name: '', type: 'uint256' }],
+    payable: false,
+    stateMutability: 'view',
+    type: 'function',
+  },
+  { payable: true, stateMutability: 'payable', type: 'fallback' },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, name: 'owner', type: 'address' },
+      { indexed: true, name: 'spender', type: 'address' },
+      { indexed: false, name: 'value', type: 'uint256' },
+    ],
+    name: 'Approval',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, name: 'from', type: 'address' },
+      { indexed: true, name: 'to', type: 'address' },
+      { indexed: false, name: 'value', type: 'uint256' },
+    ],
+    name: 'Transfer',
+    type: 'event',
+  },
+];
+
+class Token {
+  constructor({ blockchain, address }) {
+    this.blockchain = blockchain;
+    this.address = ethers.utils.getAddress(address);
+  }
+
+  callBasics() {
+    return {
+      blockchain: 'ethereum',
+      address: this.address,
+      api: ERC20,
+    }
+  }
+
+  async decimals() {
+    return await call({
+      ...this.callBasics(),
+      method: 'decimals',
+    })
+  }
+
+  async symbol() {
+    return await call({
+      ...this.callBasics(),
+      method: 'symbol',
+    })
+  }
+
+  async name() {
+    return await call({
+      ...this.callBasics(),
+      method: 'name',
+    })
+  }
+}
+
+export { Token };