Class SigningCoordinator<WalletMetadata, AccountMetadata>

Type Parameters

WalletMetadata extends {}
AccountMetadata extends {}

Hierarchy

SigningCoordinator

Implements

SigningCoordinatorConfirmationApi<WalletMetadata, AccountMetadata>
SigningCoordinatorSignApi<WalletMetadata, AccountMetadata>

Index

Constructors

constructor

new SigningCoordinator<WalletMetadata, AccountMetadata>(props: SigningCoordinatorProps, __namedParameters: SigningCoordinatorDependencies): SigningCoordinator<WalletMetadata, AccountMetadata>
Type Parameters
- WalletMetadata extends {}
- AccountMetadata extends {}
Parameters
- props: SigningCoordinatorProps
- __namedParameters: SigningCoordinatorDependencies
Returns SigningCoordinator<WalletMetadata, AccountMetadata>
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:80

Properties

`Private` `Readonly` #hwOptions

#hwOptions: TrezorConfig

`Private` `Readonly` #keyAgentFactory

#keyAgentFactory: {
    InMemory: ((props: InMemoryKeyAgentProps) => Promise<InMemoryKeyAgent>);
    Ledger: ((props: LedgerKeyAgentProps) => Promise<LedgerKeyAgent>);
    Trezor: ((props: TrezorKeyAgentProps) => Promise<TrezorKeyAgent>);
}

Type declaration

InMemory: ((props: InMemoryKeyAgentProps) => Promise<InMemoryKeyAgent>)
- - (props: InMemoryKeyAgentProps): Promise<InMemoryKeyAgent>
  - Parameters
    - props: InMemoryKeyAgentProps
    Returns Promise<InMemoryKeyAgent>
Ledger: ((props: LedgerKeyAgentProps) => Promise<LedgerKeyAgent>)
- - (props: LedgerKeyAgentProps): Promise<LedgerKeyAgent>
  - Parameters
    - props: LedgerKeyAgentProps
    Returns Promise<LedgerKeyAgent>
Trezor: ((props: TrezorKeyAgentProps) => Promise<TrezorKeyAgent>)
- - (props: TrezorKeyAgentProps): Promise<TrezorKeyAgent>
  - Parameters
    - props: TrezorKeyAgentProps
    Returns Promise<TrezorKeyAgent>

`Private` `Readonly` #logger

#logger: Logger

`Readonly` signDataRequest$

signDataRequest$: Subject<SignDataRequest<WalletMetadata, AccountMetadata>> = ...

`Readonly` transactionWitnessRequest$

transactionWitnessRequest$: Subject<TransactionWitnessRequest<WalletMetadata, AccountMetadata>> = ...

Methods

`Private` #createHardwareKeyAgent

#createHardwareKeyAgent(request: {
requestContext: RequestContext<WalletMetadata, AccountMetadata>;
walletType: WalletType;
}, account: Bip32WalletAccount<AccountMetadata>): Promise<KeyAgent>
Parameters
- request: {
  requestContext: RequestContext<WalletMetadata, AccountMetadata>;
  walletType: WalletType;
  }
  - requestContext: RequestContext<WalletMetadata, AccountMetadata>
  - walletType: WalletType
- account: Bip32WalletAccount<AccountMetadata>
Returns Promise<KeyAgent>
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:243

`Private` #createHardwareSignRequest

#createHardwareSignRequest<R, Req>(commonRequestProps: Omit<Req, "reject" | "sign">, account: Bip32WalletAccount<AccountMetadata>, sign: ((keyAgent: KeyAgent) => Promise<R>), resolve: ((result: R | Promise<R>) => void), reject: ((error: unknown) => void)): Req
Type Parameters
- R
- Req extends Object
Parameters
- commonRequestProps: Omit<Req, "reject" | "sign">
- account: Bip32WalletAccount<AccountMetadata>
- sign: ((keyAgent: KeyAgent) => Promise<R>)
  - - (keyAgent: KeyAgent): Promise<R>
    - Parameters
      
      keyAgent: KeyAgent
      
      Returns Promise<R>
- resolve: ((result: R | Promise<R>) => void)
  - - (result: R | Promise<R>): void
    - Parameters
      
      result: R | Promise<R>
      
      Returns void
- reject: ((error: unknown) => void)
  - - (error: unknown): void
    - Parameters
      
      error: unknown
      
      Returns void
Returns Req
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:217

`Private` #createInMemorySignRequest

#createInMemorySignRequest<R, Req>(commonRequestProps: Omit<Req, "reject" | "sign">, account: Bip32WalletAccount<AccountMetadata>, sign: ((keyAgent: KeyAgent) => Promise<R>), resolve: ((result: R | Promise<R>) => void), reject: ((error: unknown) => void)): Req
Type Parameters
- R
- Req extends Object
Parameters
- commonRequestProps: Omit<Req, "reject" | "sign">
- account: Bip32WalletAccount<AccountMetadata>
- sign: ((keyAgent: KeyAgent) => Promise<R>)
  - - (keyAgent: KeyAgent): Promise<R>
    - Parameters
      
      keyAgent: KeyAgent
      
      Returns Promise<R>
- resolve: ((result: R | Promise<R>) => void)
  - - (result: R | Promise<R>): void
    - Parameters
      
      result: R | Promise<R>
      
      Returns void
- reject: ((error: unknown) => void)
  - - (error: unknown): void
    - Parameters
      
      error: unknown
      
      Returns void
Returns Req
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:179

`Private` #findAccount

