Added account/balancemulti

sebs · sebs · commit 05a57026ac11 · 2019-08-14T09:26:28.000+02:00
diff --git a/src/Client.ts b/src/Client.ts
@@ -1,5 +1,6 @@
 import { account } from './actions/account'
 import { ClientAccountBalance } from './client/ClientAccountBalance'
+import { ClientAccountBalancemulti } from './client/ClientAccountBalancemulti'
 import { Address } from './entities/Address'
 import { ApiKey } from './entities/Apikey'
 
@@ -29,6 +30,10 @@ export class Client {
         const oAddress = new Address(address)
         return new ClientAccountBalance(this.apiKey, 'account', action, oAddress, tag)
       },
+      balancemulti(address: string[], tag: string) {
+        const oAddress = address.map((addresString) => new Address(addresString))
+        return new ClientAccountBalancemulti(this.apiKey, 'account', action, oAddress, tag)
+      },
     }
 
     return actions[action]
diff --git a/src/client/ClientAccountBalancemulti.ts b/src/client/ClientAccountBalancemulti.ts
@@ -0,0 +1,59 @@
+import * as request from 'request-promise-native'
+import { Address } from '../entities/Address'
+import { ApiKey } from '../entities/Apikey'
+import { IClientAccountBalanceMultiRequest } from '../interfaces/Account'
+import { requestBuilder } from '../requestBuilder'
+
+/**
+ * Client for the account balance
+ */
+export class ClientAccountBalancemulti implements IClientAccountBalanceMultiRequest {
+  /**
+   * Api key to send with the request
+   */
+  apiKey: ApiKey
+  /**
+   * Address to lookup the account balance
+   */
+  address: Address[]
+  /**
+   * module of the etherscan api to request
+   */
+  module: string
+  /**
+   * action of the etherscan api to request
+   */
+  action: string
+  /**
+   * tag to limit the results
+   */
+  tag: string
+
+  constructor(apiKey: ApiKey, module: string, action: string, address: Address[], tag: string) {
+    this.apiKey = apiKey
+    this.module = module
+    this.action = action
+    this.address = address
+    this.tag = tag
+  }
+  /**
+   * Returns the serice url
+   * @returns url
+   */
+  toUrl(): string {
+    return requestBuilder(this.module, this.action, {
+      address: this.address.toString(),
+      apiKey: this.apiKey.toString(),
+      tag: this.tag.toString(),
+    })
+  }
+  /**
+   * Dies the actual request to the server
+   */
+  async request(): Promise<any> {
+    const options = {
+      uri: this.toUrl(),
+    }
+    return request.get(options)
+  }
+}
diff --git a/src/interfaces/Account.ts b/src/interfaces/Account.ts
@@ -15,13 +15,21 @@ export interface IClientAccountBalanceRequest extends IClientRequest {
   tag: string
 }
 
-/*
-
+/**
+ * Interface to Account/Balancemulti
+ */
 export interface IClientAccountBalanceMultiRequest extends IClientRequest {
-  address: Address
+  /**
+   * Array of ethereum addresses
+   */
+  address: Address[]
+  /**
+   * Tag to limit results
+   */
   tag: string
 }
 
+/*
 export interface IClientAccountTxlistRequest extends IClientRequest {
   address: Address
   startblock: string
diff --git a/test/clients/ClientAccountBalancemultiTest.ts b/test/clients/ClientAccountBalancemultiTest.ts
@@ -0,0 +1,64 @@
+import test from 'ava'
+import { ClientAccountBalancemulti } from '../../src/client/ClientAccountBalancemulti'
+import { Address } from '../../src/entities/Address'
+import { ApiKey } from '../../src/entities/Apikey'
+import { decode } from 'querystring'
+const nock = require('nock')
+import { parse } from 'querystring'
+import { parse as parseUrl } from 'url'
+import { readFile } from 'fs'
+import { promisify } from 'util'
+const _readFile = promisify(readFile)
+
+const apiKey = 'TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W'
+const address = [ 
+	'0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a',
+	'0x63a9975ba31b0b9626b34300f7f627147df1f526',
+	'0x198ef1ec325a96cc354c7266a038be8b5c558f67'
+]
+const tag = 'latest'
+const expectedUrl = 'https://api.etherscan.io/api?action=balancemulti&module=account&address=0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a,0x63a9975ba31b0b9626b34300f7f627147df1f526,0x198ef1ec325a96cc354c7266a038be8b5c558f67&tag=latest&apikey=YourApiKeyToken'
+const fixtureLocation= './test/fixtures/account/balancemulti/address-latest.json'
+
+test('exists', t => {
+	t.truthy(ClientAccountBalancemulti)
+})
+
+test('can be instantiated', t => {
+	const arrAddress = address.map(a =>  new Address(a))
+	const oApiKey = new ApiKey(apiKey)
+	new ClientAccountBalancemulti(oApiKey, 'account', 'balancemulti', arrAddress, tag)
+	t.pass()
+})
+
+test('generates the right url', t => {
+	const arrAddress = address.map(a =>  new Address(a))
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountBalancemulti(oApiKey, 'account', 'balancemulti', arrAddress, tag)
+	const url = c.toUrl()
+
+	const parsedUrl = parse(url)
+	const parsedExpectedUrl = parse(expectedUrl)
+
+	t.is(parsedUrl.action, parsedExpectedUrl.action, 'actionnot as expected')
+	t.is(parsedUrl.module, parsedExpectedUrl.module)
+	t.is(parsedUrl.address, parsedExpectedUrl.address)
+	t.is(parsedUrl.tag, parsedExpectedUrl.tag)
+})
+
+
+test('actually request and get an response', async t => {
+	const arrAddress = address.map(a =>  new Address(a))
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountBalancemulti(oApiKey, 'account', 'balancemulti', arrAddress, tag)
+	const url = c.toUrl()
+	const parsedUrl = parseUrl(url)
+	const resultFixture = await _readFile(fixtureLocation, 'utf-8')
+
+	nock(`${parsedUrl.protocol}//${parsedUrl.host}`)
+		.get(parsedUrl.path)
+		.reply(200, resultFixture)	
+
+	const result = await c.request()
+	t.truthy(result)
+})
