feat(web-extension): wip signer manager

Author: mkazlauskas

packages/web-extension/src/walletManager/SignerManager/KeyAgentFactory.ts

@@ -0,0 +1,29 @@
+import { Bip32WalletAccount, WalletType } from '../types';
+import { InMemoryKeyAgent, KeyAgentDependencies } from '@cardano-sdk/key-management';
+import { NotImplementedError } from '@cardano-sdk/core';
+import { RequestContext } from './types';
+
+/** Create and initialize key agent. Connects to hardware device. */
+export const createKeyAgent = <Metadata extends {}>(
+  { chainId, wallet }: Omit<RequestContext<Metadata>, 'origin'>,
+  { accountIndex }: Pick<Bip32WalletAccount<Metadata>, 'accountIndex'>,
+  dependencies: KeyAgentDependencies
+) => {
+  // TODO
+  // eslint-disable-next-line sonarjs/no-small-switch
+  switch (wallet.type) {
+    case WalletType.InMemory:
+      return new InMemoryKeyAgent(
+        {
+          accountIndex,
+          chainId,
+          encryptedRootPrivateKeyBytes: [...Buffer.from(wallet.encryptedSecrets.rootPrivateKeyBytes, 'hex')],
+          extendedAccountPublicKey: wallet.extendedAccountPublicKey,
+          getPassphrase: async () => new Uint8Array()
+        },
+        dependencies
+      );
+    default:
+      throw new NotImplementedError(`Unknown wallet type: ${wallet.type}`);
+  }
+};

packages/web-extension/src/walletManager/SignerManager/SignerManager.ts

@@ -0,0 +1,41 @@
+/* eslint-disable brace-style */
+import { Cardano, TxCBOR } from '@cardano-sdk/core';
+import { Cip30DataSignature } from '@cardano-sdk/dapp-connector';
+import { Observable } from 'rxjs';
+import {
+  RequestContext,
+  SignDataProps,
+  SignDataRequest,
+  SignerManagerConfirmationApi,
+  SignerManagerSignApi,
+  TransactionWitnessRequest
+} from './types';
+import { SignTransactionOptions } from '@cardano-sdk/key-management';
+
+export class SignerManager<WalletMetadata extends {}>
+  implements SignerManagerConfirmationApi<WalletMetadata>, SignerManagerSignApi<WalletMetadata>
+{
+  transactionWitnessRequest$: Observable<TransactionWitnessRequest<WalletMetadata>>;
+  signDataRequest$: Observable<SignDataRequest<WalletMetadata>>;
+
+  signTransaction(
+    tx: TxCBOR,
+    options: SignTransactionOptions,
+    context: RequestContext<WalletMetadata>
+  ): Promise<Cardano.Signatures> {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    tx;
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    options;
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    context;
+    throw new Error('Method not implemented.');
+  }
+  signData(props: SignDataProps, context: RequestContext<WalletMetadata>): Promise<Cip30DataSignature> {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    props;
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    context;
+    throw new Error('Method not implemented.');
+  }
+}

packages/web-extension/src/walletManager/SignerManager/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './SignerManager';

packages/web-extension/src/walletManager/SignerManager/types.ts

@@ -0,0 +1,53 @@
+import { AccountId, AnyBip32Wallet, WalletType } from '../types';
+import { Cardano, Serialization, TxCBOR } from '@cardano-sdk/core';
+import { Cip30DataSignature, Origin } from '@cardano-sdk/dapp-connector';
+import { Observable } from 'rxjs';
+import { SignTransactionOptions, cip8 } from '@cardano-sdk/key-management';
+
+type RequestBase<WalletMetadata extends {}> = {
+  origin: Origin;
+  wallet: AnyBip32Wallet<WalletMetadata>;
+  reject(reason: string): Promise<void>;
+};
+
+type SignRequestInMemory = {
+  walletType: WalletType.InMemory;
+  sign(passphrase: Uint8Array): Promise<void>;
+};
+
+type SignRequestHardware = {
+  walletType: WalletType.Trezor | WalletType.Ledger;
+  /** Must be called from user gesture when running in web environments */
+  sign(): Promise<void>;
+};
+
+export type TransactionWitnessRequest<WalletMetadata extends {}> = RequestBase<WalletMetadata> & {
+  transaction: Serialization.Transaction;
+} & (SignRequestHardware | SignRequestInMemory);
+
+export type SignDataProps = Omit<cip8.Cip30SignDataRequest, 'witnesser' | 'addressManager'>;
+
+export type SignDataRequest<WalletMetadata extends {}> = RequestBase<WalletMetadata> &
+  SignDataProps &
+  (SignRequestHardware | SignRequestInMemory);
+
+export type RequestContext<WalletMetadata extends {}> = {
+  origin: Origin;
+  wallet: AnyBip32Wallet<WalletMetadata>;
+  accountId: AccountId;
+  chainId: Cardano.ChainId;
+};
+
+export interface SignerManagerConfirmationApi<WalletMetadata extends {}> {
+  transactionWitnessRequest$: Observable<TransactionWitnessRequest<WalletMetadata>>;
+  signDataRequest$: Observable<SignDataRequest<WalletMetadata>>;
+}
+
+export interface SignerManagerSignApi<WalletMetadata extends {}> {
+  signTransaction(
+    tx: TxCBOR,
+    options: SignTransactionOptions,
+    context: RequestContext<WalletMetadata>
+  ): Promise<Cardano.Signatures>;
+  signData(props: SignDataProps, context: RequestContext<WalletMetadata>): Promise<Cip30DataSignature>;
+}

packages/web-extension/src/walletManager/index.ts

@@ -3,5 +3,6 @@ export * from './util';
 export * from './walletManagerUi';
 export * from './walletManagerWorker';
 export * from './WalletRepository';
+export * from './SignerManager';
 export * from './errors';
 export * from './types';

packages/web-extension/src/walletManager/types.ts

@@ -41,6 +41,8 @@ export type InMemoryWallet<Metadata extends {}> = Bip32Wallet<Metadata> & {
   };
 };
 
+export type AnyBip32Wallet<WalletMetadata extends {}> = HardwareWallet<WalletMetadata> | InMemoryWallet<WalletMetadata>;
+
 export type OwnSignerAccount = {
   walletId: WalletId;
   accountId: AccountId;

packages/web-extension/test/walletManager/SignerManager.test.ts

@@ -0,0 +1,14 @@
+import { SignerManager } from '../../src';
+
+describe('SignerManager', () => {
+  let signerManager: SignerManager<{}>;
+
+  beforeEach(() => {
+    signerManager = new SignerManager();
+    // TODO
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    signerManager;
+  });
+
+  it.todo('todo');
+});