Skip to content

Commit a87c92b

Browse files
committed
Document authentication methods
1 parent eec5f95 commit a87c92b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ pip install afp-sdk
1818
See [afp.autonity.org](https://afp.autonity.org/) for the Autonomous Futures Protocol
1919
documentation, including the Python SDK reference.
2020

21+
## Authentication
22+
23+
The SDK supports 3 methods for authenticating with AutEx and signing blockchain
24+
transactions.
25+
26+
- **Private key:** Use an Autonity account's private key as a hex-string with `0x`
27+
prefix.
28+
- **Key file:** Use a [Geth / Clef](https://geth.ethereum.org/docs/fundamentals/account-management)
29+
key file.
30+
- **Trezor device:** Use a [Trezor](https://trezor.io/) hardware wallet. The derivation
31+
path of an Ethereum account needs to be specified, which can be found in the Account
32+
Settings in the Trezor Suite.
33+
2134
## Overview
2235

2336
The `afp` package consists of the following:

0 commit comments

Comments
 (0)