how_to_delegate.py

import argparse
import os
import pathlib
import typing

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

USER_1_SECRET = "assets/net-1/users/user-1/secret_key.pem"
NODE_1_PUB_KEY_HEX = "assets/net-1/nodes/node-1/keys/public_key_hex",
DELEGATE_WASM = "assets/net-1/bin/auction/delegate.wasm",


# CLI argument parser.
_ARGS = argparse.ArgumentParser("Demo illustrating how to delegate CSPR "
                                "tokens to a validator.")

# CLI argument: path to delegator secret key - defaults to NCTL user 1.
_ARGS.add_argument(
    "--delegator-secret-key-path",
    default=pathlib.Path(os.getenv("NCTL")) / USER_1_SECRET,
    dest="path_to_delegator_secret_key",
    help="Path to delegator's secret_key.pem file.",
    type=str,
)

# CLI argument: type of delegator secret key - defaults to ED25519.
_ARGS.add_argument(
    "--delegator-secret-key-type",
    default=KeyAlgorithm.ED25519.name,
    dest="type_of_delegator_secret_key",
    help="Type of delegator's secret key.",
    type=str,
)

# CLI argument: path to validator's account key - defaults to NCTL node 1.
_ARGS.add_argument(
    "--validator-account-key-path",
    default=pathlib.Path(os.getenv("NCTL")) / NODE_1_PUB_KEY_HEX,
    dest="path_to_validator_account_key",
    help="Path to validator's public_key_hex file.",
    type=str,
)

# CLI argument: path to session code wasm binary - defaults to
#               NCTL bin/eco/delegate.wasm.
_ARGS.add_argument(
    "--path-to-wasm",
    default=pathlib.Path(os.getenv("NCTL")) / DELEGATE_WASM,
    dest="path_to_wasm",
    help="Path to delegate.wasm file.",
    type=str,
)

# CLI argument: name of target chain - defaults to NCTL chain.
_ARGS.add_argument(
    "--chain",
    default="casper-net-1",
    dest="chain_name",
    help="Name of target chain.",
    type=str,
)

# CLI argument: host address of target node - defaults to NCTL node 1.
_ARGS.add_argument(
    "--node-host",
    default="localhost",
    dest="node_host",
    help="Host address of target node.",
    type=str,
)

# CLI argument: Node API JSON-RPC port - defaults to 11101 @ NCTL node 1.
_ARGS.add_argument(
    "--node-port-rpc",
    default=11101,
    dest="node_port_rpc",
    help="Node API JSON-RPC port.  Typically 7777 on most nodes.",
    type=int,
)


def _main(args: argparse.Namespace):
    """ Main entry point.

    :param args: Parsed command line arguments.

    """
    # Set node client.
    client = _get_client(args)

    # Set counter-parties.
    delegator, validator = _get_counter_parties(args)

    # Set deploy.
    deploy: Deploy = _get_deploy(args, delegator, validator)

    # Approve deploy.
    deploy.approve(delegator)

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

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


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

    return NodeClient(connection)


def _get_counter_parties(args: argparse.Namespace
                         ) -> typing.Tuple[PrivateKey, PublicKey]:
    """ Returns the 2 counter-parties participating in the delegation. """
    delegator = factory.parse_private_key(
        args.path_to_delegator_secret_key,
        args.type_of_delegator_secret_key,
    )
    validator = factory.parse_public_key(
        args.path_to_validator_account_key
    )

    return delegator, validator


def _get_deploy(args: argparse.Namespace, delegator: PrivateKey,
                validator: PublicKey) -> Deploy:
    """ Returns delegation deploy to be dispatched to a node. """
    # Set standard deploy parameters.
    deploy_params = factory.create_deploy_parameters(
        account=delegator,
        chain_name=args.chain_name
    )

    # Set deploy.
    deploy = factory.create_validator_delegation(
        params=deploy_params,
        amount=int(1e9),
        public_key_of_delegator=delegator,
        public_key_of_validator=validator,
        path_to_wasm=args.path_to_wasm
    )

    return deploy


# Entry point.
if __name__ == '__main__':
    _main(_ARGS.parse_args())