added account balancemulti and account txlist

sebs · sebs · commit 7774204834da · 2019-08-14T18:55:08.000+02:00
diff --git a/src/client/ClientAccountTxlist.ts b/src/client/ClientAccountTxlist.ts
@@ -0,0 +1,110 @@
+import * as request from 'request-promise-native'
+import { Address } from '../entities/Address'
+import { ApiKey } from '../entities/Apikey'
+import { IClientAccountTxlistRequest } from '../interfaces/Account'
+import { requestBuilder } from '../requestBuilder'
+
+/**
+ * Client for the account balance
+ */
+export class ClientAccountTxlist implements IClientAccountTxlistRequest {
+  /**
+   * 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
+  /**
+   * Block to start reading data
+   */
+  startblock: string
+  /**
+   * Read data to
+   */
+  endblock: string
+  /**
+   * Sort
+   */
+  sort?: string
+  /**
+   * Page
+   */
+  page?: string
+  /**
+   * startpage
+   */
+  offset?: string
+
+  constructor(
+      apiKey: ApiKey,
+      module: string,
+      action: string,
+      address: Address,
+      startblock: string,
+      endblock: string,
+      sort?: string,
+      page?: string,
+      offset?: string) {
+
+    this.apiKey = apiKey
+    this.module = module
+    this.action = action
+    this.address = address
+    this.startblock = startblock
+    this.endblock = endblock
+    this.sort = sort
+    this.page = page
+    this.offset = offset
+  }
+  /**
+   * Returns the serice url
+   * @returns url
+   */
+  toUrl(): string {
+
+    let params = {
+      address: this.address.toString(),
+      apiKey: this.apiKey.toString(),
+      endblock: this.endblock.toString(),
+      startblock: this.startblock.toString(),
+    }
+
+    if (this.sort) {
+      params = Object.assign(params, {
+        sort: this.sort,
+      })
+    }
+
+    if (this.page) {
+      params = Object.assign(params, {
+        page: this.page,
+      })
+    }
+
+    if (this.offset) {
+      params = Object.assign(params, {
+        offset: this.offset,
+      })
+    }
+    return requestBuilder(this.module, this.action, params)
+  }
+  /**
+   * 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
@@ -29,15 +29,38 @@ export interface IClientAccountBalanceMultiRequest extends IClientRequest {
   tag: string
 }
 
-/*
+/**
+ * Interface to Account/txlist
+ */
 export interface IClientAccountTxlistRequest extends IClientRequest {
+  /**
+   * Ethereum address
+   */
   address: Address
+  /**
+   * Block to start reading data
+   */
   startblock: string
+  /**
+   * Read data to
+   */
   endblock: string
+  /**
+   * Paging actual page
+   */
   page?: string
+  /**
+   * Paging start
+   */
   offset?: string
+  /**
+   * Sort Parameter
+   */
   sort?: string
 }
+
+/*
+
 export interface IClientAccountTxlistInternalRequest extends IClientAccountTxlistRequest {
   txhash: string
 }
diff --git a/test/clients/ClientAccountBalancemultiTest.ts b/test/clients/ClientAccountBalancemultiTest.ts
@@ -4,8 +4,7 @@ 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 { parse } from 'url'
 import { readFile } from 'fs'
 import { promisify } from 'util'
 const _readFile = promisify(readFile)
@@ -37,22 +36,21 @@ test('generates the right url', t => {
 	const c = new ClientAccountBalancemulti(oApiKey, 'account', 'balancemulti', arrAddress, tag)
 	const url = c.toUrl()
 
-	const parsedUrl = parse(url)
-	const parsedExpectedUrl = parse(expectedUrl)
+	const parsedUrl = decode(url)
+	const parsedExpectedUrl = decode(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 parsedUrl = parse(url)
 	const resultFixture = await _readFile(fixtureLocation, 'utf-8')
 
 	nock(`${parsedUrl.protocol}//${parsedUrl.host}`)
diff --git a/test/clients/ClientAccountTxlistTest.ts b/test/clients/ClientAccountTxlistTest.ts
@@ -0,0 +1,78 @@
+import test from 'ava'
+import { ClientAccountTxlist } from '../../src/client/ClientAccountTxlist'
+import { Address } from '../../src/entities/Address'
+import { ApiKey } from '../../src/entities/Apikey'
+import { decode } from 'querystring'
+const nock = require('nock')
+import { parse } from 'url'
+import { readFile } from 'fs'
+import { promisify } from 'util'
+const _readFile = promisify(readFile)
+
+const apiKey = 'TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W'
+const address = '0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a'
+const startblock = '0'
+const endblock = '99999999'
+const expectedUrl = 'http://api.etherscan.io/api?module=account&action=txlist&address=0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a&startblock=0&endblock=99999999&sort=asc&apikey=YourApiKeyToken'
+const fixtureLocation= './test/fixtures/account/txlist/address-startblock-endblock.json'
+
+test('exists', t => {
+	t.truthy(ClientAccountTxlist)
+})
+
+test('can be instantiated', t => {
+ 	const oAddress = new Address(address)
+	const oApiKey = new ApiKey(apiKey)
+	new ClientAccountTxlist(oApiKey, 'account', 'balancemulti', oAddress, startblock, endblock)
+	t.pass()
+})
+
+
+test('generates the right url', t => {
+	const oAddress = new Address(address)
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountTxlist(oApiKey, 'account', 'txlist', oAddress, startblock, endblock)
+	const url = c.toUrl()
+
+	const parsedUrl = decode(url)	
+	const parsedExpectedUrl = decode(expectedUrl)
+	
+	t.is(parsedUrl.address, parsedExpectedUrl.address)
+	t.is(parsedUrl.startblock, parsedExpectedUrl.startblock)
+	t.is(parsedUrl.endblock, parsedExpectedUrl.endblock)
+})
+
+test('sort', t => {
+	const oAddress = new Address(address)
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountTxlist(oApiKey, 'account', 'txlist', oAddress, startblock, endblock, 'desc')
+	const url = c.toUrl()
+	const parsedUrl = decode(url)	
+	t.is(parsedUrl.sort, 'desc')
+})
+
+test('start end endblock', t => {
+	const oAddress = new Address(address)
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountTxlist(oApiKey, 'account', 'txlist', oAddress, startblock, endblock, 'desc', '10')
+	const url = c.toUrl()
+	const parsedUrl = decode(url)	
+	t.is(parsedUrl.page, '10')
+})
+
+
+test('actually request and get an response', async t => {
+	const oAddress = new Address(address)
+	const oApiKey = new ApiKey(apiKey)
+	const c = new ClientAccountTxlist(oApiKey, 'account', 'txlist', oAddress, startblock, endblock, 'desc', '10')
+	
+	const resultFixture = await _readFile(fixtureLocation, 'utf-8')
+	const parsedUrl = parse(c.toUrl())
+
+	nock(`${parsedUrl.protocol}//${parsedUrl.host}`)
+		.get(parsedUrl.path)
+		.reply(200, resultFixture)	
+
+	const result = await c.request()
+	t.truthy(result)
+})
diff --git a/test/fixtures/account/txlist/address-startblock-endblock.json b/test/fixtures/account/txlist/address-startblock-endblock.json
diff --git a/test/requestBuilderTest.ts b/test/requestBuilderTest.ts
@@ -25,8 +25,6 @@ test('contains additional parameters', t => {
 	t.regex(res, /bar/)
 })
 
-
-
 test('throws on unknown module', t => {
 	t.throws(()=> requestBuilder('foomodulenotexist', 'balance'))
 })
