draft signer-provider seperation

package.json

@@ -55,7 +55,7 @@
     "@nucypher/nucypher-core": "^0.11.0",
     "axios": "^0.21.1",
     "deep-equal": "^2.2.1",
-    "ethers": "^5.4.1",
+    "ethers": "^5.7.2",
     "joi": "^17.7.0",
     "qs": "^6.10.1",
     "semver": "^7.5.2"

src/agents/coordinator.ts

@@ -57,10 +57,11 @@ export class DkgCoordinatorAgent {
   }
 
   public static async initializeRitual(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     providers: ChecksumAddress[]
   ): Promise<number> {
-    const Coordinator = await this.connectReadWrite(provider);
+    const Coordinator = await this.connectReadWrite(provider, signer);
     const tx = await Coordinator.initiateRitual(providers);
     const txReceipt = await tx.wait(DEFAULT_WAIT_N_CONFIRMATIONS);
     const [ritualStartEvent] = txReceipt.events ?? [];
@@ -79,15 +80,15 @@ export class DkgCoordinatorAgent {
   }
 
   public static async getRitualState(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     ritualId: number
   ): Promise<DkgRitualState> {
     const Coordinator = await this.connectReadOnly(provider);
     return await Coordinator.getRitualState(ritualId);
   }
 
   public static async onRitualEndEvent(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     ritualId: number,
     callback: (successful: boolean) => void
   ): Promise<void> {
@@ -109,14 +110,15 @@ export class DkgCoordinatorAgent {
   }
 
   private static async connectReadWrite(
-    web3Provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer
   ) {
-    return await this.connect(web3Provider, web3Provider.getSigner());
+    return await this.connect(provider, signer);
   }
 
   private static async connect(
     provider: ethers.providers.Provider,
-    signer?: ethers.providers.JsonRpcSigner
+    signer: ethers.Signer | undefined = undefined
   ): Promise<Coordinator> {
     const network = await provider.getNetwork();
     const contractAddress = getContract(network.chainId, 'COORDINATOR');

src/agents/subscription-manager.ts

@@ -15,15 +15,16 @@ import { DEFAULT_WAIT_N_CONFIRMATIONS, getContract } from './contracts';
 
 export class PreSubscriptionManagerAgent {
   public static async createPolicy(
-    web3Provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     valueInWei: BigNumber,
     policyId: Uint8Array,
     size: number,
     startTimestamp: number,
     endTimestamp: number,
     ownerAddress: ChecksumAddress
   ): Promise<ContractTransaction> {
-    const SubscriptionManager = await this.connectReadWrite(web3Provider);
+    const SubscriptionManager = await this.connectReadWrite(provider, signer);
     const overrides = {
       value: valueInWei.toString(),
     };
@@ -66,14 +67,15 @@ export class PreSubscriptionManagerAgent {
   }
 
   private static async connectReadWrite(
-    web3Provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer
   ) {
-    return await this.connect(web3Provider, web3Provider.getSigner());
+    return await this.connect(provider, signer);
   }
 
   private static async connect(
     provider: ethers.providers.Provider,
-    signer?: ethers.providers.JsonRpcSigner
+    signer?: ethers.Signer
   ): Promise<SubscriptionManager> {
     const network = await provider.getNetwork();
     const contractAddress = getContract(

src/characters/alice.ts

@@ -42,7 +42,8 @@ export class Alice {
   }
 
   public async grant(
-    web3Provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     porterUri: string,
     policyParameters: BlockchainPolicyParameters,
     includeUrsulas?: readonly ChecksumAddress[],
@@ -54,12 +55,12 @@ export class Alice {
       excludeUrsulas,
       includeUrsulas
     );
-    const policy = await this.createPolicy(web3Provider, policyParameters);
-    return await policy.enact(web3Provider, ursulas);
+    const policy = await this.createPolicy(provider, policyParameters);
+    return await policy.enact(provider, signer, ursulas);
   }
 
   public async generatePreEnactedPolicy(
-    web3Provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     porterUri: string,
     policyParameters: BlockchainPolicyParameters,
     includeUrsulas?: readonly ChecksumAddress[],
@@ -71,7 +72,7 @@ export class Alice {
       excludeUrsulas,
       includeUrsulas
     );
-    const policy = await this.createPolicy(web3Provider, policyParameters);
+    const policy = await this.createPolicy(provider, policyParameters);
     return await policy.generatePreEnactedPolicy(ursulas);
   }
 
@@ -94,11 +95,11 @@ export class Alice {
   }
 
   private async createPolicy(
-    web3Provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     rawParameters: BlockchainPolicyParameters
   ): Promise<BlockchainPolicy> {
     const { bob, label, threshold, shares, startDate, endDate } =
-      await this.validatePolicyParameters(web3Provider, rawParameters);
+      await this.validatePolicyParameters(provider, rawParameters);
     const { delegatingKey, verifiedKFrags } = this.generateKFrags(
       bob,
       label,
@@ -119,7 +120,7 @@ export class Alice {
   }
 
   private async validatePolicyParameters(
-    web3Provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     rawParams: BlockchainPolicyParameters
   ): Promise<BlockchainPolicyParameters> {
     const startDate = rawParams.startDate ?? new Date();
@@ -141,8 +142,8 @@ export class Alice {
       );
     }
 
-    const blockNumber = await web3Provider.getBlockNumber();
-    const block = await web3Provider.getBlock(blockNumber);
+    const blockNumber = await provider.getBlockNumber();
+    const block = await provider.getBlock(blockNumber);
     const blockTime = new Date(block.timestamp * 1000);
     if (endDate < blockTime) {
       throw new Error(

src/characters/cbd-recipient.ts

@@ -44,12 +44,14 @@ export class ThresholdDecrypter {
 
   // Retrieve and decrypt ciphertext using provider and condition expression
   public async retrieveAndDecrypt(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     conditionExpr: ConditionExpression,
     ciphertext: Ciphertext
   ): Promise<Uint8Array> {
     const decryptionShares = await this.retrieve(
       provider,
+      signer,
       conditionExpr,
       ciphertext
     );
@@ -64,15 +66,18 @@ export class ThresholdDecrypter {
 
   // Retrieve decryption shares
   public async retrieve(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     conditionExpr: ConditionExpression,
     ciphertext: Ciphertext
   ): Promise<DecryptionShareSimple[]> {
     const dkgParticipants = await DkgCoordinatorAgent.getParticipants(
       provider,
       this.ritualId
     );
-    const contextStr = await conditionExpr.buildContext(provider).toJson();
+    const contextStr = await conditionExpr
+      .buildContext(provider, signer)
+      .toJson();
     const { sharedSecrets, encryptedRequests } = this.makeDecryptionRequests(
       this.ritualId,
       ciphertext,

src/characters/pre-recipient.ts

@@ -63,10 +63,15 @@ export class PreDecrypter {
   }
 
   public async retrieveAndDecrypt(
-    messageKits: readonly MessageKit[],
-    provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
+    messageKits: readonly MessageKit[]
   ): Promise<readonly Uint8Array[]> {
-    const policyMessageKits = await this.retrieve(messageKits, provider);
+    const policyMessageKits = await this.retrieve(
+      provider,
+      signer,
+      messageKits
+    );
 
     policyMessageKits.forEach((mk: PolicyMessageKit) => {
       if (!mk.isDecryptableByReceiver()) {
@@ -90,8 +95,9 @@ export class PreDecrypter {
   }
 
   public async retrieve(
-    messageKits: readonly MessageKit[],
-    provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
+    messageKits: readonly MessageKit[]
   ): Promise<readonly PolicyMessageKit[]> {
     const treasureMap = this.encryptedTreasureMap.decrypt(
       this.keyring.secretKey,
@@ -106,7 +112,7 @@ export class PreDecrypter {
       .reduce((acc: ConditionExpression[], val) => acc.concat(val), [])
       .map((condExpr: ConditionExpression) => condExpr.condition);
 
-    const conditionContext = new ConditionContext(conditions, provider);
+    const conditionContext = new ConditionContext(provider, signer, conditions);
 
     const policyMessageKits = messageKits.map((mk) =>
       PolicyMessageKit.fromMessageKit(

src/conditions/condition-expr.ts

@@ -85,9 +85,10 @@ export class ConditionExpression {
   }
 
   public buildContext(
-    provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer
   ): ConditionContext {
-    return new ConditionContext([this.condition], provider);
+    return new ConditionContext(provider, signer, [this.condition]);
   }
 
   public asAad(): Uint8Array {

src/conditions/context/context.ts

@@ -17,10 +17,11 @@ export class ConditionContext {
   private readonly walletAuthProvider: WalletAuthenticationProvider;
 
   constructor(
-    private readonly conditions: ReadonlyArray<Condition>,
     // TODO: We don't always need a web3 provider, only in cases where some specific context parameters are used
     // TODO: Consider making this optional or introducing a different pattern to handle that
-    private readonly web3Provider: ethers.providers.Web3Provider,
+    private readonly provider: ethers.providers.Provider,
+    private readonly signer: ethers.Signer,
+    private readonly conditions: ReadonlyArray<Condition>,
     public readonly customParameters: Record<string, CustomContextParam> = {}
   ) {
     Object.keys(customParameters).forEach((key) => {
@@ -35,7 +36,10 @@ export class ConditionContext {
         );
       }
     });
-    this.walletAuthProvider = new WalletAuthenticationProvider(web3Provider);
+    this.walletAuthProvider = new WalletAuthenticationProvider(
+      provider,
+      signer
+    );
   }
 
   public toObj = async (): Promise<Record<string, ContextParam>> => {
@@ -103,6 +107,11 @@ export class ConditionContext {
   public withCustomParams = (
     params: Record<string, CustomContextParam>
   ): ConditionContext => {
-    return new ConditionContext(this.conditions, this.web3Provider, params);
+    return new ConditionContext(
+      this.provider,
+      this.signer,
+      this.conditions,
+      params
+    );
   };
 }

src/conditions/context/providers.ts

@@ -1,3 +1,4 @@
+import type { TypedDataSigner } from '@ethersproject/abstract-signer';
 import { ethers } from 'ethers';
 import { utils as ethersUtils } from 'ethers/lib/ethers';
 
@@ -18,10 +19,13 @@ interface ChainData {
 export class WalletAuthenticationProvider {
   private walletSignature?: Record<string, string>;
 
-  constructor(private readonly web3Provider: ethers.providers.Web3Provider) {}
+  constructor(
+    private readonly provider: ethers.providers.Provider,
+    private readonly signer: ethers.Signer
+  ) {}
 
   public async getOrCreateWalletSignature(): Promise<TypedSignature> {
-    const address = await this.web3Provider.getSigner().getAddress();
+    const address = await this.signer.getAddress();
     const storageKey = `wallet-signature-${address}`;
 
     // If we have a signature in localStorage, return it
@@ -59,7 +63,7 @@ export class WalletAuthenticationProvider {
   private async createWalletSignature(): Promise<TypedSignature> {
     // Ensure freshness of the signature
     const { blockNumber, blockHash, chainId } = await this.getChainData();
-    const address = await this.web3Provider.getSigner().getAddress();
+    const address = await this.signer.getAddress();
     const signatureText = `I'm the owner of address ${address} as of block number ${blockNumber}`;
     const salt = ethersUtils.hexlify(ethersUtils.randomBytes(32));
 
@@ -85,9 +89,10 @@ export class WalletAuthenticationProvider {
         blockHash,
       },
     };
-    const signature = await this.web3Provider
-      .getSigner()
-      ._signTypedData(typedData.domain, typedData.types, typedData.message);
+    // https://github.com/ethers-io/ethers.js/issues/1431#issuecomment-813950552
+    const signature = await (
+      this.signer as unknown as TypedDataSigner
+    )._signTypedData(typedData.domain, typedData.types, typedData.message);
 
     const formattedTypedData: FormattedTypedData = {
       ...typedData,
@@ -118,9 +123,9 @@ export class WalletAuthenticationProvider {
   }
 
   private async getChainData(): Promise<ChainData> {
-    const blockNumber = await this.web3Provider.getBlockNumber();
-    const blockHash = (await this.web3Provider.getBlock(blockNumber)).hash;
-    const chainId = (await this.web3Provider.getNetwork()).chainId;
+    const blockNumber = await this.provider.getBlockNumber();
+    const blockHash = (await this.provider.getBlock(blockNumber)).hash;
+    const chainId = (await this.provider.getNetwork()).chainId;
     return { blockNumber, blockHash, chainId };
   }
 }