diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-04-18 17:19:27 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-18 17:19:27 +0800 |
| commit | f6f2991a442da156a3dbdeca84683a6c9f46d0e1 (patch) | |
| tree | 4951024bfba56d5c3268556c4d4e2ca0ab4f6d17 /packages/subproviders | |
| parent | 823f2db09fba8f19806ba3fa4bd679e12a58be3f (diff) | |
| parent | 4ea222bbffd7a378712320a2f366d5bbee5920af (diff) | |
| download | dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.gz dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.bz2 dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.lz dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.xz dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.zst dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.zip | |
Merge pull request #535 from 0xProject/fix/commentRendering
Docs: Fix Type Comment Rendering
Diffstat (limited to 'packages/subproviders')
| -rw-r--r-- | packages/subproviders/src/types.ts | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts index 74ecec23b..30a3b4a4e 100644 --- a/packages/subproviders/src/types.ts +++ b/packages/subproviders/src/types.ts @@ -6,7 +6,8 @@ export interface LedgerCommunicationClient { close: () => Promise<void>; } -/* +/** + * Elliptic Curve signature * The LedgerEthereumClient sends Ethereum-specific requests to the Ledger Nano S * It uses an internal LedgerCommunicationClient to relay these requests. Currently * NodeJs and Browser communication are supported. @@ -32,7 +33,7 @@ export interface ECSignatureString { export type LedgerEthereumClientFactoryAsync = () => Promise<LedgerEthereumClient>; -/* +/** * networkId: The ethereum networkId to set as the chainId from EIP155 * ledgerConnectionType: Environment in which you wish to connect to Ledger (nodejs or browser) * derivationPath: Initial derivation path to use e.g 44'/60'/0' @@ -45,7 +46,7 @@ export interface LedgerSubproviderConfigs { accountFetchingConfigs?: AccountFetchingConfigs; } -/* +/** * addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 * numAddressesToReturn: Number of addresses to return from 'eth_accounts' call * shouldAskForOnDeviceConfirmation: Whether you wish to prompt the user on their Ledger @@ -57,7 +58,7 @@ export interface AccountFetchingConfigs { shouldAskForOnDeviceConfirmation?: boolean; } -/* +/** * mnemonic: The string mnemonic seed * addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 * baseDerivationPath: The base derivation path (e.g 44'/60'/0'/0) |