Added new refactored file service

src/client.ts

@@ -3,7 +3,7 @@ import { keccak256 } from '@ethersproject/keccak256';
 import { Wallet } from '@ethersproject/wallet';
 import { Buffer } from 'buffer';
 import invariant from 'tiny-invariant';
-import { AccountAPI, FaucetAPI, FileAPI } from './api';
+import { AccountAPI, FaucetAPI } from './api';
 import { AccountCore } from './core/account';
 import { ElectionCore } from './core/election';
 import { VoteCore } from './core/vote';
@@ -34,6 +34,7 @@ import {
   CspCensusProof,
   CspService,
   ElectionService,
+  FileService,
   VoteService,
   ZkProof,
 } from './services';
@@ -132,6 +133,7 @@ export class VocdoniSDKClient {
   public cspService: CspService;
   public electionService: ElectionService;
   public voteService: VoteService;
+  public fileService: FileService;
 
   public url: string;
   public wallet: Wallet | Signer | null;
@@ -164,6 +166,7 @@ export class VocdoniSDKClient {
     };
     this.explorerUrl = EXPLORER_URL[opts.env];
     this.censusService = new CensusService({ url: this.url });
+    this.fileService = new FileService({ url: this.url });
     this.chainService = new ChainService({ url: this.url });
     this.anonymousService = new AnonymousService({ url: this.url });
     this.electionService = new ElectionService({
@@ -218,16 +221,6 @@ export class VocdoniSDKClient {
     return this.accountData;
   }
 
-  /**
-   * Fetches the CID expected for the specified data content.
-   *
-   * @param {string} data The data of which we want the CID of
-   * @returns {Promise<string>} Resulting CID
-   */
-  calculateCID(data: string): Promise<string> {
-    return FileAPI.cid(this.url, data).then((data) => data.cid);
-  }
-
   /**
    * Fetches a faucet payload. Only for development.
    *
@@ -390,7 +383,7 @@ export class VocdoniSDKClient {
 
     const accountData = Promise.all([
       this.fetchChainId(),
-      this.calculateCID(Buffer.from(JSON.stringify(options.account.generateMetadata()), 'utf8').toString('base64')),
+      this.fileService.calculateCID(JSON.stringify(options.account.generateMetadata())),
     ]).then((data) =>
       AccountCore.generateCreateAccountTransaction(address, options.account, data[1], faucetPackage, calculatedSik)
     );
@@ -411,7 +404,7 @@ export class VocdoniSDKClient {
     const accountData = Promise.all([
       this.fetchAccountInfo(),
       this.fetchChainId(),
-      this.calculateCID(Buffer.from(JSON.stringify(account.generateMetadata()), 'utf8').toString('base64')),
+      this.fileService.calculateCID(JSON.stringify(account.generateMetadata())),
     ]).then((data) => AccountCore.generateUpdateAccountTransaction(data[0], account, data[2]));
 
     return this.setAccountInfo(accountData);
@@ -529,7 +522,7 @@ export class VocdoniSDKClient {
 
     const electionData = Promise.all([
       this.fetchAccountInfo(),
-      this.calculateCID(Buffer.from(JSON.stringify(election.generateMetadata()), 'utf8').toString('base64')),
+      this.fileService.calculateCID(JSON.stringify(election.generateMetadata())),
     ]).then((data) =>
       ElectionCore.generateNewElectionTransaction(election, data[1], this.chainService.chainData, data[0])
     );
@@ -920,4 +913,14 @@ export class VocdoniSDKClient {
   public calculateElectionCost(election: UnpublishedElection): Promise<number> {
     return this.electionService.calculateElectionCost(election);
   }
+
+  /**
+   * Fetches the CID expected for the specified data content.
+   *
+   * @param {string} data The data of which we want the CID of
+   * @returns {Promise<string>} Resulting CID
+   */
+  calculateCID(data: string): Promise<string> {
+    return this.fileService.calculateCID(data);
+  }
 }

src/services/anonymous.ts

@@ -80,10 +80,12 @@ export class AnonymousService extends Service implements AnonymousServicePropert
   }
 
   async fetchAccountSIK(address: string) {
+    invariant(this.url, 'No URL set');
     return ZkAPI.sik(this.url, address);
   }
 
   async fetchZKProof(address: string) {
+    invariant(this.url, 'No URL set');
     return ZkAPI.proof(this.url, address);
   }
 
@@ -137,6 +139,7 @@ export class AnonymousService extends Service implements AnonymousServicePropert
         return Promise.resolve(this.chainCircuits);
       } catch (e) {}
     }
+    invariant(this.url, 'No URL set');
 
     const setCircuitInfo = this.chainCircuits
       ? Promise.resolve(this.chainCircuits)

src/services/census.ts

@@ -2,6 +2,7 @@ import { Service, ServiceProperties } from './service';
 import { CensusType, PlainCensus, WeightedCensus } from '../types';
 import { CensusAPI, WalletAPI } from '../api';
 import { Wallet } from '@ethersproject/wallet';