#findAccount(request: {
requestContext: RequestContext<WalletMetadata, AccountMetadata>;
}): undefined | Bip32WalletAccount<AccountMetadata>
Parameters
- request: {
  requestContext: RequestContext<WalletMetadata, AccountMetadata>;
  }
  - requestContext: RequestContext<WalletMetadata, AccountMetadata>
Returns undefined | Bip32WalletAccount<AccountMetadata>
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:172

`Private` #getTrezorConfig

#getTrezorConfig(wallet: AnyBip32Wallet<WalletMetadata, AccountMetadata>): TrezorConfig
Gets the appropriate TrezorConfig for the given wallet.

This allows wallets to specify only the properties they want to override (e.g., derivationType) while inheriting global settings (e.g., communicationType, manifest)
Parameters
- wallet: AnyBip32Wallet<WalletMetadata, AccountMetadata>
Returns TrezorConfig
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:92

`Private` #signRequest

#signRequest<R, Req>(emitter$: Subject<Req>, request: Omit<Req, "reject" | "sign">, sign: ((keyAgent: KeyAgent) => Promise<R>)): Promise<R>
Type Parameters
- R
- Req extends Object
Parameters
- emitter$: Subject<Req>
- request: Omit<Req, "reject" | "sign">
- sign: ((keyAgent: KeyAgent) => Promise<R>)
  - - (keyAgent: KeyAgent): Promise<R>
    - Parameters
      
      keyAgent: KeyAgent
      
      Returns Promise<R>
Returns Promise<R>
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:139

signData

signData(props: SignDataContext, requestContext: RequestContext<WalletMetadata, AccountMetadata>): Promise<Cip30DataSignature>
Parameters
- props: SignDataContext
- requestContext: RequestContext<WalletMetadata, AccountMetadata>
Returns Promise<Cip30DataSignature>
Implementation of SigningCoordinatorSignApi.signData
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:124

signTransaction

signTransaction(__namedParameters: SignTransactionProps, requestContext: RequestContext<WalletMetadata, AccountMetadata>): Promise<Signatures>
Parameters
- __namedParameters: SignTransactionProps
- requestContext: RequestContext<WalletMetadata, AccountMetadata>
Returns Promise<Signatures>
Implementation of SigningCoordinatorSignApi.signTransaction
- Defined in packages/web-extension/src/walletManager/SigningCoordinator/SigningCoordinator.ts:104

Class SigningCoordinator<WalletMetadata, AccountMetadata>

Type Parameters

WalletMetadata extends {}

AccountMetadata extends {}

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

WalletMetadata extends {}

AccountMetadata extends {}

Parameters

props: SigningCoordinatorProps

__namedParameters: SigningCoordinatorDependencies

Returns SigningCoordinator<WalletMetadata, AccountMetadata>

Properties

Private Readonly #hwOptions

Private Readonly #keyAgentFactory

Type declaration

InMemory: ((props: InMemoryKeyAgentProps) => Promise<InMemoryKeyAgent>)

Parameters

props: InMemoryKeyAgentProps

Returns Promise<InMemoryKeyAgent>

Ledger: ((props: LedgerKeyAgentProps) => Promise<LedgerKeyAgent>)

Parameters

props: LedgerKeyAgentProps

Returns Promise<LedgerKeyAgent>

Trezor: ((props: TrezorKeyAgentProps) => Promise<TrezorKeyAgent>)

Parameters

props: TrezorKeyAgentProps

Returns Promise<TrezorKeyAgent>

Private Readonly #logger

Readonly signDataRequest$

Readonly transactionWitnessRequest$

Methods

Private #createHardwareKeyAgent

Parameters

request: { requestContext: RequestContext<WalletMetadata, AccountMetadata>; walletType: WalletType; }

requestContext: RequestContext<WalletMetadata, AccountMetadata>

walletType: WalletType

account: Bip32WalletAccount<AccountMetadata>

Returns Promise<KeyAgent>

Private #createHardwareSignRequest

Type Parameters

R

Req extends Object

Parameters

commonRequestProps: Omit<Req, "reject" | "sign">

account: Bip32WalletAccount<AccountMetadata>

sign: ((keyAgent: KeyAgent) => Promise<R>)

Parameters

keyAgent: KeyAgent

Returns Promise<R>

resolve: ((result: R | Promise<R>) => void)

Parameters

result: R | Promise<R>

Returns void

reject: ((error: unknown) => void)

Parameters

error: unknown

Returns void

Returns Req

Private #createInMemorySignRequest

Type Parameters

R

Req extends Object

Parameters

commonRequestProps: Omit<Req, "reject" | "sign">

account: Bip32WalletAccount<AccountMetadata>

sign: ((keyAgent: KeyAgent) => Promise<R>)

Parameters

keyAgent: KeyAgent

Returns Promise<R>

resolve: ((result: R | Promise<R>) => void)

Parameters

result: R | Promise<R>

`Private` `Readonly` #hwOptions

`Private` `Readonly` #keyAgentFactory

`Private` `Readonly` #logger

`Readonly` signDataRequest$

`Readonly` transactionWitnessRequest$

`Private` #createHardwareKeyAgent

request: {
requestContext: RequestContext<WalletMetadata, AccountMetadata>;
walletType: WalletType;
}

`Private` #createHardwareSignRequest

`Private` #createInMemorySignRequest

`Private` #findAccount

request: {
requestContext: RequestContext<WalletMetadata, AccountMetadata>;
}

`Private` #getTrezorConfig

`Private` #signRequest