payra-sdk 1.2.6__py3-none-any.whl → 1.2.7__py3-none-any.whl

payra_sdk/__init__.py

@@ -1,13 +1,13 @@
 # payra-sdk-python/payra_sdk/__init__.py
 
-from .signature import PayraSignatureGenerator
-from .order_verification import PayraOrderVerification
+from .signature import PayraSignature
+from .order_service import PayraOrderService
 from .exceptions import PayraSDKException, InvalidArgumentError, SignatureError
 from .utils import PayraUtils
 
 __all__ = [
-    "PayraSignatureGenerator",
-    "PayraOrderVerification",
+    "PayraSignature",
+    "PayraOrderService",
     "PayraSDKException",
     "InvalidArgumentError",
     "SignatureError",

payra_sdk/{order_verification.py → order_service.py}

@@ -11,7 +11,7 @@ from .exceptions import InvalidArgumentError, SignatureError
 # load env
 load_dotenv()
 
-class PayraOrderVerification:
+class PayraOrderService:
     """
     SDK for verifying if an order has been paid using the Payra smart contract.
     """
@@ -22,7 +22,7 @@ class PayraOrderVerification:
 
         self.web3 = Web3(Web3.HTTPProvider(self.rpc_url))
         if not self.web3.is_connected():
-            raise ConnectionError(f"Failed to connect to QuickNode RPC for {self.network}")
+            raise ConnectionError(f"Failed to connect to RPC for {self.network}")
 
         self.merchant_id = os.getenv(f"PAYRA_{self.network}_MERCHANT_ID")
         self.gateway_address = os.getenv(f"PAYRA_{self.network}_OCP_GATEWAY_CONTRACT_ADDRESS")
@@ -53,7 +53,7 @@ class PayraOrderVerification:
         # Return the actual contract responsible for order data
         return self.web3.eth.contract(address=user_data_address, abi=self.abi)
 
-    def is_order_paid(self, order_id: str) -> dict:
+    def is_paid(self, order_id: str) -> dict:
         """
         Verify if an order is paid on Payra contract.
         """
@@ -76,7 +76,7 @@ class PayraOrderVerification:
                 "error": str(e)
             }
 
-    def get_order_status(self, order_id: str) -> dict:
+    def get_details(self, order_id: str) -> dict:
         """
         Detailed status of an order from Payra smart contract.
         Equivalent to getOrderDetails in Node.js version.

payra_sdk/signature.py

@@ -12,7 +12,7 @@ from .exceptions import InvalidArgumentError, SignatureError
 # Load environment variables from .env file
 load_dotenv()
 
-class PayraSignatureGenerator:
+class PayraSignature:
     """
     SDK for generating Payra payment signatures on the backend.
     This version assumes `amount_wei` is already in the token's smallest unit (e.g., wei)
@@ -22,10 +22,10 @@ class PayraSignatureGenerator:
     def __init__(self):
 
         """
-        Initializes the PayraSignatureGenerator.
+        Initializes the PayraSignature.
         """
 
