Upgrade to Arc v58, Rinkeby contract addresses (#382)

config/default.json

@@ -18,6 +18,10 @@
       "host": "127.0.0.1",
       "port": 8546
     },
+    "private": {
+      "host": "127.0.0.1",
+      "port": 8545
+    },
     "ganache": {
       "host": "127.0.0.1",
       "port": 8545

lib/accountService.ts

@@ -2,8 +2,7 @@ import { promisify } from "es6-promisify";
 import { Address } from "./commonTypes";
 import { LoggingService } from "./loggingService";
 import { IEventSubscription, PubSubEventService } from "./pubSubEventService";
-import { Utils, Web3 } from "./utils";
-import { UtilsInternal } from "./utilsInternal";
+import { Utils } from "./utils";
 
 /**
  * Watch for changes in the default account.
@@ -168,7 +167,7 @@ export class AccountService {
   private static networkChangedTimerId: any;
 
   private static async getNetworkId(): Promise<number | undefined> {
-    const web3 = UtilsInternal.getWeb3Sync();
+    const web3 = await Utils.getWeb3();
     return web3 ?
       Number.parseInt(await promisify(web3.version.getNetwork)() as string, 10) as number | undefined : undefined;
   }

lib/contractWrapperBase.ts

@@ -150,6 +150,7 @@ export abstract class ContractWrapperBase implements IContractWrapper {
 
     const maxGasLimit = await UtilsInternal.computeMaxGasLimit();
 
+    // note that Ganache is identified specifically as the one instantiated by arc.js (by the networkId)
     if (currentNetwork === "Ganache") {
       return maxGasLimit; // because who cares with ganache and we can't get good estimates from it
     }

lib/contractWrapperFactory.ts

@@ -130,6 +130,7 @@ export class ContractWrapperFactory<TWrapper extends IContractWrapper>
 
     const maxGasLimit = await UtilsInternal.computeMaxGasLimit();
 
+    // note that Ganache is identified specifically as the one instantiated by arc.js (by the networkId)
     if (currentNetwork === "Ganache") {
       return maxGasLimit; // because who cares with ganache and we can't get good estimates from it
     }

lib/index.ts

@@ -188,6 +188,14 @@ export async function InitializeArcJs(options: InitializeArcOptions = {}): Promi
       networkName = "private";
     }
 
+    if (options.watchForAccountChanges) {
+      await AccountService.initiateAccountWatch();
+    }
+
+    if (options.watchForNetworkChanges) {
+      await AccountService.initiateNetworkWatch();
+    }
+
     const optionsDeployedContractAddresses = options.deployedContractAddresses || {};
 
     if (!deployedContractAddresses[networkName] && !optionsDeployedContractAddresses[networkName]) {
@@ -203,14 +211,6 @@ export async function InitializeArcJs(options: InitializeArcOptions = {}): Promi
 
     await WrapperService.initialize(options);
 
-    if (options.watchForAccountChanges) {
-      await AccountService.initiateAccountWatch();
-    }
-
-    if (options.watchForNetworkChanges) {
-      await AccountService.initiateNetworkWatch();
-    }
-
     return web3;
   } catch (ex) {
     /* tslint:disable-next-line:no-bitwise */

lib/scripts/createGenesisDao.ts

@@ -26,8 +26,7 @@ interface FounderSpec {
 export class GenesisDaoCreator {
 
   constructor(
-    private web3: Web3,
-    private network: string) {
+    private web3: Web3) {
   }
 
   public async run(): Promise<void> {

lib/utilsInternal.ts

@@ -32,8 +32,13 @@ export class UtilsInternal {
    */
   public static async lastBlockDate(): Promise<Date> {
     const web3 = await Utils.getWeb3();
-    const block = await promisify((callback: any): any =>
-      web3.eth.getBlock("latest", callback))() as BlockWithoutTransactionData;
+    let block;
+    do {
+      block = await promisify((callback: any): any =>
+        web3.eth.getBlock("latest", callback))() as BlockWithoutTransactionData;
+    }
+    while (!block);
+
     return new Date(block.timestamp * 1000);
   }
 

lib/wrappers/auction4Reputation.ts

@@ -1,13 +1,16 @@
 "use strict";
 import BigNumber from "bignumber.js";
+import { DecodedLogEntry } from "web3";
 import { Address, Hash } from "../commonTypes";
 import { ContractWrapperFactory } from "../contractWrapperFactory";
 import { ArcTransactionResult, IContractWrapperFactory } from "../iContractWrapperBase";
 import { SchemeWrapperBase } from "../schemeWrapperBase";
 import { TxGeneratingFunctionOptions } from "../transactionService";
+import { Utils } from "../utils";
 import { UtilsInternal } from "../utilsInternal";
 import { EventFetcherFactory, Web3EventService } from "../web3EventService";
 import { WrapperService } from "../wrapperService";
+import { DaoTokenWrapper } from "./daoToken";
 import { StandardTokenWrapper } from "./standardToken";
 
 export class Auction4ReputationWrapper extends SchemeWrapperBase {
@@ -92,6 +95,7 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
 
   public async redeem(options: Auction4ReputationRedeemOptions & TxGeneratingFunctionOptions)
     : Promise<ArcTransactionResult> {
+
     if (!options.beneficiaryAddress) {
       throw new Error("beneficiaryAddress is not defined");
     }
@@ -104,6 +108,33 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
       throw new Error("auctionId must be greater than or equal to zero");
     }
 
+    const bid = await this.getBid(options.beneficiaryAddress, options.auctionId);
+    if (bid.lte(0)) {
+      // because the Arc contract will revert in this case
+      return Promise.resolve(null);
+    }
+
+    const errMsg = await this.getRedeemBlocker(options);
+
+    if (errMsg) {
+      throw new Error(errMsg);
+    }
+
+    this.logContractFunctionCall("Auction4Reputation.redeem", options);
+
+    return this.wrapTransactionInvocation("Auction4Reputation.redeem",
+      options,
+      this.contract.redeem,
+      [options.beneficiaryAddress, options.auctionId]
+    );
+  }
+
+  /**
+   * Returns reason why can't redeem, or else null if can redeem
+   * @param lockerAddress
+   */
+  public async getRedeemBlocker(options: Auction4ReputationRedeemOptions): Promise<string | null> {
+
     const redeemEnableTime = await this.getRedeemEnableTime();
     const now = await UtilsInternal.lastBlockDate();
 
@@ -117,13 +148,7 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
       throw new Error("the auction period has not passed");
     }
 
-    this.logContractFunctionCall("Auction4Reputation.redeem", options);
-
-    return this.wrapTransactionInvocation("Auction4Reputation.redeem",
-      options,
-      this.contract.redeem,
-      [options.beneficiaryAddress, options.auctionId]
-    );
+    return null;
   }
 
   /**
@@ -133,7 +158,7 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
     const amount = new BigNumber(options.amount);
 
     if (amount.lte(0)) {
-      return "amount must be greater than zero";
+      return "amount to bid must be greater than zero";
     }
 
     const startTime = await this.getAuctionsStartTime();
@@ -143,6 +168,13 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
     if ((now > endTime) || (now < startTime)) {
       return "bidding is not within the allowed bidding period";
     }
+
+    const balance = await DaoTokenWrapper.getGenTokenBalance(await Utils.getDefaultAccount());
+
+    if (balance.lt(amount)) {
+      return "the account has insufficient GEN to bid the requested amount";
+    }
+
     return null;
   }
 
@@ -191,7 +223,7 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
   }
 
   /**
-   * get promise of the amount bid on the given auction.
+   * get promise of the amount the account has bid on the given auction.
    * @param bidderAddress
    * @param auctionId
    */
@@ -201,12 +233,69 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
       throw new Error("bidderAddress is not defined");
     }
 
+    if (!Number.isInteger(auctionId)) {
+      throw new Error("auctionId is not an integer");
+    }
+
+    if (auctionId < 0) {
+      throw new Error("auctionId must be greater than or equal to zero");
+    }
+
     this.validateAuctionId(auctionId);
 
     this.logContractFunctionCall("Auction4Reputation.getBid", { bidderAddress, auctionId });
     return this.contract.getBid(bidderAddress, auctionId);
   }
 
+  public async getUserEarnedReputation(options: Auction4ReputationRedeemOptions): Promise<BigNumber> {
+    if (!options.beneficiaryAddress) {
+      throw new Error("beneficiaryAddress is not defined");
+    }
+
+    if (!Number.isInteger(options.auctionId)) {
+      throw new Error("auctionId is not an integer");
+    }
+
+    if (options.auctionId < 0) {
+      throw new Error("auctionId must be greater than or equal to zero");
+    }
+
+    const bid = await this.getBid(options.beneficiaryAddress, options.auctionId);
+    // because the Arc contract will revert in this case
+    if (bid.eq(0)) {
+      return Promise.resolve(new BigNumber(0));
+    }
+
+    const errMsg = await this.getRedeemBlocker(options);
+
+    if (errMsg) {
+      throw new Error(errMsg);
+    }
+
+    this.logContractFunctionCall("Auction4Reputation.redeem.call", options);
+
+    return this.contract.redeem.call(options.beneficiaryAddress, options.auctionId);
+  }
+
+  /**
+   * get a promise of an array of auction ids and amounts in which the given account has placed a bid,
+   * or all auctions if beneficiaryAddressis not supplied
+   * @param beneficiaryAddress optional
+   */
+  public async getBids(beneficiaryAddress?: Address): Promise<Array<GetBidAuctionIdsResult>> {
+
+    const filter = beneficiaryAddress ? { _bidder: beneficiaryAddress } : {};
+
+    const bids = await this.Bid(filter, { fromBlock: 0 }).get();
+
+    return bids.map((bid: DecodedLogEntry<Auction4ReputationBidEventResult>): GetBidAuctionIdsResult => {
+      return {
+        amount: bid.args._amount,
+        auctionId: bid.args._auctionId.toNumber(),
+      };
+    });
+  }
+
   /**
    * Get a promise of the first date/time when anything can be redeemed
    */
@@ -249,6 +338,16 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
     this.logContractFunctionCall("Auction4Reputation.auctionReputationReward");
     return this.contract.auctionReputationReward();
   }
+
+  /**
+   * Return promise of 0-based id of the current auction.  Returns a negative number if the auction
+   * has not yet begun.  If auction is over then may return an id for an auction that doesn't exist.
+   */
+  public async getCurrentAuctionId(): Promise<number> {
+    const auctionPeriod = (await this.getAuctionPeriod()) * 1000;
+    const auctionsStartTime = (await this.getAuctionsStartTime()).getTime();
+    return Math.floor((Date.now() - auctionsStartTime) / auctionPeriod);
+  }
   /**
    * Get a promise of the number of seconds in a single auction
    */
@@ -276,9 +375,7 @@ export class Auction4ReputationWrapper extends SchemeWrapperBase {
   public async getAuctionTotalBid(auctionId: number): Promise<BigNumber> {
     this.validateAuctionId(auctionId);
     this.logContractFunctionCall("Auction4Reputation.auctions", { auctionId });
-    const result = (await this.contract.auctions(new BigNumber(auctionId))) as
-      { totalBid: BigNumber };
-    return result.totalBid;
+    return this.contract.auctions(new BigNumber(auctionId));
   }
 
   protected hydrated(): void {
@@ -399,3 +496,8 @@ export interface Auction4ReputationRedeemEventResult {
    */
   _beneficiary: Address;
 }
+
+export interface GetBidAuctionIdsResult {
+  auctionId: number;
+  amount: BigNumber;
+}

lib/wrappers/contributionReward.ts

@@ -56,6 +56,7 @@ export class ContributionRewardWrapper extends ProposalGeneratorBase {
     : Promise<ArcTransactionProposalResult> {
 
     const defaults = {
+      descriptionIsHashed: false,
       ethReward: "0",
       externalToken: "", // must have a value for solidity
       externalTokenReward: "0",
@@ -154,7 +155,7 @@ export class ContributionRewardWrapper extends ProposalGeneratorBase {
       eventContext,
       this.contract.proposeContributionReward,
       [options.avatar,
-      Utils.SHA3(options.description),
+      options.descriptionIsHashed ? options.description : Utils.SHA3(options.description),
         reputationChange,
       [nativeTokenReward, ethReward, externalTokenReward, options.periodLength, options.numberOfPeriods],
       options.externalToken,
@@ -539,17 +540,16 @@ export class ContributionRewardWrapper extends ProposalGeneratorBase {
 
   private convertProposalPropsArrayToObject(propsArray: Array<any>, proposalId: Hash): ContributionProposal {
     return {
-      beneficiaryAddress: propsArray[6],
-      contributionDescriptionHash: propsArray[0],
-      ethReward: propsArray[3],
-      executionTime: propsArray[9],
-      externalToken: propsArray[4],
-      externalTokenReward: propsArray[5],
-      nativeTokenReward: propsArray[1],
-      numberOfPeriods: propsArray[8],
-      periodLength: propsArray[7],
+      beneficiaryAddress: propsArray[5],
+      ethReward: propsArray[2],
+      executionTime: propsArray[8],
+      externalToken: propsArray[3],
+      externalTokenReward: propsArray[4],
+      nativeTokenReward: propsArray[0],
+      numberOfPeriods: propsArray[7],
+      periodLength: propsArray[6],
       proposalId,
-      reputationChange: propsArray[2],
+      reputationChange: propsArray[1],
     };
   }
 }
@@ -587,7 +587,6 @@ export interface NewContributionProposalEventResult {
 export interface ContributionProposal {
   proposalId: Hash;
   beneficiaryAddress: Address;
-  contributionDescriptionHash: Hash;
   ethReward: BigNumber;
   executionTime: number;
   externalToken: Address;
@@ -747,6 +746,11 @@ export interface ProposeContributionRewardParams {
    *  beneficiary address
    */
   beneficiaryAddress: string;
+  /**
+   * True if description is a hashed, false if not and in which case Arc.js will hash it.
+   * The default is false.
+   */
+  descriptionIsHashed?: boolean;
 }
 
 export interface ContributionRewardRedeemParams {