Implemented a native auth client and faucet functionality

.github/workflows/build-windows.yml

@@ -31,6 +31,7 @@ jobs:
           python3 -m pip install --upgrade pip
           pip3 install -r requirements.txt
           pip3 install pytest
+          pip3 install pytest-mock
       - name: Set github_api_token
         shell: bash
         run: |

.github/workflows/build.yml

@@ -29,7 +29,7 @@ jobs:
         run: |
           python3 -m pip install --upgrade pip
           pip3 install -r requirements.txt
-          pip3 install pytest
+          pip3 install -r requirements-dev.txt
       - name: Set github_api_token
         run: |
           mkdir ~/multiversx-sdk

CLI.md

@@ -23,7 +23,7 @@ See:
 
 
 COMMAND GROUPS:
-  {contract,tx,validator,account,ledger,wallet,deps,config,localnet,data,staking-provider,dns}
+  {contract,tx,validator,account,ledger,wallet,deps,config,localnet,data,staking-provider,dns,faucet}
 
 TOP-LEVEL OPTIONS:
   -h, --help            show this help message and exit
@@ -45,6 +45,7 @@ localnet                       Set up, start and control localnets
 data                           Data manipulation omnitool
 staking-provider               Staking provider omnitool
 dns                            Operations related to the Domain Name Service
+faucet                         Get xEGLD on Devnet or Testnet
 
 ```
 ## Group **Contract**
@@ -1093,6 +1094,7 @@ Remove nodes must be called by the contract owner
 options:
   -h, --help                                      show this help message and exit
   --bls-keys BLS_KEYS                             a list with the bls keys of the nodes
+  --validators-file VALIDATORS_FILE               a JSON file describing the Nodes
   --delegation-contract DELEGATION_CONTRACT       address of the delegation contract
   --proxy PROXY                                   🔗 the URL of the proxy
   --pem PEM                                       🔑 the PEM file, if keyfile not provided
@@ -1142,6 +1144,7 @@ Stake nodes must be called by the contract owner
 options:
   -h, --help                                      show this help message and exit
   --bls-keys BLS_KEYS                             a list with the bls keys of the nodes
+  --validators-file VALIDATORS_FILE               a JSON file describing the Nodes
   --delegation-contract DELEGATION_CONTRACT       address of the delegation contract
   --proxy PROXY                                   🔗 the URL of the proxy
   --pem PEM                                       🔑 the PEM file, if keyfile not provided
@@ -1191,6 +1194,7 @@ Unbond nodes must be called by the contract owner
 options:
   -h, --help                                      show this help message and exit
   --bls-keys BLS_KEYS                             a list with the bls keys of the nodes
+  --validators-file VALIDATORS_FILE               a JSON file describing the Nodes
   --delegation-contract DELEGATION_CONTRACT       address of the delegation contract
   --proxy PROXY                                   🔗 the URL of the proxy
   --pem PEM                                       🔑 the PEM file, if keyfile not provided
@@ -1240,6 +1244,7 @@ Unstake nodes must be called by the contract owner
 options:
   -h, --help                                      show this help message and exit
   --bls-keys BLS_KEYS                             a list with the bls keys of the nodes
+  --validators-file VALIDATORS_FILE               a JSON file describing the Nodes
   --delegation-contract DELEGATION_CONTRACT       address of the delegation contract
   --proxy PROXY                                   🔗 the URL of the proxy
   --pem PEM                                       🔑 the PEM file, if keyfile not provided
@@ -1289,6 +1294,7 @@ Unjail nodes must be called by the contract owner
 options:
   -h, --help                                      show this help message and exit
   --bls-keys BLS_KEYS                             a list with the bls keys of the nodes
+  --validators-file VALIDATORS_FILE               a JSON file describing the Nodes
   --delegation-contract DELEGATION_CONTRACT       address of the delegation contract
   --proxy PROXY                                   🔗 the URL of the proxy
   --pem PEM                                       🔑 the PEM file, if keyfile not provided
@@ -2116,3 +2122,46 @@ options:
   --use-global           use the global storage (default: False)
 
 ```
+## Group **Faucet**
+
+
+```
+$ mxpy faucet --help
+usage: mxpy faucet COMMAND [-h] ...
+
+Get xEGLD on Devnet or Testnet
+
+COMMANDS:
+  {request}
+
+OPTIONS:
+  -h, --help  show this help message and exit
+
+----------------
+COMMANDS summary
+----------------
+request                        Request xEGLD.
+
+```
+### Faucet.Request
+
+
+```
+$ mxpy faucet request --help
+usage: mxpy faucet request [-h] ...
+
+Request xEGLD.
+
+options:
+  -h, --help                                   show this help message and exit
+  --pem PEM                                    🔑 the PEM file, if keyfile not provided
+  --pem-index PEM_INDEX                        🔑 the index in the PEM file (default: 0)
+  --keyfile KEYFILE                            🔑 a JSON keyfile, if PEM not provided
+  --passfile PASSFILE                          🔑 a file containing keyfile's password, if keyfile provided
+  --ledger                                     🔐 bool flag for signing transaction using ledger
+  --ledger-account-index LEDGER_ACCOUNT_INDEX  🔐 the index of the account when using Ledger
+  --ledger-address-index LEDGER_ADDRESS_INDEX  🔐 the index of the address when using Ledger
+  --sender-username SENDER_USERNAME            🖄 the username of the sender
+  --chain CHAIN                                the chain identifier
+
+```