-    def generate_signature(
+    def generate(
         self,
         network: str,
         token_address: str,
@@ -117,7 +117,7 @@ class PayraSignatureGenerator:
             raise SignatureError(f"Error generating signature: {e}")
 
     # Optional: Add a verification method if you ever need to verify a signature offline
-    def verify_signature(
+    def verify(
         self,
         network: str,
         token_address: str,
@@ -168,7 +168,7 @@ class PayraSignatureGenerator:
     ) -> bytes:
         """
         Generates the raw Keccak256 hash of the ABI-encoded payment data.
-        This is a helper for internal use, especially for `verify_signature`.
+        This is a helper for internal use, especially for `verify`.
         """
         checksum_token_address = to_checksum_address(token_address)
         checksum_payer_address = to_checksum_address(payer_address)

{payra_sdk-1.2.6.dist-info → payra_sdk-1.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: payra_sdk
-Version: 1.2.6
+Version: 1.2.7
 Summary: Python SDK for Payra payment signature generation (backend)
 Author: Your Name
 Author-email: Wraith <support@payra.cash>
@@ -28,8 +28,7 @@ Official **Python SDK** for integrating **Payra's on-chain payment system** into
 
 This SDK provides:
 - Secure generation of **ECDSA signatures** compatible with the Payra smart contract, used for order payment verification.
-- Simple methods for **checking the on-chain status of orders** to confirm completed payments.
-
+- Simple methods for **checking the on-chain details of orders** to confirm completed payments.
 
 ## How It Works
 
@@ -48,20 +47,18 @@ The typical flow for signing and verifying a Payra transaction:
 
 This process ensures full compatibility between your backend and Payra’s on-chain verification logic.
 
-
 ## Features
 
 - Generates **Ethereum ECDSA signatures** using the `secp256k1` curve.
 - Fully compatible with **Payra's Solidity smart contracts** (`ERC-1155` payment verification).
 - Supports `.env` and `config/payra.php` configuration for multiple blockchain networks.
 - Laravel IoC container integration (easy dependency injection)
-- Verifies **order payment status directly on-chain** via RPC or blockchain explorer API.
+- Verifies **order payment details directly on-chain** via RPC or blockchain explorer API.
 - Provides **secure backend integration** for signing and verifying transactions.
 - Includes optional utility helpers for:
 -  **Currency conversion** (via [ExchangeRate API](https://www.exchangerate-api.com/))
 -  **USD ⇄ WEI** conversion for token precision handling.
 
-
 ## Setup
 
 Before installing this package, make sure you have an active **Payra** account:
@@ -87,7 +84,6 @@ To obtain your **RPC URLs** which are required for reading on-chain order status
 Optional (recommended):
 - Create a free API key at [ExchangeRate API](https://www.exchangerate-api.com/) to enable **automatic fiat → USD conversions** using the built-in utility helpers.
 
-
 ## Installation
 
 ### From PyPI
@@ -129,7 +125,6 @@ cp  .env.example  .env
 
 This file stores your **private configuration** and connection settings for all supported networks. Never commit `.env` to version control.
 
-
 ### Required Variables
 
 #### Exchange Rate (optional)
@@ -175,10 +170,10 @@ PAYRA_LINEA_RPC_URL_2=
 
 ## Usage Example
 
-### Generating and verifying a Payra signature in your backend
+### Generating signature
 
 ```python
-from payra_sdk import PayraUtils, PayraSignatureGenerator, PayraSDKException
+from payra_sdk import PayraUtils, PayraSignature, PayraSDKException
 
 try:
 	# Convert amount to smallest unit (wei or token decimals
@@ -186,24 +181,24 @@ try:
 	
 	PAYMENT_DATA = {
 		"network": "polygon",
-		"tokenAddress": "0xc2132D05D31c914a87C6611C10748AEb04B58e8F", # USDT on Polygon
-		"orderId": "ORDER-1753824905006-301-322",
-		"amountWei": amount_wei, # e.g. 3.34 USDT in smallest unit
+		"token_address": "0xc2132D05D31c914a87C6611C10748AEb04B58e8F", # USDT on Polygon
+		"order_id": "ord-258",
+		"amount_wei": amount_wei, # e.g. 3.34 USDT in smallest unit
 		"timestamp": 1753826059, # current Unix timestamp
-		"payerAddress": "0xe6c961D6ad9a27Ea8e5d99e40abaC365DE9Cc162"
+		"payer_address": "0xe6c961D6ad9a27Ea8e5d99e40abaC365DE9Cc162"
 	}
 	
 	# Initialize signer
-	payra_signer = PayraSignatureGenerator()
+	payra_signature = PayraSignature()
 	
 	# Generate cryptographic signature
-	signature = payra_signer.generate_signature(
+	signature = payra_signature.generate(
 		network=PAYMENT_DATA["network"],
-		token_address=PAYMENT_DATA["tokenAddress"],
-		order_id=PAYMENT_DATA["orderId"],
-		amount_wei=PAYMENT_DATA["amountWei"],
+		token_address=PAYMENT_DATA["token_address"],
+		order_id=PAYMENT_DATA["order_id"],
+		amount_wei=PAYMENT_DATA["amount_wei"],
 		timestamp=PAYMENT_DATA["timestamp"],
-		payer_address=PAYMENT_DATA["payerAddress"]
+		payer_address=PAYMENT_DATA["payer_address"]
 	)
 	
 	print(f"Generated signature: {signature}")
@@ -218,11 +213,11 @@ except  Exception  as e:
 | Field | Type | Description |
 |--------------|----------|----------------------------------------------|
 | **`network`** | `string` | Selected network name |
-| **`tokenAddress`** | `string` | ERC20 token contract address |
-| **`orderId`** | `string` | Unique order reference (e.g. ORDER-123) |
-| **`amountWei`** | `string` or `integer` | Token amount in smallest unit (e.g. wei) |
+| **`token_address`** | `string` | ERC20 token contract address |
+| **`order_id`** | `string` | Unique order reference (e.g. ORDER-123) |
+| **`amount_wei`** | `string` or `integer` | Token amount in smallest unit (e.g. wei) |
 | **`timestamp`** | `number` | Unix timestamp of signature creation |
-| **`payerAddress`** | `string` | Payer Wallet Address
+| **`payer_address`** | `string` | Payer Wallet Address
 
 #### Behind the Scenes
 
@@ -233,7 +228,7 @@ except  Exception  as e:
 
 ---
 
-### Get Order Status
+### Get Order Details
 
 Retrieve **full payment details** for a specific order from the Payra smart contract. This method returns the complete on-chain payment data associated with the order, including:
 - whether the order has been paid,
@@ -245,18 +240,18 @@ Retrieve **full payment details** for a specific order from the Payra smart cont
 Use this method when you need **detailed information** about the payment or want to display full transaction data.
 
 ```python
-from payra_sdk import PayraOrderVerification, PayraSDKException
+from payra_sdk import PayraOrderService, PayraSDKException
 
 try:
 	ORDER_ID = "ord-258"
 	# Initialize verifier for a specific network
-	verifier = PayraOrderVerification("polygon")
+	order_service = PayraOrderService("polygon")
 	
-	print("\nGet order status...")
-	result = verifier.get_order_status(ORDER_ID)
+	print("\nGet order details...")
+	details = order_service.get_details(ORDER_ID)
 	
 	print("Order ID:", ORDER_ID)
-	print("Result:", result)
+	print("Details:", details)
 	
 except PayraSDKException as e:
 	print(f"Payra SDK error: {e}")
@@ -266,8 +261,8 @@ except  Exception  as e:
 
 #### Behind the Scenes
 
-1. The backend initializes a `PayraOrderVerification` object for the desired blockchain network.
-2. It calls `get_order_status(order_id)` to check if the order transaction exists and is confirmed on-chain.
+1. The backend initializes a `PayraOrderService` object for the desired blockchain network.
+2. It calls `get_details(order_id)` to check if the order transaction exists and is confirmed on-chain.
 3. The function returns a dictionary with:
 
 ```python
@@ -291,16 +286,16 @@ Perform a **simple payment check** for a specific order. This method only verifi
 Use this method when you only need a **quick boolean confirmation** of the payment status.
 
 ```python
-from payra_sdk import PayraOrderVerification, PayraSDKException
+from payra_sdk import PayraOrderService, PayraSDKException
 
 try:
 	ORDER_ID = "ord-258"
 
 	# Initialize verifier for a specific network
-	verifier = PayraOrderVerification("polygon")
+	order_service = PayraOrderService("polygon")
 
 	print("\nChecking order status...")
-	result = verifier.is_order_paid(ORDER_ID)
+	result = order_service.is_paid(ORDER_ID)
 
 	print("Order ID:", ORDER_ID)
 	print("Result:", result)
@@ -320,7 +315,7 @@ except  Exception  as e:
 
 #### Behind the Scenes
 
-1. The backend initializes a `PayraOrderVerification` object for the desired blockchain network.
+1. The backend initializes a `PayraOrderService` object for the desired blockchain network.
 2. It calls `is_order_paid(order_id)` to check if the order transaction exists and is confirmed on-chain.
 3. The function returns a dictionary with:
 ```python
@@ -365,14 +360,14 @@ print(f"100 EUR = {usd_value} USD")
 -  `get_decimals(network, token)` – Returns the number of decimals for the given token on that network.
 -  `convert_to_usd(amount, currency)` – Converts fiat amounts (e.g. EUR, GBP) to USD using your ExchangeRate API key.
 
-
 ## Testing
 
 You can run the included `examples` to test signing and verification:
 
 ```python
 python3 example_signature.py
-python3 example_order_verification.py
+python3 example_order_get_details.py
+python3 example_order_is_paid
 python3 example_utils.py
 ```
 
@@ -384,7 +379,6 @@ Make sure your `.env` file contains correct values for the `network` being used.
 - The SDK examples are safe to run, they use **read-only RPC calls** (no real transactions are broadcast).
 - You can modify `example_signature.py` to test custom token addresses or order parameters.
 
-
 ## Projects
 
 - [GitHub/Home](https://github.com/payracash)
@@ -398,7 +392,6 @@ Make sure your `.env` file contains correct values for the `network` being used.
 - [https://payra.xyz](https://payra.xyz)
 - [https://payra.eth](https://payra.eth.limo) - suporrted by Brave and Opera Browser or .limo
 
-
 ## Social Media
 
 - [Telegram Payra Group](https://t.me/+GhTyJJrd4SMyMDA0)

payra_sdk-1.2.7.dist-info/RECORD

@@ -0,0 +1,10 @@
+payra_sdk/__init__.py,sha256=PvxKm9ON7p0Ym3aJM7TyL0YebWvYWx-4ETFb495tvnE,389
+payra_sdk/exceptions.py,sha256=Dr8dy0RohAYII_-YeSu_doPJSr0EsJPcp6Oj02sio9Q,425
+payra_sdk/order_service.py,sha256=4fFplTMJh0ZB4tgeSqat5hdMQ7Ijf0aI-mGg7scoy5o,4316
+payra_sdk/signature.py,sha256=Py7iqCc9juy56mFHXEUVCpfKYsdLuVh482GZLv0q4iI,8579
+payra_sdk/utils.py,sha256=mp9xX-6ph_xRMSIHh6PP41RcYyKZMLVPEi9M3IxxC4c,4147
+payra_sdk-1.2.7.dist-info/licenses/LICENSE,sha256=mnnujAcvHr1ULEDD2l0ZT6lrpeTv_9bG3n8sngv7ew8,120
+payra_sdk-1.2.7.dist-info/METADATA,sha256=h5sBCTp1jeIKdsAjjuJDYfHDXxfmwOAIuEJns8TlCew,14299
+payra_sdk-1.2.7.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+payra_sdk-1.2.7.dist-info/top_level.txt,sha256=oC4dhGzjcpDRRwyU9JjtLu56Uc5moaa76utQGYsPL-g,10
+payra_sdk-1.2.7.dist-info/RECORD,,

payra_sdk-1.2.6.dist-info/RECORD

@@ -1,10 +0,0 @@
-payra_sdk/__init__.py,sha256=VMmHadXy0RLCjEPZhW_hCc3hg34pkmrL4VhTjqmVBiI,422
-payra_sdk/exceptions.py,sha256=Dr8dy0RohAYII_-YeSu_doPJSr0EsJPcp6Oj02sio9Q,425
-payra_sdk/order_verification.py,sha256=_AMdw4FQf-WMO0nswylW3AJoCJbxo7__Xi1zz6IeiJo,4342
-payra_sdk/signature.py,sha256=JhozJ_Fwhn8lOHO-p8xEHn80I-TMHdeibzIXBI_bkkg,8627
-payra_sdk/utils.py,sha256=mp9xX-6ph_xRMSIHh6PP41RcYyKZMLVPEi9M3IxxC4c,4147
-payra_sdk-1.2.6.dist-info/licenses/LICENSE,sha256=mnnujAcvHr1ULEDD2l0ZT6lrpeTv_9bG3n8sngv7ew8,120
-payra_sdk-1.2.6.dist-info/METADATA,sha256=e3OjC4MBEExh-3BVtQvoYznj1J-oSbgXfC6x54h8Kas,14365
-payra_sdk-1.2.6.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-payra_sdk-1.2.6.dist-info/top_level.txt,sha256=oC4dhGzjcpDRRwyU9JjtLu56Uc5moaa76utQGYsPL-g,10
-payra_sdk-1.2.6.dist-info/RECORD,,