Condition and fulfillment in escrow

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [[Unreleased]]
 
+### Added
+- Add a utility function `generate_escrow_cryptoconditions` to generate cryptographic condition and fulfillment for conditional escrows
+
 ## [4.0.0] - 2024-12-23
 
 ### Added
@@ -53,9 +56,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rectify the incorrect usage of a transaction flag name: Update `TF_NO_DIRECT_RIPPLE` to `TF_NO_RIPPLE_DIRECT`
 - Add the missing `AMMDeposit` Flag `TF_TWO_ASSET_IF_EMPTY`
 
-### Removed:
-- Remove Hooks faucet since it's now on the Xahau testnet.
-
 ## [2.5.0] - 2023-11-30
 
 ### Added

pyproject.toml

@@ -32,6 +32,7 @@ websockets = ">=11,<14"
 Deprecated = "^1.2.13"
 types-Deprecated = "^1.2.9"
 pycryptodome = "^3.16.0"
+cryptoconditions = "0.8.1"
 
 [tool.poetry.dev-dependencies]
 flake8 = "^7.0.0"

snippets/send_escrow.py

@@ -1,11 +1,13 @@
 """Example of how we can set up an escrow"""
 
 from datetime import datetime
+from os import urandom
 from time import sleep
 
 from xrpl.account import get_balance
 from xrpl.clients import JsonRpcClient
 from xrpl.models import AccountObjects, EscrowCreate, EscrowFinish
+from xrpl.models.transactions.escrow_create import generate_escrow_cryptoconditions
 from xrpl.transaction.reliable_submission import submit_and_wait
 from xrpl.utils import datetime_to_ripple_time
 from xrpl.wallet import generate_faucet_wallet
@@ -65,3 +67,41 @@
 print("Balances of wallets after Escrow was sent:")
 print(get_balance(wallet1.address, client))
 print(get_balance(wallet2.address, client))
+
+# Setup conditional escrows
+cryptoCondition = generate_escrow_cryptoconditions(urandom(32))
+
+create_tx = EscrowCreate(
+    account=wallet1.address,
+    destination=wallet2.address,
+    amount="1000000",
+    condition=cryptoCondition["condition"],
+    cancel_after=datetime_to_ripple_time(datetime.now()) + 100,
+)
+
+create_escrow_response = submit_and_wait(create_tx, client, wallet1)
+print(create_escrow_response)
+
+# Create an AccountObjects request and have the client call it to see if escrow exists
+account_objects_request = AccountObjects(account=wallet1.address)
+account_objects = (client.request(account_objects_request)).result["account_objects"]
+
+print("Conditional Escrow object exists in wallet1's account:")
+print(account_objects)
+
+# Create an EscrowFinish transaction, then sign, autofill, and send it
+finish_tx = EscrowFinish(
+    account=wallet1.address,
+    owner=wallet1.address,
+    offer_sequence=create_escrow_response.result["Sequence"],
+    fulfillment=cryptoCondition["fulfillment"],
+    condition=cryptoCondition["condition"],
+)
+
+submit_and_wait(finish_tx, client, wallet1)
+
+# The fees for EscrowFinish transaction of a conditional escrows are higher.
+# Additionally, the fees scale with the reference load on the server
+print("Balances of wallets after Escrow was sent:")
+print(get_balance(wallet1.address, client))
+print(get_balance(wallet2.address, client))

tests/unit/models/transactions/test_escrow_create.py

@@ -1,7 +1,12 @@
+from os import urandom
 from unittest import TestCase
 
 from xrpl.models.exceptions import XRPLModelException
-from xrpl.models.transactions import EscrowCreate
+from xrpl.models.transactions import EscrowCreate, EscrowFinish
+from xrpl.models.transactions.escrow_create import generate_escrow_cryptoconditions
+
+_OFFER_SEQUENCE = 1
+_OWNER = "rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN"
 
 
 class TestEscrowCreate(TestCase):
@@ -24,3 +29,44 @@ def test_final_after_less_than_cancel_after(self):
                 finish_after=finish_after,
                 sequence=sequence,
             )
+
+    def test_escrow_condition_and_fulfillment(self):
+        account = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+        amount = "100"
+        destination = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+        fee = "0.00001"
+        sequence = 19048
+
+        # use os.urandom as the source of cryptographic randomness
+        condition, fulfillment = generate_escrow_cryptoconditions(urandom(32))
+
+        EscrowCreate(
+            account=account,
+            amount=amount,
+            destination=destination,
+            fee=fee,
+            sequence=sequence,
+            condition=condition,
+        )
+
+        # EscrowFinish without the fullfillment must throw an error
+        with self.assertRaises(XRPLModelException):
+            EscrowFinish(
+                account=account,
+                condition=condition,
+                fee=fee,
+                sequence=sequence,
+                offer_sequence=_OFFER_SEQUENCE,
+                owner=_OWNER,
+            )
+
+        # execute Escrow finish with the fulfillment
+        EscrowFinish(
+            account=account,
+            condition=condition,
+            fee=fee,
+            sequence=sequence,
+            fulfillment=fulfillment,
+            offer_sequence=_OFFER_SEQUENCE,
+            owner=_OWNER,
+        )

xrpl/models/transactions/escrow_create.py

@@ -5,7 +5,8 @@
 from dataclasses import dataclass, field
 from typing import Dict, Optional
 
-from typing_extensions import Self
+from cryptoconditions import PreimageSha256  # type: ignore
+from typing_extensions import Self, TypedDict
 
 from xrpl.models.amounts import Amount
 from xrpl.models.required import REQUIRED
@@ -84,3 +85,36 @@ def _get_errors(self: Self) -> Dict[str, str]:
             )
 
         return errors
+
+
+class CryptoConditions(TypedDict):
+    """
+    A typed-dictionary containing the condition and the fulfillment for
+    conditional Escrows
+    """
+
+    condition: str
+    fulfillment: str
+
+
+def generate_escrow_cryptoconditions(secret: bytes) -> CryptoConditions:
+    """Generate a condition and fulfillment for escrows
+
+    Args:
+        secret: Cryptographic source of randomness used to generate the condition and
+            fulfillment
+
+    Returns:
+        A pair of condition and fulfillment is returned
+
+    """
+    fufill = PreimageSha256(preimage=secret)
+    cond_fulfillment: CryptoConditions = {
+        "condition": str.upper(fufill.condition_binary.hex()),
+        "fulfillment": str.upper(fufill.serialize_binary().hex()),
+    }
+    return cond_fulfillment
+    # return {
+    #     "condition": str.upper(fufill.condition_binary.hex()),
+    #     "fulfillment": str.upper(fufill.serialize_binary().hex()),
+    # }