@ledgerhq/hw-app-xrp 6.3.0 → 6.11.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 +25 -25
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -13,17 +13,17 @@ Ledger Hardware Wallet XRP JavaScript bindings.
|
|
|
13
13
|
|
|
14
14
|
#### Table of Contents
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
16
|
+
* [Xrp](#xrp)
|
|
17
|
+
* [Parameters](#parameters)
|
|
18
|
+
* [Examples](#examples)
|
|
19
|
+
* [getAddress](#getaddress)
|
|
20
|
+
* [Parameters](#parameters-1)
|
|
21
|
+
* [Examples](#examples-1)
|
|
22
|
+
* [signTransaction](#signtransaction)
|
|
23
|
+
* [Parameters](#parameters-2)
|
|
24
|
+
* [Examples](#examples-2)
|
|
25
|
+
* [getAppConfiguration](#getappconfiguration)
|
|
26
|
+
* [Examples](#examples-3)
|
|
27
27
|
|
|
28
28
|
### Xrp
|
|
29
29
|
|
|
@@ -31,8 +31,8 @@ XRP API
|
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
* `transport` **Transport**
|
|
35
|
+
* `scrambleKey` (optional, default `"XRP"`)
|
|
36
36
|
|
|
37
37
|
#### Examples
|
|
38
38
|
|
|
@@ -86,10 +86,10 @@ get XRP address for a given BIP 32 path.
|
|
|
86
86
|
|
|
87
87
|
##### Parameters
|
|
88
88
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
89
|
+
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP 32 format
|
|
90
|
+
* `display` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the display
|
|
91
|
+
* `chainCode` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the chainCode request
|
|
92
|
+
* `ed25519` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the ed25519 curve (secp256k1 is default)
|
|
93
93
|
|
|
94
94
|
##### Examples
|
|
95
95
|
|
|
@@ -98,7 +98,7 @@ const result = await xrp.getAddress("44'/144'/0'/0/0");
|
|
|
98
98
|
const { publicKey, address } = result;
|
|
99
99
|
```
|
|
100
100
|
|
|
101
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
101
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{publicKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), address: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), chainCode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}>** an object with a publicKey, address and (optionally) chainCode
|
|
102
102
|
|
|
103
103
|
#### signTransaction
|
|
104
104
|
|
|
@@ -109,11 +109,11 @@ hex.
|
|
|
109
109
|
|
|
110
110
|
##### Parameters
|
|
111
111
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
112
|
+
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP 32 format
|
|
113
|
+
* `rawTxHex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a raw hex string representing a serialized transaction blob.
|
|
114
|
+
This parameter can be encoded using [ripple-binary-codec](https://www.npmjs.com/package/ripple-binary-codec).
|
|
115
|
+
See <https://xrpl.org/serialization.html> for more documentation on the serialization format.
|
|
116
|
+
* `ed25519` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the ed25519 curve (secp256k1 is default)
|
|
117
117
|
|
|
118
118
|
##### Examples
|
|
119
119
|
|
|
@@ -121,7 +121,7 @@ hex.
|
|
|
121
121
|
const signature = await xrp.signTransaction("44'/144'/0'/0/0", "12000022800000002400000002614000000001315D3468400000000000000C73210324E5F600B52BB3D9246D49C4AB1722BA7F32B7A3E4F9F2B8A1A28B9118CC36C48114F31B152151B6F42C1D61FE4139D34B424C8647D183142ECFC1831F6E979C6DA907E88B1CAD602DB59E2F");
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
124
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** a signature as hex string
|
|
125
125
|
|
|
126
126
|
#### getAppConfiguration
|
|
127
127
|
|
|
@@ -137,4 +137,4 @@ const result = await xrp.getAppConfiguration();
|
|
|
137
137
|
}
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
140
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{version: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** an object with a version
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ledgerhq/hw-app-xrp",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.11.0",
|
|
4
4
|
"description": "Ledger Hardware Wallet Ripple Application API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Ledger",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"types": "lib/Xrp.d.ts",
|
|
28
28
|
"license": "Apache-2.0",
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@ledgerhq/hw-transport": "^6.
|
|
30
|
+
"@ledgerhq/hw-transport": "^6.11.0",
|
|
31
31
|
"bip32-path": "0.4.2"
|
|
32
32
|
},
|
|
33
33
|
"scripts": {
|
|
@@ -36,5 +36,5 @@
|
|
|
36
36
|
"watch": "bash ../../script/watch.sh",
|
|
37
37
|
"doc": "bash ../../script/doc.sh"
|
|
38
38
|
},
|
|
39
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "12801b340a115759383d9afc4d5c73b1789722b6"
|
|
40
40
|
}
|