+import invariant from 'tiny-invariant';
 
 interface CensusServiceProperties {
   auth: CensusAuth;
@@ -63,6 +64,7 @@ export class CensusService extends Service implements CensusServiceProperties {
    * @returns {Promise<{size: number, weight: bigint}>}
    */
   fetchCensusInfo(censusId: string): Promise<{ size: number; weight: bigint; type: CensusType }> {
+    invariant(this.url, 'No URL set');
     return Promise.all([
       CensusAPI.size(this.url, censusId),
       CensusAPI.weight(this.url, censusId),
@@ -88,6 +90,7 @@ export class CensusService extends Service implements CensusServiceProperties {
    * @returns {Promise<CensusProof>}
    */
   async fetchProof(censusId: string, key: string): Promise<CensusProof> {
+    invariant(this.url, 'No URL set');
     return CensusAPI.proof(this.url, censusId, key).then((censusProof) => ({
       type: censusProof.type,
       weight: censusProof.weight,
@@ -105,6 +108,7 @@ export class CensusService extends Service implements CensusServiceProperties {
    * @returns {Promise<void>}
    */
   createCensus(census: PlainCensus | WeightedCensus): Promise<void> {
+    invariant(this.url, 'No URL set');
     const censusCreation = this.fetchAccountToken().then(() =>
       CensusAPI.create(this.url, this.auth.identifier, census.type)
     );
@@ -135,6 +139,7 @@ export class CensusService extends Service implements CensusServiceProperties {
     if (this.auth) {
       return Promise.resolve();
     }
+    invariant(this.url, 'No URL set');
 
     this.auth = {
       identifier: '',

src/services/chain.ts

@@ -1,5 +1,6 @@
 import { Service, ServiceProperties } from './service';
 import { ChainAPI, IChainGetCostsResponse, IChainTxReference } from '../api';
+import invariant from 'tiny-invariant';
 
 interface ChainServiceProperties {
   chainCosts: ChainCosts;
@@ -42,6 +43,7 @@ export class ChainService extends Service implements ChainServiceProperties {
     if (this.chainData) {
       return Promise.resolve(this.chainData);
     }
+    invariant(this.url, 'No URL set');
 
     return ChainAPI.info(this.url).then((chainData) => {
       this.chainData = chainData;
@@ -58,6 +60,7 @@ export class ChainService extends Service implements ChainServiceProperties {
     if (this.chainCosts) {
       return Promise.resolve(this.chainCosts);
     }
+    invariant(this.url, 'No URL set');
 
     return ChainAPI.costs(this.url).then((chainCosts) => {
       this.chainCosts = chainCosts;
@@ -72,6 +75,7 @@ export class ChainService extends Service implements ChainServiceProperties {
    * @returns {Promise<string>} The transaction hash
    */
   submitTx(payload: string): Promise<string> {
+    invariant(this.url, 'No URL set');
     return ChainAPI.submitTx(this.url, payload).then((txData) => txData.hash);
   }
 
@@ -82,6 +86,7 @@ export class ChainService extends Service implements ChainServiceProperties {
    * @returns {Promise<ChainTx>} The chain transaction
    */
   txInfo(txHash: string): Promise<ChainTx> {
+    invariant(this.url, 'No URL set');
     return ChainAPI.txInfo(this.url, txHash);
   }
 }

src/services/file.ts

@@ -0,0 +1,32 @@
+import { Service, ServiceProperties } from './service';
+import { FileAPI } from '../api';
+import invariant from 'tiny-invariant';
+import { Buffer } from 'buffer';
+
+interface FileServiceProperties {}
+
+type FileServiceParameters = ServiceProperties & FileServiceProperties;
+
+export class FileService extends Service implements FileServiceProperties {
+  /**
+   * Instantiate the election service.
+   *
+   * @param {Partial<FileServiceParameters>} params The service parameters
+   */
+  constructor(params: Partial<FileServiceParameters>) {
+    super();
+    Object.assign(this, params);
+  }
+
+  /**
+   * Fetches the CID expected for the specified data content.
+   *
+   * @param {string} data The data of which we want the CID of
+   * @returns {Promise<string>} Resulting CID
+   */
+  calculateCID(data: string): Promise<string> {
+    invariant(this.url, 'No URL set');
+    const b64Data = Buffer.from(data, 'utf8').toString('base64');
+    return FileAPI.cid(this.url, b64Data).then((response) => response.cid);
+  }
+}

src/services/index.ts

@@ -2,6 +2,7 @@ export * from './census';
 export * from './chain';
 export * from './csp';
 export * from './election';
+export * from './file';
 export * from './service';
 export * from './anonymous';
 export * from './vote';

src/services/vote.ts

@@ -45,6 +45,7 @@ export class VoteService extends Service implements VoteServiceProperties {
    * @returns {Promise<VoteInfo>}
    */
   info(address: string, electionId: string): Promise<VoteInfo> {
+    invariant(this.url, 'No URL set');
     return VoteAPI.info(this.url, keccak256(address.toLowerCase() + electionId));
   }
 
@@ -56,6 +57,7 @@ export class VoteService extends Service implements VoteServiceProperties {
    * @returns {Promise<VoteSubmit>}
    */
   vote(payload: string): Promise<VoteSubmit> {
+    invariant(this.url, 'No URL set');
     return VoteAPI.submit(this.url, payload);
   }
 }