feat: add support for CAP-23 (#371)

StellarCN · Sep 30, 2020 · 5a4b034 · 5a4b034
1 parent 2a58b50
commit 5a4b034
Show file tree

Hide file tree

Showing 8 changed files with 731 additions and 3 deletions.
diff --git a/docs/en/api.rst b/docs/en/api.rst
@@ -425,6 +425,25 @@ SetOptions
 .. autoclass:: stellar_sdk.operation.set_options.Flag
    :members:
 
+CreateClaimableBalance
+----------------------
+.. autoclass:: stellar_sdk.operation.CreateClaimableBalance
+   :members: to_xdr_object, from_xdr_object
+
+.. autoclass:: stellar_sdk.operation.Claimant
+   :members:
+
+.. autoclass:: stellar_sdk.operation.ClaimPredicate
+   :members:
+
+.. autoclass:: stellar_sdk.operation.create_claimable_balance.ClaimPredicateType
+   :members:
+
+ClaimClaimableBalance
+---------------------
+.. autoclass:: stellar_sdk.operation.ClaimClaimableBalance
+   :members: to_xdr_object, from_xdr_object
+
 Price
 ^^^^^
 

diff --git a/docs/zh_CN/api.rst b/docs/zh_CN/api.rst
@@ -425,6 +425,25 @@ SetOptions
 .. autoclass:: stellar_sdk.operation.set_options.Flag
    :members:
 
+CreateClaimableBalance
+----------------------
+.. autoclass:: stellar_sdk.operation.CreateClaimableBalance
+   :members: to_xdr_object, from_xdr_object
+
+.. autoclass:: stellar_sdk.operation.Claimant
+   :members:
+
+.. autoclass:: stellar_sdk.operation.ClaimPredicate
+   :members:
+
+.. autoclass:: stellar_sdk.operation.create_claimable_balance.ClaimPredicateType
+   :members:
+
+ClaimClaimableBalance
+---------------------
+.. autoclass:: stellar_sdk.operation.ClaimClaimableBalance
+   :members: to_xdr_object, from_xdr_object
+
 Price
 ^^^^^
 

diff --git a/stellar_sdk/operation/__init__.py b/stellar_sdk/operation/__init__.py
@@ -2,7 +2,9 @@
 from .allow_trust import AllowTrust, TrustLineEntryFlag
 from .bump_sequence import BumpSequence
 from .change_trust import ChangeTrust
+from .claim_claimable_balance import ClaimClaimableBalance
 from .create_account import CreateAccount
+from .create_claimable_balance import CreateClaimableBalance, Claimant, ClaimPredicate
 from .create_passive_sell_offer import CreatePassiveSellOffer
 from .inflation import Inflation
 from .manage_buy_offer import ManageBuyOffer
@@ -21,7 +23,11 @@
     "AllowTrust",
     "BumpSequence",
     "ChangeTrust",
+    "ClaimClaimableBalance",
     "CreateAccount",
+    "CreateClaimableBalance",
+    "Claimant",
+    "ClaimPredicate",
     "CreatePassiveSellOffer",
     "Inflation",
     "ManageBuyOffer",

diff --git a/stellar_sdk/operation/claim_claimable_balance.py b/stellar_sdk/operation/claim_claimable_balance.py
@@ -0,0 +1,59 @@
+import base64
+import binascii
+
+from .operation import Operation
+from ..xdr import Xdr
+from ..xdr.StellarXDR_type import ClaimableBalanceID
+
+
+class ClaimClaimableBalance(Operation):
+    """The :class:`ClaimClaimableBalance` object, which represents a ClaimClaimableBalance
+    operation on Stellar's network.
+
+    Claims a ClaimableBalanceEntry and adds the amount of asset on the entry to the source account.
+
+    See `Claim Claimable Balance Documentation
+    <https://developers.stellar.org/docs/start/list-of-operations/#claim-claimable-balance>_`.
+
+    Threshold: Low
+
+    :param balance_id: The claimable balance id to be claimed.
+    :param source: The source account (defaults to transaction source).
+    """
+
+    def __init__(self, balance_id: str, source: str = None,) -> None:
+        super().__init__(source)
+        self.balance_id: str = balance_id
+
+    @classmethod
+    def type_code(cls) -> int:
+        return Xdr.const.CLAIM_CLAIMABLE_BALANCE
+
+    def _to_operation_body(self) -> Xdr.nullclass:
+        body = Xdr.nullclass()
+        body.type = Xdr.const.CLAIM_CLAIMABLE_BALANCE
+
+        balance_id_bytes: bytes = binascii.unhexlify(self.balance_id)
+        balance_id = ClaimableBalanceID.from_xdr(base64.b64encode(balance_id_bytes))
+        claim_claimable_balance_op = Xdr.types.ClaimClaimableBalanceOp(
+            balanceID=balance_id
+        )
+
+        body.claimClaimableBalanceOp = claim_claimable_balance_op
+        return body
+
+    @classmethod
+    def from_xdr_object(
+        cls, operation_xdr_object: Xdr.types.Operation
+    ) -> "ClaimClaimableBalance":
+        """Creates a :class:`ClaimClaimableBalance` object from an XDR Operation
+        object.
+        """
+        source = Operation.get_source_from_xdr_obj(operation_xdr_object)
+        balance_id = base64.b64decode(
+            operation_xdr_object.body.claimClaimableBalanceOp.to_xdr()
+        )
+        balance_id = binascii.hexlify(balance_id).decode()
+        op = cls(balance_id=balance_id, source=source)
+        op._source_muxed = Operation.get_source_muxed_from_xdr_obj(operation_xdr_object)
+        return op