Seperate signer from provider in user-facing API (#270)

nucypher · Sep 4, 2023 · 281e19e · 281e19e · github-actions · Sep 4, 2023
2 parents b7161fd + 0c28fa5
commit 281e19e
Show file tree

Hide file tree

Showing 24 changed files with 271 additions and 144 deletions.
diff --git a/package.json b/package.json
@@ -55,7 +55,7 @@
     "@nucypher/nucypher-core": "^0.12.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"

diff --git a/src/agents/coordinator.ts b/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
   ): Promise<Coordinator> {
     const network = await provider.getNetwork();
     const contractAddress = getContract(network.chainId, 'COORDINATOR');

diff --git a/src/agents/subscription-manager.ts b/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(

diff --git a/src/characters/alice.ts b/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(

diff --git a/src/characters/cbd-recipient.ts b/src/characters/cbd-recipient.ts
@@ -45,17 +45,19 @@ 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 acp = await this.makeAcp(provider, conditionExpr, ciphertext);
+    const acp = await this.makeAcp(provider, signer, conditionExpr, ciphertext);
 
     const decryptionShares = await this.retrieve(
       provider,
       conditionExpr,
       ciphertext,
-      acp
+      acp,
+      signer
     );
 
     const sharedSecret = combineDecryptionSharesSimple(decryptionShares);
@@ -67,7 +69,8 @@ export class ThresholdDecrypter {
   }
 
   private async makeAcp(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
+    signer: ethers.Signer,
     conditionExpr: ConditionExpression,
     ciphertext: Ciphertext
   ) {
@@ -81,23 +84,26 @@ export class ThresholdDecrypter {
     );
 
     const headerHash = keccak256(ciphertext.header.toBytes());
-    const authorization = await provider.getSigner().signMessage(headerHash);
+    const authorization = await signer.signMessage(headerHash);
 
     return new AccessControlPolicy(authData, toBytes(authorization));
   }
 
   // Retrieve decryption shares
   public async retrieve(
-    provider: ethers.providers.Web3Provider,
+    provider: ethers.providers.Provider,
     conditionExpr: ConditionExpression,
     ciphertext: Ciphertext,
-    acp: AccessControlPolicy
+    acp: AccessControlPolicy,
+    signer?: ethers.Signer
   ): 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,

diff --git a/src/characters/pre-recipient.ts b/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,12 @@ 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,
+      conditions,
+      {},
+      signer
+    );
 
     const policyMessageKits = messageKits.map((mk) =>
       PolicyMessageKit.fromMessageKit(

diff --git a/src/conditions/base/condition.ts b/src/conditions/base/condition.ts
@@ -1,6 +1,7 @@
 import Joi from 'joi';
 
 import { objectEquals } from '../../utils';
+import { USER_ADDRESS_PARAM } from '../const';
 
 type Map = Record<string, unknown>;
 
@@ -19,6 +20,10 @@ export class Condition {
     return this.schema.validate(newValue);
   }
 
+  public requiresSigner(): boolean {
+    return JSON.stringify(this.value).includes(USER_ADDRESS_PARAM);
+  }
+
   public toObj(): Map {
     const { error, value } = this.validate(this.value);
     if (error) {

diff --git a/src/conditions/condition-expr.ts b/src/conditions/condition-expr.ts
@@ -12,7 +12,7 @@ import {
 } from './base';
 import { BLOCKTIME_METHOD } from './base/time';
 import { CompoundCondition } from './compound-condition';
-import { ConditionContext } from './context';
+import { ConditionContext, CustomContextParam } from './context';
 
 export type ConditionExpressionJSON = {
   version: string;
@@ -85,9 +85,20 @@ export class ConditionExpression {
   }
 
   public buildContext(
-    provider: ethers.providers.Web3Provider
+    provider: ethers.providers.Provider,
+    customParameters: Record<string, CustomContextParam> = {},
+    signer?: ethers.Signer
   ): ConditionContext {
-    return new ConditionContext([this.condition], provider);
+    return new ConditionContext(
+      provider,
+      [this.condition],
+      customParameters,
+      signer
+    );
+  }
+
+  public contextRequiresSigner(): boolean {
+    return this.condition.requiresSigner();
   }
 
   public asAad(): Uint8Array {