The Python Client SDK for Diem
Project description
The official Diem Client SDK for Python.
Pypi package
https://pypi.org/project/diem/
Examples
>>> from diem import jsonrpc, testnet
>>> client = jsonrpc.Client(testnet.JSON_RPC_URL)
>>> client.get_metadata()
version: 3300304
timestamp: 1601492912847973
chain_id: 2
You can find more examples under the examples
directory:
Note: make test
runs all examples too, see the Makefile for details.
Off-chain service example
Wallet Example: this is a highly simplified example of a wallet backend server implementation (no UI, no database, no un-related APIs) for demonstrating building off-chain API services through the Python SDK off-chain module.
To start the example as a local http server:
make init
source venv/bin/activate
make server
Example curl to hit the server (should get an error response):
curl -X POST -H "X-REQUEST-ID: 3185027f-0574-6f55-2668-3a38fdb5de98" -H "X-REQUEST-SENDER-ADDRESS: tdm1pacrzjajt6vuamzkswyd50e28pg77m6wylnc3spg3xj7r6" -d "invalid-jws-body" http://localhost:8080/v2/command
Build & Test
make init
make test
run specific test:
make test t=<test file / test name match pattern>
run with local docker testnet:
make test t=<test file / test name match pattern> dt=1
Re-generate diem_types, stdlib, jsonrpc response data structures
git submodule update --init diem
cd diem
git pull origin master
cd ..
make gen
``
## Modules Overview
> SPEC = specification
> DIP-X = Diem Improvement Protocol
Root module name: `diem`
Sub-modules:
- `jsonrpc`: diem JSON-RPC APIs client and API response types. [SPEC](https://github.com/diem/diem/blob/master/json-rpc/json-rpc-spec.md)
- `stdlib`: generated code, move stdlib script utils for constructing transaction script playload.
- `diem_types`: generated code, Diem on-chain data structure types for encoding and decoding [BCS](https://crates.io/crates/bcs) data.
- `utils`: utility functions, account address utils, currency code, hashing, hex encoding / decoding, transaction utils.
- `AuthKey` | `auth_key`: auth key utils
- `identifier`: Diem Account Identifier and Diem Intent Identifier. [DIP-5](https://dip.diem.com/dip-5/)
- `txnmetadata`: utils for creating peer to peer transaction metadata. [DIP-4](https://dip.diem.com/dip-4/)
- `testnet`: Testnet utility, minting coins, create Testnet client, chain id, Testnet JSON-RPC URL.
- `LocalAccount` | `local_account`: utility for managing local account keys, generate random local account.
- `chain_ids`: list of static chain ids
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
diem-1.2.5.tar.gz
(84.9 kB
view hashes)
Built Distribution
diem-1.2.5-py3-none-any.whl
(99.3 kB
view hashes)