CLI.md.sh

@@ -114,6 +114,9 @@ generate() {
     command "Data.Dump" "data parse"
     command "Data.Store" "data store"
     command "Data.Load" "data load"
+
+    group "Faucet" "faucet"
+    command "Faucet.Request" "faucet request"
 }
 
 generate

Dockerfile

@@ -0,0 +1,37 @@
+FROM ubuntu:22.04
+
+ARG USERNAME=developer
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+# Create the user
+RUN groupadd --gid $USER_GID $USERNAME \
+    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    #
+    # [Optional] Add sudo support. Omit if you don't need to install software after connecting.
+    && apt-get update \
+    && apt-get install -y sudo \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+# Install some dependencies as root
+RUN apt-get update && apt-get install -y \
+    wget \
+    python3.10 python3-pip python3.10-venv \
+    git \
+    pkg-config \
+    libssl-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+# Switch to regular user
+USER $USERNAME
+WORKDIR /home/${USERNAME}
+
+RUN sudo apt-get update
+RUN sudo apt-get install git
+
+# RUN sudo apt install pipx -y 8 
+
+# RUN pipx ensurepath
+
+# RUN pipx install git+https://github.com/multiversx/mx-sdk-py-cli@fix-deps-all

multiversx_sdk_cli/cli.py

@@ -13,6 +13,7 @@
 import multiversx_sdk_cli.cli_delegation
 import multiversx_sdk_cli.cli_deps
 import multiversx_sdk_cli.cli_dns
+import multiversx_sdk_cli.cli_faucet
 import multiversx_sdk_cli.cli_ledger
 import multiversx_sdk_cli.cli_localnet
 import multiversx_sdk_cli.cli_transactions
@@ -97,6 +98,7 @@ def setup_parser(args: List[str]):
     commands.append(multiversx_sdk_cli.cli_data.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_delegation.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_dns.setup_parser(args, subparsers))
