Create @celo/encrypted-backup backup for ODIS hardened password encrypted backups

dependency-graph.json

@@ -110,7 +110,6 @@
     "dependencies": [
       "@celo/base",
       "@celo/contractkit",
-      "@celo/identity",
       "@celo/utils",
       "@celo/wallet-local"
     ]
@@ -171,6 +170,17 @@
       "@celo/utils"
     ]
   },
+  "@celo/encrypted-backup": {
+    "location": "packages/sdk/encrypted-backup",
+    "dependencies": [
+      "@celo/base",
+      "@celo/dev-utils",
+      "@celo/flake-tracker",
+      "@celo/identity",
+      "@celo/phone-number-privacy-common",
+      "@celo/utils"
+    ]
+  },
   "@celo/explorer": {
     "location": "packages/sdk/explorer",
     "dependencies": [
@@ -197,6 +207,7 @@
       "@celo/contractkit",
       "@celo/dev-utils",
       "@celo/flake-tracker",
+      "@celo/phone-number-privacy-common",
       "@celo/utils",
       "@celo/wallet-local"
     ]

packages/phone-number-privacy/combiner/src/bls/bls-cryptography-client.ts

@@ -44,7 +44,7 @@ export class BLSCryptographyClient {
     blindedMessage: string,
     logger?: Logger
   ): Promise<string> {
-    logger = logger ?? rootLogger
+    logger = logger ?? rootLogger()
     const threshold = config.thresholdSignature.threshold
     if (!this.hasSufficientSignatures()) {
       logger.error(

packages/phone-number-privacy/combiner/src/config.ts

@@ -46,7 +46,7 @@ interface Config {
 let config: Config
 
 if (DEV_MODE) {
-  logger.debug('Running in dev mode')
+  logger().debug('Running in dev mode')
   config = {
     blockchain: {
       provider: FORNO_ALFAJORES,

packages/phone-number-privacy/common/package.json

@@ -20,7 +20,6 @@
   "dependencies": {
     "@celo/base": "1.3.3",
     "@celo/contractkit": "1.3.3",
-    "@celo/identity": "1.3.3-dev",
     "@celo/utils": "1.3.3-dev",
     "bignumber.js": "^9.0.0",
     "blind-threshold-bls": "https://github.com/celo-org/blind-threshold-bls-wasm#e1e2f8a",
@@ -30,8 +29,7 @@
     "bunyan-gke-stackdriver": "0.1.2",
     "dotenv": "^8.2.0",
     "elliptic": "^6.5.4",
-    "is-base64": "^1.1.0",
-    "libphonenumber-js": "^1.9.11"
+    "is-base64": "^1.1.0"
   },
   "devDependencies": {
     "@celo/wallet-local": "1.3.3-dev",
@@ -44,4 +42,4 @@
   "engines": {
     "node": ">=10"
   }
-}
+}

packages/phone-number-privacy/common/src/domains/constants.ts

@@ -0,0 +1,9 @@
+/**
+ * Enum of identifiers (i.e. names) for all standardized domains
+ *
+ * @privateRemarks DomainIdentifiers is defined in a separate file to avoid issues with circular
+ * dependencies causing undefined errors.
+ */
+export enum DomainIdentifiers {
+  SequentialDelay = 'ODIS Sequential Delay Domain',
+}

packages/sdk/identity/src/odis/domains.test.ts → packages/phone-number-privacy/common/src/domains/domains.test.ts

@@ -6,15 +6,9 @@ import {
   noNumber,
   noString,
 } from '@celo/utils/lib/sign-typed-data-utils'
-import {
-  Domain,
-  domainEIP712,
-  DomainOptions,
-  KnownDomain,
-  KnownDomainOptions,
-  SequentialDelayDomain,
-  SequentialDelayDomainOptions,
-} from './domains'
+import { DomainIdentifiers } from './constants'
+import { Domain, domainEIP712, DomainOptions, KnownDomain, KnownDomainOptions } from './domains'
+import { SequentialDelayDomain, SequentialDelayDomainOptions } from './sequential-delay'
 
 // Compile-time check that Domain can be cast to type EIP712Object
 export const TEST_DOMAIN_IS_EIP712: EIP712Object = ({} as unknown) as Domain
@@ -36,7 +30,7 @@ TEST_KNOWN_DOMAIN_DOMAIN_OPTIONS_ARE_DOMAIN_OPTIONS = ({} as unknown) as KnownDo
 describe('domainEIP712()', () => {
   it('should generate the correct type data for SequentialDelayDomain instance', () => {
     const domain: SequentialDelayDomain = {
-      name: 'ODIS Sequential Delay Domain',
+      name: DomainIdentifiers.SequentialDelay,
       version: '1',
       stages: [
         { delay: 0, resetTimer: noBool, batchSize: defined(2), repetitions: noNumber },

packages/sdk/identity/src/odis/domains.ts → packages/phone-number-privacy/common/src/domains/domains.ts

@@ -1,12 +1,20 @@
 import {
   EIP712Object,
   EIP712ObjectValue,
-  EIP712Optional,
-  eip712OptionalType,
   EIP712TypedData,
   EIP712TypesWithPrimary,
   generateTypedDataHash,
 } from '@celo/utils/lib/sign-typed-data-utils'
+import * as t from 'io-ts'
+import {
+  isSequentialDelayDomain,
+  SequentialDelayDomain,
+  sequentialDelayDomainEIP712Types,
+  SequentialDelayDomainOptions,
+  sequentialDelayDomainOptionsEIP712Types,
+  SequentialDelayDomainSchema,
+  SequentialDelayDomainState,
+} from './sequential-delay'
 
 // Concrete Domain subtypes are only assignable to Domain and EIP712Object when using type instead
 // of interface. Otherwise the compiler complains about a missing index signature.
@@ -33,100 +41,6 @@ export interface Domain {
  */
 export type DomainOptions = EIP712Object
 
-export type SequentialDelayStage = {
-  /**
-   * How many seconds each batch of attempts in this stage is delayed with
-   * respect to the timer.
-   */
-  delay: number
-  /**
-   * Whether the timer should be reset between attempts during this stage.
-   * Defaults to true.
-   */
-  resetTimer: EIP712Optional<boolean>
-  /**
-   * The number of continuous attempts a user gets before the next delay
-   * in each repetition of this stage. Defaults to 1.
-   */
-  batchSize: EIP712Optional<number>
-  /**
-   * The number of times this stage repeats before continuing to the next stage
-   * in the RateLimit array. Defaults to 1.
-   */
-  repetitions: EIP712Optional<number>
-}
-
-export type SequentialDelayDomain = {
-  name: 'ODIS Sequential Delay Domain'
-  version: '1'
-  stages: SequentialDelayStage[]
-  /**
-   * Optional Celo address against which signed requests must be authenticated.
-   * In the case of Cloud Backup, this will be derived from a one-time key stored with the ciphertext.
-   * Encoded as a checksummed address with leading "0x".
-   */
-  address: EIP712Optional<string>
-  /**
-   * Optional string to distinguish the output of this domain instance from
-   * other SequentialDelayDomain instances
-   */
-  salt: EIP712Optional<string>
-}
-
-export type SequentialDelayDomainOptions = {
-  /**
-   * EIP-712 signature over the entire request by the address specified in the domain.
-   * Required if `address` is defined in the domain instance. If `address` is
-   * not defined in the domain instance, then a signature must not be provided.
-   * Encoded as a hex string with leading 0x.
-   */
-  signature: EIP712Optional<string>
-  /**
-   * Used to prevent replay attacks. Required if a signature is provided.
-   * Code verifying the signature for rate limiting should check this nonce against a counter of
-   * applied requests. E.g. Ensure the nonce is 0 on the first request and 2 on the third.
-   */
-  nonce: EIP712Optional<number>
-}
-
-export const isSequentialDelayDomain = (domain: Domain): domain is SequentialDelayDomain =>
-  domain.name === 'ODIS Sequential Delay Domain' && domain.version === '1'
-
-export const sequentialDelayDomainEIP712Types: EIP712TypesWithPrimary = {
-  types: {
-    SequentialDelayDomain: [
-      { name: 'address', type: 'Optional<address>' },
-      { name: 'name', type: 'string' },
-      { name: 'salt', type: 'Optional<string>' },
-      { name: 'stages', type: 'SequentialDelayStage[]' },
-      { name: 'version', type: 'string' },
-    ],
-    SequentialDelayStage: [
-      { name: 'batchSize', type: 'Optional<uint256>' },
-      { name: 'delay', type: 'uint256' },
-      { name: 'repetitions', type: 'Optional<uint256>' },
-      { name: 'resetTimer', type: 'Optional<bool>' },
-    ],
-    ...eip712OptionalType('address'),
-    ...eip712OptionalType('string'),
-    ...eip712OptionalType('uint256'),
-    ...eip712OptionalType('bool'),
-  },
-  primaryType: 'SequentialDelayDomain',
-}
-
-export const sequentialDelayDomainOptionsEIP712Types: EIP712TypesWithPrimary = {
-  types: {
-    SequentialDelayDomainOptions: [
-      { name: 'nonce', type: 'Optional<uint256>' },
-      { name: 'signature', type: 'Optional<string>' },
-    ],
-    ...eip712OptionalType('string'),
-    ...eip712OptionalType('uint256'),
-  },
-  primaryType: 'SequentialDelayDomainOptions',
-}
-
 /**
  * Union type of domains which are currently implmented and standardized for use with ODIS.
  * Domains should be added to the union type as they are implemented.
@@ -135,6 +49,9 @@ export const sequentialDelayDomainOptionsEIP712Types: EIP712TypesWithPrimary = {
  */
 export type KnownDomain = SequentialDelayDomain
 
+/** io-ts schema for encoding and decoding domains of any standardized type */
+export const KnownDomainSchema: t.Type<KnownDomain> = SequentialDelayDomainSchema
+
 export function isKnownDomain(domain: Domain): domain is KnownDomain {
   return isSequentialDelayDomain(domain)
 }
@@ -148,6 +65,15 @@ export type KnownDomainOptions<
   D extends KnownDomain = KnownDomain
 > = D extends SequentialDelayDomain ? SequentialDelayDomainOptions : never
 
+/**
+ * Parameterized union type of currently implemented and standarized domain state structs. If the
+ * type parameter is specified to be a concrete Domain subtype, then only its associated
+ * Domain state type is selected and assignable to the parameterized type.
+ */
+export type KnownDomainState<D extends KnownDomain = KnownDomain> = D extends SequentialDelayDomain
+  ? SequentialDelayDomainState
+  : never
+
 export function domainEIP712Types(domain: KnownDomain): EIP712TypesWithPrimary {
   if (isSequentialDelayDomain(domain)) {
     return sequentialDelayDomainEIP712Types

packages/phone-number-privacy/common/src/domains/index.ts

@@ -0,0 +1,3 @@
+export * from './constants'
+export * from './domains'
+export * from './sequential-delay'