Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasbrugneaux committed Jan 24, 2025
1 parent 64eff2d commit 32f514f
Show file tree
Hide file tree
Showing 5 changed files with 356 additions and 21 deletions.
1 change: 1 addition & 0 deletions docs/sdk/wallet-ledger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@
- [ledger-signer](modules/ledger_signer.md)
- [ledger-utils](modules/ledger_utils.md)
- [ledger-wallet](modules/ledger_wallet.md)
- [test-utils](modules/test_utils.md)
- [tokens](modules/tokens.md)
13 changes: 7 additions & 6 deletions docs/sdk/wallet-ledger/classes/ledger_signer.LedgerSigner.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Signs the EVM transaction with a Ledger device
| `derivationPath` | `string` |
| `ledgerAddressValidation` | [`AddressValidation`](../enums/ledger_wallet.AddressValidation.md) |
| `appConfiguration` | `Object` |
| `appConfiguration.appName` | `string` |
| `appConfiguration.arbitraryDataEnabled` | `number` |
| `appConfiguration.version` | `string` |

Expand Down Expand Up @@ -72,7 +73,7 @@ Signer.computeSharedSecret

#### Defined in

[wallet-ledger/src/ledger-signer.ts:207](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L207)
[wallet-ledger/src/ledger-signer.ts:212](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L212)

___

Expand All @@ -96,7 +97,7 @@ Signer.decrypt

#### Defined in

[wallet-ledger/src/ledger-signer.ts:201](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L201)
[wallet-ledger/src/ledger-signer.ts:206](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L206)

___

Expand All @@ -114,7 +115,7 @@ Signer.getNativeKey

#### Defined in

[wallet-ledger/src/ledger-signer.ts:41](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L41)
[wallet-ledger/src/ledger-signer.ts:42](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L42)

___

Expand All @@ -138,7 +139,7 @@ Signer.signPersonalMessage

#### Defined in

[wallet-ledger/src/ledger-signer.ts:96](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L96)
[wallet-ledger/src/ledger-signer.ts:97](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L97)

___

Expand All @@ -163,7 +164,7 @@ Signer.signTransaction

#### Defined in

[wallet-ledger/src/ledger-signer.ts:45](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L45)
[wallet-ledger/src/ledger-signer.ts:46](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L46)

___

Expand All @@ -187,4 +188,4 @@ Signer.signTypedData

#### Defined in

[wallet-ledger/src/ledger-signer.ts:116](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L116)
[wallet-ledger/src/ledger-signer.ts:117](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/ledger-signer.ts#L117)
230 changes: 230 additions & 0 deletions docs/sdk/wallet-ledger/classes/test_utils.TestLedger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
[@celo/wallet-ledger](../README.md) / [test-utils](../modules/test_utils.md) / TestLedger

# Class: TestLedger

[test-utils](../modules/test_utils.md).TestLedger

## Table of contents

### Constructors

- [constructor](test_utils.TestLedger.md#constructor)

### Properties

- [config](test_utils.TestLedger.md#config)
- [isMock](test_utils.TestLedger.md#ismock)
- [mockForceValidation](test_utils.TestLedger.md#mockforcevalidation)
- [transport](test_utils.TestLedger.md#transport)

### Methods

- [getAddress](test_utils.TestLedger.md#getaddress)
- [getAppConfiguration](test_utils.TestLedger.md#getappconfiguration)
- [getName](test_utils.TestLedger.md#getname)
- [provideERC20TokenInformation](test_utils.TestLedger.md#provideerc20tokeninformation)
- [signEIP712HashedMessage](test_utils.TestLedger.md#signeip712hashedmessage)
- [signPersonalMessage](test_utils.TestLedger.md#signpersonalmessage)
- [signTransaction](test_utils.TestLedger.md#signtransaction)

## Constructors

### constructor

**new TestLedger**(`mockForceValidation`, `config?`): [`TestLedger`](test_utils.TestLedger.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `mockForceValidation` | () => `void` |
| `config?` | `Config` |

#### Returns

[`TestLedger`](test_utils.TestLedger.md)

#### Defined in

[wallet-ledger/src/test-utils.ts:113](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L113)

## Properties

### config

`Optional` `Readonly` **config**: `Config`

#### Defined in

[wallet-ledger/src/test-utils.ts:113](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L113)

___

### isMock

**isMock**: `boolean` = `true`

#### Defined in

[wallet-ledger/src/test-utils.ts:110](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L110)

___

### mockForceValidation

`Readonly` **mockForceValidation**: () => `void`

#### Type declaration

▸ (): `void`

##### Returns

`void`

#### Defined in

[wallet-ledger/src/test-utils.ts:113](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L113)

___

### transport

**transport**: `default`

#### Defined in

[wallet-ledger/src/test-utils.ts:111](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L111)

## Methods

### getAddress

**getAddress**(`derivationPath`, `forceValidation?`): `Promise`\<\{ `address`: `string` = ''; `derivationPath`: `string` ; `publicKey`: `string` = '' }\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `derivationPath` | `string` |
| `forceValidation?` | `boolean` |

#### Returns

`Promise`\<\{ `address`: `string` = ''; `derivationPath`: `string` ; `publicKey`: `string` = '' }\>

#### Defined in

[wallet-ledger/src/test-utils.ts:142](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L142)

___

### getAppConfiguration

**getAppConfiguration**(): `Promise`\<\{ `arbitraryDataEnabled`: `number` ; `erc20ProvisioningNecessary`: `number` ; `starkEnabled`: `number` ; `starkv2Supported`: `number` ; `version`: `string` }\>

#### Returns

`Promise`\<\{ `arbitraryDataEnabled`: `number` ; `erc20ProvisioningNecessary`: `number` ; `starkEnabled`: `number` ; `starkv2Supported`: `number` ; `version`: `string` }\>

#### Defined in

[wallet-ledger/src/test-utils.ts:132](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L132)

___

### getName

**getName**(): `undefined` \| `string`

#### Returns

`undefined` \| `string`

#### Defined in

[wallet-ledger/src/test-utils.ts:128](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L128)

___

### provideERC20TokenInformation

**provideERC20TokenInformation**(`tokenData`): `Promise`\<``true``\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `tokenData` | `string` |

#### Returns

`Promise`\<``true``\>

#### Defined in

[wallet-ledger/src/test-utils.ts:211](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L211)

___

### signEIP712HashedMessage

**signEIP712HashedMessage**(`derivationPath`, `_domainSeparator`, `_structHash`): `Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `number` }\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `derivationPath` | `string` |
| `_domainSeparator` | `string` |
| `_structHash` | `string` |

#### Returns

`Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `number` }\>

#### Defined in

[wallet-ledger/src/test-utils.ts:194](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L194)

___

### signPersonalMessage

**signPersonalMessage**(`derivationPath`, `data`): `Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `number` }\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `derivationPath` | `string` |
| `data` | `string` |

#### Returns

`Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `number` }\>

#### Defined in

[wallet-ledger/src/test-utils.ts:177](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L177)

___

### signTransaction

**signTransaction**(`derivationPath`, `data`): `Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `string` }\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `derivationPath` | `string` |
| `data` | `string` |

#### Returns

`Promise`\<\{ `r`: `string` ; `s`: `string` ; `v`: `string` }\>

#### Defined in

[wallet-ledger/src/test-utils.ts:160](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/wallets/wallet-ledger/src/test-utils.ts#L160)
Loading

0 comments on commit 32f514f

Please sign in to comment.