Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

1. Python SDK page updated. #1431

Merged
merged 18 commits into from
Apr 18, 2024
Merged

1. Python SDK page updated. #1431

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
cebd0b3
1. Python SDK page updated.
asladeofgreen Apr 16, 2024
9e9477b
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
2f7757d
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
83505bd
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
f5fbe3c
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
95cbb6a
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
5bab2ff
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
e91632b
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
20f7e17
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
e1a58f7
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
c8f296f
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
4f30b5a
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
f1b5c53
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
7ea2e78
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
80ccd30
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
c040b5e
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
a45f24b
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
f381943
Update source/docs/casper/developers/dapps/sdk/python-sdk.md
asladeofgreen Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
231 changes: 24 additions & 207 deletions source/docs/casper/developers/dapps/sdk/python-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,236 +1,53 @@
# Python SDK

The [Python SDK](https://github.com/casper-network/casper-python-sdk) allows developers to interact with the Casper Node using Python 3.9+. This page covers various examples of using this SDK.
The [Python SDK](https://github.com/casper-network/casper-python-sdk) allows developers to interact with the Casper platform using Python 3.12+.

## Installation

To install the library, run:

```bash

pip3 install pycspr
```

## Tests

You can find examples of testing this library with python scripts in the `test` directory. To run the tests, we recommend the *pytest* library:

```bash
pytest ./tests
```

## Usage Examples

In this section, we outline a couple of essential tasks you can accomplish with the Python SDK:

* [Sending a transfer](#sending-a-transfer) between two purses
* [Staking](#staking) tokens with a validator

For further examples, take a look at the [How-tos](https://github.com/casper-network/casper-python-sdk/tree/main/how_tos).

### Sending a transfer

This example shows you how to define and transfer funds between purses on a Casper network. Replace the *path_to_cp2_account_key* in the code below with the receiver's account public key.

```python
import os
import pathlib
import random
import typing

import pycspr
from pycspr.client import NodeClient
from pycspr.client import NodeConnectionInfo
from pycspr.crypto import KeyAlgorithm
from pycspr.types import PrivateKey
from pycspr.types import Deploy
from pycspr.types import PublicKey

# path to cp1 secret key - defaults to NCTL user 1.
path_to_cp1_secret_key = pathlib.Path(os.getenv("NCTL")) / "assets" / "net-1" / "users" / "user-1" / "secret_key.pem"

# type of cp1 secret key - defaults to ED25519.
type_of_cp1_secret_key = KeyAlgorithm.ED25519.name,

# path to cp2 account key - defaults to NCTL user 2.
path_to_cp2_account_key = pathlib.Path(os.getenv("NCTL")) / "assets" / "net-1" / "users" / "user-2" / "public_key_hex"

# name of target chain - defaults to NCTL chain.
chain_name = "casper-net-1"

# host address of target node - defaults to NCTL node 1.
node_host = "localhost"

# Node API JSON-RPC port - defaults to 11101 @ NCTL node 1.
node_port_rpc = 11101

def _main(node_host, node_port_rpc, path_to_cp1_secret_key, type_of_cp1_secret_key,path_to_cp2_account_key, chain_name):
"""Main entry point.
:param args: Parsed command line arguments.
"""
# Set node client.
client = _get_client(node_host, node_port_rpc)

# Set counter-parties.
cp1, cp2 = _get_counter_parties(path_to_cp1_secret_key, type_of_cp1_secret_key,path_to_cp2_account_key)

# Set deploy.
deploy: Deploy = _get_deploy(chain_name, cp1, cp2)

# Approve deploy.
deploy.approve(cp1)

# Dispatch deploy to a node.
client.deploys.send(deploy)

#If deploy is successful send the indication
print(f"Deploy dispatched to node [{node_host}]: {deploy.hash.hex()}")


def _get_client(node_host, node_port_rpc) -> NodeClient:
"""Returns a pycspr client instance.
"""
return NodeClient(NodeConnectionInfo(
host=node_host,
port_rpc=node_port_rpc,
))


def _get_counter_parties(path_to_cp1_secret_key, type_of_cp1_secret_key,path_to_cp2_account_key) -> typing.Tuple[PrivateKey, PublicKey]:
"""Returns the 2 counter-parties participating in the transfer.
"""
cp1 = pycspr.parse_private_key(
path_to_cp1_secret_key,
type_of_cp1_secret_key,
)
cp2 = pycspr.parse_public_key(
path_to_cp2_account_key
)

return cp1, cp2


def _get_deploy(chain_name, cp1: PrivateKey, cp2: PublicKey) -> Deploy:
"""Returns transfer deploy to be dispatched to a node.
"""
# Set standard deploy parameters.
deploy_params = pycspr.create_deploy_parameters(
account = cp1,
chain_name = chain_name
)

# Set deploy.
deploy = pycspr.create_native_transfer(
params = deploy_params,
amount = int(2.5e9),
target = cp2.account_hash,
correlation_id = random.randint(1, 1e6)
)

return deploy


# Entry point.
if __name__ == '__main__':
_main(node_host, node_port_rpc, path_to_cp1_secret_key, type_of_cp1_secret_key, path_to_cp2_account_key, chain_name)
pip3 install pycspr
```

### Staking

This example shows you how to define and stake funds with a validator.
## How To's

```python
The following set of How To's cover the full SDK feature set & are designed to be run against a [CCTL](https://github.com/casper-network/cctl) network.
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

import os
import pathlib
### Cryptography

import pycspr
from pycspr.client import NodeClient
from pycspr.client import NodeConnectionInfo
from pycspr.crypto import KeyAlgorithm
from pycspr.types import Deploy
from pycspr.types import PrivateKey
* [How To: Apply a checksum ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/crypto/how_to_apply_a_checksum.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# path to cp1 secret key - defaults to NCTL user 1.
path_to_validator_secret_key = pathlib.Path(os.getenv("NCTL")) / "assets" / "net-1" / "users" / "user-1" / "secret_key.pem"
* [How To: Create Key Pairs ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/crypto/how_to_create_key_pairs.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# type of cp1 secret key - defaults to ED25519.
type_of_validator_secret_key = KeyAlgorithm.ED25519.name
* [How To: Hash data ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/crypto/how_to_hash_data.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# path to session code wasm binary - defaults to NCTL bin/eco/add_bid.wasm.
path_to_wasm = pathlib.Path(os.getenv("NCTL")) / "assets" / "net-1" / "bin" / "auction" / "add_bid.wasm"
* [How To: Sign data ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/crypto/how_to_sign_data.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# amount to stake, i.e. bond, into the network.
amount = int(2.5e9)
### Deploys

# amount to charge delegators for service provision.
delegation_rate = 2
* [How To: Transfer funds between 2 accounts ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/deploys/how_to_transfer.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# name of target chain - defaults to NCTL chain.
chain_name = "casper-net-1"
* [How To: Delegate funds to a validator ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/deploys/how_to_delegate.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# host address of target node - defaults to NCTL node 1.
node_host = "localhost"
* [How To: Undelegate funds from a validator ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/deploys/how_to_undelegate.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# Node API JSON-RPC port - defaults to 11101 @ NCTL node 1.
node_port_rpc = 11101
* [How To: Stake funds as a validator ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/deploys/how_to_stake.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

def _main(node_host, node_port_rpc, path_to_validator_secret_key, type_of_validator_secret_key, chain_name, amount, delegation_rate, path_to_wasm):
"""Main entry point.
:param args: Parsed command line arguments.
"""
# Set node client.
client: NodeClient = _get_client(node_host, node_port_rpc)
* [How To: Unstake funds as a validator ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/deploys/how_to_unstake.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# Set validator key.
validator: PrivateKey = pycspr.parse_private_key(
path_to_validator_secret_key,
type_of_validator_secret_key,
)
### Smart Contracts

# Set deploy.
deploy: Deploy = _get_deploy(validator, chain_name, amount, delegation_rate, path_to_wasm)
* [How To: Install a smart contract ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/smart_contracts/how_to_install.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# Approve deploy.
deploy.approve(validator)
* [How To: Invoke a smart contract ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/smart_contracts/how_to_invoke.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

# Dispatch deploy to a node.
client.deploys.send(deploy)
* [How To: Query a smart contract ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/smart_contracts/how_to_query.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

print(f"Deploy dispatched to node [{node_host}]: {deploy.hash.hex()}")
### Node APIs

* [How To: Use REST API ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/node_apis/how_to_use_rest_client.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

def _get_client(node_host, node_port_rpc) -> NodeClient:
"""Returns a pycspr client instance.
"""
return NodeClient(NodeConnectionInfo(
host = node_host,
port_rpc = node_port_rpc,
))
* [How To: Use RPC API ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/node_apis/how_to_use_rpc_client.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

* [How To: Use Speculative RPC API ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/node_apis/how_to_use_speculative_rpc_client.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved

def _get_deploy(validator: PrivateKey, chain_name, amount, delegation_rate, path_to_wasm) -> Deploy:
"""Returns delegation deploy to be dispatched to a node.
"""
# Set standard deploy parameters.
deploy_params = pycspr.create_deploy_parameters(
account = validator,
chain_name = chain_name
)

# Set deploy.
deploy = pycspr.create_validator_auction_bid(
params = deploy_params,
amount = amount,
delegation_rate = delegation_rate,
public_key = validator.as_public_key(),
path_to_wasm = path_to_wasm
)

return deploy


# Entry point.
if __name__ == '__main__':
_main(node_host, node_port_rpc, path_to_validator_secret_key, type_of_validator_secret_key, chain_name, amount, delegation_rate, path_to_wasm)
```
* [How To: Use SSE API ?](https://github.com/casper-network/casper-python-sdk/blob/main/how_tos/node_apis/how_to_use_sse_client.py)
asladeofgreen marked this conversation as resolved.
Show resolved Hide resolved
Loading