Simplify Transitioner (#470)

* Simplifying UnipigTransitioner by making it accept a SignatureProvider instead of being a DefaultWallet
* Making UnipigTransitioner only act on behalf of one Wallet instead of potentially many
* Changing SignatureProvider interface to provide address access
* Changing DefaultWallet to not be a SignatureProvider but instead have many SignatureProviders
* Updating tests

packages/core/src/app/aggregator/aggregator.ts

@@ -52,10 +52,7 @@ export class DefaultAggregator implements Aggregator {
 
     return {
       blockTransaction,
-      witness: await this.signatureProvider.sign(
-        this.publicKey,
-        serializedTransaction
-      ),
+      witness: await this.signatureProvider.sign(serializedTransaction),
     }
   }
 

packages/core/src/app/keystore/signatures.ts

@@ -21,7 +21,7 @@ export class DefaultSignatureProvider implements SignatureProvider {
     private readonly wallet: ethers.Wallet = ethers.Wallet.createRandom()
   ) {}
 
-  public async sign(_address: string, message: string): Promise<string> {
+  public async sign(message: string): Promise<string> {
     return this.wallet.signMessage(message)
   }
 
@@ -31,16 +31,14 @@ export class DefaultSignatureProvider implements SignatureProvider {
 }
 
 export class IdentitySigner implements SignatureProvider {
-  private static _instance: SignatureProvider
-  public static instance(): SignatureProvider {
-    if (!IdentitySigner._instance) {
-      IdentitySigner._instance = new IdentitySigner()
-    }
-    return IdentitySigner._instance
+  public constructor(private address: string) {}
+
+  public async getAddress(): Promise<string> {
+    return this.address
   }
 
-  public async sign(address: string, message: string): Promise<string> {
-    return address
+  public async sign(message: string): Promise<string> {
+    return this.address
   }
 }
 

packages/core/src/app/keystore/wallet.ts

@@ -2,7 +2,8 @@
 import { ethers } from 'ethers'
 
 /* Internal Imports */
-import { Wallet, WalletDB } from '../../types'
+import { SignatureProvider, Wallet, WalletDB } from '../../types'
+import { DefaultSignatureProvider } from './signatures'
 
 /**
  * Simple Wallet implementation.
@@ -71,6 +72,20 @@ export class DefaultWallet implements Wallet {
     delete this.unlocked[address]
   }
 
+  public async getSignatureProvider(
+    address: string
+  ): Promise<SignatureProvider> {
+    if (!(await this.walletdb.hasKeystore(address))) {
+      throw new Error('Account does not exist.')
+    }
+
+    if (!(address in this.unlocked)) {
+      throw new Error('Account is not unlocked.')
+    }
+
+    return new DefaultSignatureProvider(this.unlocked[address])
+  }
+
   /**
    * Signs a message.
    * @param address Address to sign the message from.

packages/core/src/app/ovm/examples/state-channel-client.ts

@@ -330,7 +330,6 @@ export class StateChannelClient {
     )
 
     const signature: string = await this.signatureProvider.sign(
-      this.myAddress,
       serializedMessage
     )
 

packages/core/src/types/keystore/signatures.interface.ts

@@ -1,12 +1,18 @@
 export interface SignatureProvider {
+  /**
+   * Gets the public key for this signature provider.
+   * @returns the public key
+   */
+  getAddress(): Promise<string>
+
   /**
    * Signs the provided message with the private key associated with the provided address.
    *
    * @param address The address
    * @param message The message
    * @returns the signature
    */
-  sign(address: string, message: string): Promise<string>
+  sign(message: string): Promise<string>
 }
 
 export interface SignatureVerifier {

packages/core/src/types/keystore/wallet.interface.ts

@@ -1,8 +1,10 @@
 import { SignatureProvider } from './signatures.interface'
 
-export interface Wallet extends SignatureProvider {
+export interface Wallet {
   listAccounts(): Promise<string[]>
   createAccount(password: string): Promise<string>
   unlockAccount(address: string, password: string): Promise<void>
   lockAccount(address: string): Promise<void>
+  getSignatureProvider(address: string): Promise<SignatureProvider>
+  sign(address: string, message: string): Promise<string>
 }

packages/core/test/app/aggregator/aggregator.spec.ts

@@ -96,8 +96,6 @@ class DummyStateManager implements StateManager {
  *********/
 
 describe('DefaultAggregator', () => {
-  const wallet: ethers.Wallet = ethers.Wallet.createRandom()
-
   let blockManager: DummyBlockManager
   let stateManager: DummyStateManager
   let aggregator: Aggregator
@@ -107,8 +105,8 @@ describe('DefaultAggregator', () => {
   beforeEach(async () => {
     blockManager = new DummyBlockManager()
     stateManager = new DummyStateManager()
-    signatureProvider = new DefaultSignatureProvider(wallet)
-    aggregatorAddress = await wallet.getAddress()
+    signatureProvider = new DefaultSignatureProvider()
+    aggregatorAddress = await signatureProvider.getAddress()
     aggregator = new DefaultAggregator(
       stateManager,
       blockManager,
@@ -151,7 +149,6 @@ describe('DefaultAggregator', () => {
           txCommitment.blockTransaction
         )
         const signature: string = await signatureProvider.sign(
-          aggregatorAddress,
           serializedCommitment
         )
         assert(

packages/example-rollup/index.ts

@@ -7,6 +7,7 @@ import {
   SignedByDecider,
   SimpleClient,
   getLogger,
+  DefaultSignatureProvider,
   BaseDB,
 } from '@pigi/core'
 import {
@@ -119,9 +120,7 @@ async function initialize() {
     transitionerDB,
     rollupStateSolver,
     rollupClient,
-    undefined,
-    undefined,
-    wallet
+    new DefaultSignatureProvider(wallet)
   )
   // Update account address
   updateAccountAddress(wallet.address)
@@ -138,7 +137,7 @@ async function fetchBalanceUpdate() {
 }
 
 async function onRequestFundsClicked() {
-  await unipigWallet.requestFaucetFunds(wallet.address, 10)
+  await unipigWallet.requestFaucetFunds(10)
   const updatedBalances: Balances = await unipigWallet.getBalances(
     wallet.address
   )
@@ -151,7 +150,7 @@ async function onTransferFundsClicked() {
   const amount = parseInt(document.getElementById('send-amount').value, 10)
   const recipient = document.getElementById('send-recipient').value
 
-  await unipigWallet.send(tokenType, wallet.address, recipient, amount)
+  await unipigWallet.send(tokenType, recipient, amount)
   const updatedBalances: Balances = await unipigWallet.getBalances(
     wallet.address
   )
@@ -163,13 +162,7 @@ async function onSwapFundsClicked() {
   const selectedIndex = document.getElementById('swap-token-type').selectedIndex
   const tokenType = selectedIndex === 0 ? UNI_TOKEN_TYPE : PIGI_TOKEN_TYPE
   const inputAmount = parseInt(document.getElementById('swap-amount').value, 10)
-  await unipigWallet.swap(
-    tokenType,
-    wallet.address,
-    inputAmount,
-    0,
-    +new Date() + 1000
-  )
+  await unipigWallet.swap(tokenType, inputAmount, 0, +new Date() + 1000)
   const [senderBalance, uniswapBalance] = await Promise.all([
     unipigWallet.getBalances(wallet.address),
     unipigWallet.getBalances(UNISWAP_ADDRESS),

packages/wallet/src/rollup-aggregator.ts

@@ -11,6 +11,7 @@ import {
   DB,
   getLogger,
   hexStrToBuf,
+  SignatureProvider,
 } from '@pigi/core'
 
 /* Internal Imports */
@@ -22,7 +23,6 @@ import {
   generateTransferTx,
   AGGREGATOR_API,
   RollupTransaction,
-  SignatureProvider,
   UNISWAP_ADDRESS,
   AGGREGATOR_ADDRESS,
   RollupTransition,
@@ -70,17 +70,11 @@ const generateFaucetTxs = async (
 
   return [
     {
-      signature: await signatureProvider.sign(
-        aggregatorAddress,
-        abiEncodeTransaction(txOne)
-      ),
+      signature: await signatureProvider.sign(abiEncodeTransaction(txOne)),
       transaction: txOne,
     },
     {
-      signature: await signatureProvider.sign(
-        aggregatorAddress,
-        abiEncodeTransaction(txTwo)
-      ),
+      signature: await signatureProvider.sign(abiEncodeTransaction(txTwo)),
       transaction: txTwo,
     },
   ]
@@ -173,7 +167,6 @@ export class RollupAggregator extends SimpleServer {
       let signature: Signature
       if (!!stateReceipt.state) {
         signature = await this.signatureProvider.sign(
-          AGGREGATOR_ADDRESS,
           abiEncodeStateReceipt(stateReceipt)
         )
       } else {
@@ -316,7 +309,6 @@ export class RollupAggregator extends SimpleServer {
       transitionIndex,
     }
     const senderSignature: string = await this.signatureProvider.sign(
-      AGGREGATOR_ADDRESS,
       abiEncodeStateReceipt(senderReceipt)
     )
     receipts.push({
@@ -334,7 +326,6 @@ export class RollupAggregator extends SimpleServer {
         transitionIndex,
       }
       const recipientSignature: string = await this.signatureProvider.sign(
-        AGGREGATOR_ADDRESS,
         abiEncodeStateReceipt(recipientReceipt)
       )
       receipts.push({

packages/wallet/src/rollup-client.ts

@@ -72,7 +72,6 @@ export class RollupClient {
     signatureProvider: SignatureProvider
   ): Promise<SignedStateReceipt[]> {
     const signature = await signatureProvider.sign(
-      transaction.sender,
       abiEncodeTransaction(transaction)
     )
     const receipts: SignedStateReceipt[] = await this.rpcClient.handle<
@@ -93,10 +92,7 @@ export class RollupClient {
     transaction: RollupTransaction,
     signatureProvider: SignatureProvider
   ): Promise<SignedStateReceipt> {
-    const signature = await signatureProvider.sign(
-      transaction.sender,
-      serializeObject(transaction)
-    )
+    const signature = await signatureProvider.sign(serializeObject(transaction))
     const receipt: SignedStateReceipt = await this.rpcClient.handle<
       SignedStateReceipt
     >(AGGREGATOR_API.requestFaucetFunds, {

packages/wallet/src/types/types.ts

@@ -49,10 +49,6 @@ export interface State {
   balances: Balances
 }
 
-export interface SignatureProvider {
-  sign(address: string, message: string): Promise<string>
-}
-
 export interface StateUpdate {
   transaction: SignedTransaction
   stateRoot: string