@ledgerhq/revault-api 1.71.0 → 1.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -9
- package/lib/{app-lib-DwyMsZ-w.d.mts → app-lib-DZpVkmLE.d.mts} +2539 -2298
- package/lib/fakes.d.mts +1 -1
- package/lib/index.d.mts +2 -2
- package/lib/index.mjs +56 -1
- package/lib/index.mjs.map +1 -0
- package/lib/internal/app-lib.d.mts +198 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,27 +1,24 @@
|
|
|
1
1
|
# revault-api
|
|
2
2
|
|
|
3
|
-
Library that exposes types
|
|
3
|
+
Library that exposes types and data-generators for the `revault` ecosystem.
|
|
4
4
|
|
|
5
|
-
> 📖
|
|
6
|
-
> please check [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
5
|
+
> 📖 For internal developer instructions, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
7
6
|
|
|
8
7
|
## Installation
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
```
|
|
9
|
+
```bash
|
|
13
10
|
pnpm add @ledgerhq/revault-api
|
|
14
11
|
```
|
|
15
12
|
|
|
16
13
|
## Usage
|
|
17
14
|
|
|
18
|
-
|
|
15
|
+
Import available types from the package root:
|
|
19
16
|
|
|
20
17
|
```ts
|
|
21
18
|
import { AccountResponse, VaultRequestResponse } from "@ledgerhq/revault-api";
|
|
22
19
|
```
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
Import data-generation helpers from the `/fakes` module:
|
|
25
22
|
|
|
26
23
|
```ts
|
|
27
24
|
import { genAccountResponse } from "@ledgerhq/revault-api/fakes";
|
|
@@ -29,4 +26,4 @@ import { genAccountResponse } from "@ledgerhq/revault-api/fakes";
|
|
|
29
26
|
const fakeAccount = genAccountResponse();
|
|
30
27
|
```
|
|
31
28
|
|
|
32
|
-
For
|
|
29
|
+
For the full API reference, see the [Documentation](https://ledgerhq.github.io/revault/).
|