ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-06 17:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1019 from ripple/secure-sign-add-py

Browse Source 
Add xrpl-py to list of client libraries in secure sign tutorial
This commit is contained in:
Rome Reginelli
2021-04-08 16:36:42 -07:00
committed by GitHub
parent 44781969eb e55744a624
commit 1ed5de6514
2 changed files with 30 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/_code-samples/secure-signing/py/sign-payment.py
View File

@@ -1,14 +1,14 @@
# Define signer address
import os
my_secret = os.getenv("MY_SECRET")
my_secret = os.getenv("MYSECRET")
from xrpl.wallet import Wallet
wallet = Wallet(seed="MY_SECRET")
wallet = Wallet(seed="MYSECRET", sequence=16237283)
print(wallet.classic_address) # "raaFKKmgf6CRZttTVABeTcsqzRQ51bNR6Q"
from xrpl.models.transactions import Payment
from xrpl.utils import xrp_to_drops
my_payment = Payment(
account=test_wallet_1.classic_address,
account=wallet.classic_address,
amount=xrp_to_drops(22),
fee="10",
destination="rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
@@ -18,5 +18,5 @@ print("Payment object:", my_payment)
# Sign transaction -------------------------------------------------------------
import xrpl.transaction
signed = xrpl.transaction.safe_sign_transaction(my_payment, test_wallet_1)
signed = xrpl.transaction.safe_sign_transaction(my_payment, wallet)
print("Signed transaction blob:", signed)

38
content/tutorials/get-started/set-up-secure-signing.md
View File

@@ -62,21 +62,38 @@ As always, follow industry-standard practices for securing your machines, such a
{{ include_svg("img/secure-signing-client-library.svg", "Diagram of using a client library with local signing") }}
This configuration uses a client library in the programming language you are using to sign transactions locally. You need a client library for the programming language you use. Ripple publishes the following client libraries that can sign transactions for the XRP Ledger locally:
This configuration uses a client library in the programming language you are using to sign transactions locally. You need a client library for the programming language you use. The following client libraries can sign transactions for the XRP Ledger locally:
- **RippleAPI (ripple-lib) for JavaScript**
- [Setup](get-started-with-rippleapi-for-javascript.html)
- [API Reference](rippleapi-reference.html)
- **Signing Library for C++** (included with `rippled`)
- [Documentation](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library)
| Language | Library Name | Get Started | API Reference | Source Code |
|----------|--------------|-------------|---------------|-------------|
| **Python** | `xrpl-py` | [Get Started](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) |
| **JavaScript** / **TypeScript** | `ripple-lib` | [Get Started](get-started-with-rippleapi-for-javascript.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) |
| **C++** | `rippled` Signing Library | [Get Started](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library) | | (Part of [`rippled`](https://github.com/ripple/rippled/)) |
| **Java** | `xrpl4j` | [README](https://github.com/XRPLF/xrpl4j#readme) | [API Reference](https://github.com/XRPLF/xrpl4j/tree/main/xrpl4j-integration-tests) | [Repo](https://github.com/XRPLF/xrpl4j) |
If you use a client library not published by Ripple, make sure it uses proper, secure implementations of the signing algorithm(s) it implements. (For example, if it uses the default ECDSA algorithm, it should also use deterministic nonces as described in [RFC-6979](https://tools.ietf.org/html/rfc6979).) All of Ripple's published libraries listed above follow industry best practices.
For best security, be sure to keep your client library updated to the latest stable version.
### Security Best Practices for Signing Libraries
To optimize the security of your signing library:
* Make sure the signing library you use has properly and securely implemented its signing algorithm(s). For example, if the library uses the default ECDSA algorithm, it should also use deterministic nonces as described in [RFC-6979](https://tools.ietf.org/html/rfc6979).
All of the published libraries listed above follow industry best practices.
* Keep your client library updated to the latest stable version.
* For enhanced security, you can load your secret keys from a management tool such as [Vault](https://www.vaultproject.io/).
### Local Signing Example
The following code sample shows how to sign transaction instructions locally with [`ripple-lib`](https://github.com/ripple/ripple-lib) for JavaScript and [`xrpl-py`](https://github.com/XRPLF/xrpl-py) for Python:
Here are examples of how to sign transaction instructions locally using the following languages and libraries:
* **JavaScript** / **TypeScript** - [`ripple-lib`](https://github.com/ripple/ripple-lib)
* **Python** - [`xrpl-py`](https://github.com/XRPLF/xrpl-py)
<!-- MULTICODE_BLOCK_START -->
@@ -95,9 +112,6 @@ The following code sample shows how to sign transaction instructions locally wit
<!-- MULTICODE_BLOCK_END -->
For greater security, you can load your secret keys from a management tool such as [Vault](https://www.vaultproject.io/).
## Use a Dedicated Signing Device
{{ include_svg("img/secure-signing-dedicated-hardware.svg", "Diagram of using dedicated signing hardware") }}