+    commands.append(multiversx_sdk_cli.cli_faucet.setup_parser(args, subparsers))
 
     parser.epilog = """
 ----------------------

multiversx_sdk_cli/cli_faucet.py

@@ -0,0 +1,76 @@
+import logging
+import webbrowser
+from enum import Enum
+from typing import Any, List, Tuple
+
+from multiversx_sdk_core import Message, MessageComputer
+
+from multiversx_sdk_cli import cli_shared
+from multiversx_sdk_cli.errors import BadUserInput
+from multiversx_sdk_cli.native_auth_client import (NativeAuthClient,
+                                                   NativeAuthClientConfig)
+
+logger = logging.getLogger("cli.faucet")
+
+
+class WebWalletUrls(Enum):
+    DEVNET = "https://devnet-wallet.multiversx.com"
+    TESTNET = "https://testnet-wallet.multiversx.com"
+
+
+class ApiUrls(Enum):
+    DEVNET = "https://devnet-api.multiversx.com"
+    TESTNET = "https://testnet-api.multiversx.com"
+
+
+def setup_parser(args: List[str], subparsers: Any) -> Any:
+    parser = cli_shared.add_group_subparser(subparsers, "faucet", "Get xEGLD on Devnet or Testnet")
+    subparsers = parser.add_subparsers()
+
+    sub = cli_shared.add_command_subparser(subparsers, "faucet", "request", "Request xEGLD.")
+    cli_shared.add_wallet_args(args, sub)
+    sub.add_argument("--chain", required=True, help="the chain identifier")
+    sub.set_defaults(func=faucet)
+
+    parser.epilog = cli_shared.build_group_epilog(subparsers)
+    return subparsers
+
+
+def faucet(args: Any):
+    account = cli_shared.prepare_account(args)
+    wallet, api = get_wallet_and_api_urls(args)
+
+    config = NativeAuthClientConfig(origin=wallet, api_url=api)
+    client = NativeAuthClient(config)
+
+    init_token = client.initialize()
+    message = Message(f"{account.address.to_bech32()}{init_token}".encode())
+
+    message_computer = MessageComputer()
+    signature = account.sign_message(message_computer.compute_bytes_for_signing(message))
+
+    access_token = client.get_token(
+        address=account.address.to_bech32(),
+        token=init_token,
+        signature=signature
+    )
+
+    logger.info(f"Requesting funds for address: {account.address.to_bech32()}")
+    call_web_Wallet_faucet(wallet_url=wallet, access_token=access_token)
+
+
+def call_web_Wallet_faucet(wallet_url: str, access_token: str):
+    faucet_url = f"{wallet_url}/faucet?accessToken={access_token}"
+    webbrowser.open_new_tab(faucet_url)
+
+
+def get_wallet_and_api_urls(args: Any) -> Tuple[str, str]:
+    chain: str = args.chain
+
+    if chain.upper() == "D":
+        return WebWalletUrls.DEVNET.value, ApiUrls.DEVNET.value
+
+    if chain.upper() == "T":
+        return WebWalletUrls.TESTNET.value, ApiUrls.TESTNET.value
+
+    raise BadUserInput("Invalid chain id. Choose between 'D' for devnet and 'T' for testnet.")

multiversx_sdk_cli/errors.py

@@ -208,3 +208,8 @@ def __init__(self, message: str, url: str, data: str, code: str):
             "code": code
         }
         super().__init__(message, inner)
+
+
+class NativeAuthClientError(KnownError):
+    def __init__(self, message: str):
+        super().__init__(message)

multiversx_sdk_cli/native_auth_client.py

@@ -0,0 +1,101 @@
+import base64
+import json
+from typing import Any, Dict, Optional
+
+import requests
+
+from multiversx_sdk_cli.errors import NativeAuthClientError
+
+
+class NativeAuthClientConfig:
+    def __init__(
+            self,
+            origin: str = '',
+            api_url: str = "https://api.multiversx.com",
+            expiry_seconds: int = 60 * 60 * 24,
+            block_hash_shard: Optional[int] = None,
+            gateway_url: Optional[str] = None,
+            extra_request_headers: Optional[Dict[str, str]] = None
+    ) -> None:
+        self.origin = origin
+        self.api_url = api_url
+        self.expiry_seconds = expiry_seconds
+        self.block_hash_shard = block_hash_shard
+        self.gateway_url = gateway_url
+        self.extra_request_headers = extra_request_headers
+
+
+class NativeAuthClient:
+    def __init__(self, config: NativeAuthClientConfig = NativeAuthClientConfig()) -> None:
+        self.config = config
+
+    def get_token(self, address: str, token: str, signature: str) -> str:
+        encoded_address = self.encode_value(address)
+        encoded_token = self.encode_value(token)
+
+        return f"{encoded_address}.{encoded_token}.{signature}"
+
+    def initialize(self, extra_info: Dict[Any, Any] = {}) -> str:
+        block_hash = self.get_current_block_hash()
+        encoded_extra_info = self.encode_value(json.dumps(extra_info))
+        encoded_origin = self.encode_value(self.config.origin)
+
+        return f"{encoded_origin}.{block_hash}.{self.config.expiry_seconds}.{encoded_extra_info}"
+
+    def get_current_block_hash(self) -> str:
+        if self.config.gateway_url:
+            return self._get_current_block_hash_using_gateway()
+        return self._get_current_block_hash_using_api()
+
+    def _get_current_block_hash_using_gateway(self) -> str:
+        round = self._get_current_round()
+        url = f"{self.config.gateway_url}/blocks/by-round/{round}"
+        response = self._execute_request(url)
+        blocks = response["data"]["blocks"]
+        block = [b for b in blocks if b["shard"] == self.config.block_hash_shard][0]
+        return block["hash"]
+
+    def _get_current_round(self) -> int:
+        if self.config.gateway_url is None:
+            raise NativeAuthClientError("Gateway URL not set")
+
+        if self.config.block_hash_shard is None:
+            raise NativeAuthClientError("Blockhash shard not set")
+
+        url = f"{self.config.gateway_url}/network/status/{self.config.block_hash_shard}"
+        response = self._execute_request(url)
+        status = response["data"]["status"]
+
+        return status["erd_current_round"]
+
+    def _get_current_block_hash_using_api(self) -> str:
+        try:
+            url = f"{self.config.api_url}/blocks/latest?ttl={self.config.expiry_seconds}&fields=hash"
+            response = self._execute_request(url)
+            if response["hash"]:
+                return response["hash"]
+        except Exception:
+            pass
+
+        return self._get_current_block_hash_using_api_fallback()
+
+    def _get_current_block_hash_using_api_fallback(self) -> str:
+        url = f"{self.config.api_url}/blocks?size=1&fields=hash"
+
+        if self.config.block_hash_shard:
+            url += f"&shard={self.config.block_hash_shard}"
+
+        response = self._execute_request(url)
+        return response[0]["hash"]
+
+    def encode_value(self, string: str) -> str:
+        encoded = base64.b64encode(string.encode('utf-8')).decode('utf-8')
+        return self.escape(encoded)
+
+    def escape(self, string: str) -> str:
+        return string.replace("+", "-").replace("/", "_").replace("=", "")
+
+    def _execute_request(self, url: str) -> Any:
+        response = requests.get(url=url, headers=self.config.extra_request_headers)
+        response.raise_for_status()
+        return response.json()