Skip to content

Commit

Permalink
[#79] Refund transaction documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@szerepak
Ola Czerepak authored and szerepak committed Mar 21, 2018
1 parent 111a0da commit 4b18be6
Show file tree
Hide file tree
Showing 2 changed files with 164 additions and 1 deletion.
2 changes: 1 addition & 1 deletion clove/network/bitcoin/contract.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def redeem(self, wallet, secret):
def refund(self, wallet):
if self.locktime > datetime.utcnow():
locktime_string = self.locktime.strftime('%Y-%m-%d %H:%M:%S')
raise RuntimeError(f"This contract is still valid! It can't be refunded until {locktime_string}.")
raise RuntimeError(f"This contract is still valid! It can't be refunded until {locktime_string}. UTC")
transaction = BitcoinTransaction(
network=self.network,
recipient_address=self.refund_address,
Expand Down
163 changes: 163 additions & 0 deletions docs/source/refund.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Transaction refunds

The beauty of the atomic swaps is hidden in the possibility of refunding transaction,
if the second side of the exchange is delaying in the coin contribution.

#### Here are some examples of transaction refunds.

## I Initial transaction refund

Alice created and published such transaction:

{'contract': '63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a91485c0522f6e23beb11cc3d066cd20ed732648a4e66704b75db25ab17576a914621f617c765c3caa5ce1bb67f6a3e51382b8da296888ac',
'contract_address': 'M93y8ouRm8YVez5RBnZi779tgBDPwbdehB',
'contract_transaction': '01000000015322ad6edd25cc9f2f7dbec73b4d1b123b8abe7fc0e4acb1ec6bf112e1b5b9a5010000008b483045022100c4efbe3a31061df474ec8230428b6f615bc97c0e625a747f22eeeffac6efdbce02200946d6638d7d68086ba478c2280d6669934d63f09233482afcd8634937af63b701410431ab07973bbb5dbc6b7422fc7322abb5df15f77694c0b15b09a325996af47ddd887c7eaa72c656a71fcb333068956de7b3e2f15deaafc1d9285d779ca1b6a3f6000000000290ca04000000000017a9140ca29b3066cde980ffe06268f8bf1902f57ab4dd878f5c0f00000000001976a914621f617c765c3caa5ce1bb67f6a3e51382b8da2988ac00000000',
'fee': 0.00055184,
'fee_per_kb': 0.00215564,
'fee_per_kb_text': '0.00215564 LTC / 1 kB',
'fee_text': '0.00055184 LTC',
'locktime': datetime.datetime(2018, 3, 21, 14, 27, 19, 372402),
'recipient_address': 'LXRAXRgPo84p58746zaBXUFFevCTYBPxgb',
'refund_address': 'LUAn5PWmsPavgz32mGkqsUuAKncftS37Jq',
'secret': '376d4e7a476d576b70554a57504f32676569727654687463574a44356e664d72314d35744b50637743374f7a777a436257366c76514541497442316d66764733',
'secret_hash': 'b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a702',
'size': 256,
'size_text': '256 bytes',
'transaction_address': 'abbcd57c53576985783c91f5b9cf2109c5a1f16cdfb35480e14a832fb78bfeb7',
'value': 0.00314,
'value_text': '0.00314000 LTC'}

She was waiting for the response from Bob for a day but she did not receive any,
so she decided to refund the money from the blockchain:

### 1. Get a wallet from the newtork

from clove.network import Litecoin

alice_ltc_wallet = Litecoin.get_wallet(private_key='aliceprivatekey') # provide real key
alice_ltc_wallet.address
'LUAn5PWmsPavgz32mGkqsUuAKncftS37Jq'

### 2. Create refund transaction

from clove.network.bitcoin.contract import BitcoinContract

ltc_network = Litecoin()

alice_contract = BitcoinContract(
network=ltc_network,
contract='63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a91485c0522f6e23beb11cc3d066cd20ed732648a4e66704b75db25ab17576a914621f617c765c3caa5ce1bb67f6a3e51382b8da296888ac',
raw_transaction='01000000015322ad6edd25cc9f2f7dbec73b4d1b123b8abe7fc0e4acb1ec6bf112e1b5b9a5010000008b483045022100c4efbe3a31061df474ec8230428b6f615bc97c0e625a747f22eeeffac6efdbce02200946d6638d7d68086ba478c2280d6669934d63f09233482afcd8634937af63b701410431ab07973bbb5dbc6b7422fc7322abb5df15f77694c0b15b09a325996af47ddd887c7eaa72c656a71fcb333068956de7b3e2f15deaafc1d9285d779ca1b6a3f6000000000290ca04000000000017a9140ca29b3066cde980ffe06268f8bf1902f57ab4dd878f5c0f00000000001976a914621f617c765c3caa5ce1bb67f6a3e51382b8da2988ac00000000'
)

refund_transaction = alice_contract.refund(alice_ltc_wallet)
RuntimeError: This contract is still valid! It can't be refunded until 2018-03-21 14:27:19 UTC.

Oops! Something wen wrong! Contract is still valid! Alice was a bit impatient, wasn't she?

Initial transaction contract is set to be **valid for 48 hours**.

Okey! It is past 2018-03-21 14:27:19 UTC, so Alice is free to create a refund transaction!

refund_transaction = alice_contract.refund(alice_ltc_wallet)

### 3. Sign and publish refund transaction

refund_transaction.add_fee_and_sign()

refund_transaction.show_details()
{'fee': 0.00069549,
'fee_per_kb': 0.00217341,
'fee_per_kb_text': '0.00217341 LTC / 1 kB',
'fee_text': '0.00069549 LTC',
'recipient_address': 'LUAn5PWmsPavgz32mGkqsUuAKncftS37Jq',
'size': 320,
'size_text': '320 bytes',
'transaction': '0100000001b7fe8bb72f834ae18054b3df6cf1a1c50921cfb9f5913c78856957537cd5bcab00000000eb4830450221008a1974702c78cdf9067af92d57643641b9b99388fa86a35ab6121348f75b2f7a02202cff4e470e3088fbbde26c71150641428511dd6188e9fdd4ec29f507bde8f50401410431ab07973bbb5dbc6b7422fc7322abb5df15f77694c0b15b09a325996af47ddd887c7eaa72c656a71fcb333068956de7b3e2f15deaafc1d9285d779ca1b6a3f6004c5d63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a91485c0522f6e23beb11cc3d066cd20ed732648a4e66704b75db25ab17576a914621f617c765c3caa5ce1bb67f6a3e51382b8da296888ac0000000001e3ba0300000000001976a914621f617c765c3caa5ce1bb67f6a3e51382b8da2988acb75db25a',
'transaction_address': 'e42d94615792f60eab5503d7dc05a80d9cd394f958af83c8af862af1246e049d',
'value': 0.00314,
'value_text': '0.00314000 LTC'}

refund_transaction.publish()

### 4. Voilà! Alice should get her litecoins back. You can check it for example in a blockcypher.


## II Participate transaction refund

Bob created and published such participating transaction:

{'contract': '63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a9141a376f6634e41c22b28bc9ef3336a623717083a467047d0eb15ab17576a9142b6a3314e8fcf1f1fd6b4d70b112bd5a192850576888ac',
'contract_address': '3F5em2T4pJd5ParPjs2QenpGL7QDvK2Wyc',
'contract_transaction': '0100000001daee049a9f9822743a0691ae4f51768e3b4431f5f6abe08da8d8f7afd048e6ff010000008b483045022100c316eb713d282337807de04cdbd67327d78b5deb850f831f0f9aa5c06aa6ab7902203777ed3b22ab88927b92a70b621f44342a6159f10f5a3f456a9d8393e06e9e440141044fbe9cf6ef9bf4a13a693ee1d431eb700a592e8097619e0cfe82aff2a5c231e7154e464e4ec94201007b403b6de9a5819b0bc31eef0741c4fe6e932bca6d9cca0000000002405dc6000000000017a91492e189107196d882ed245bf224940a21a23c5c0187c0fb6e0c000000001976a9142b6a3314e8fcf1f1fd6b4d70b112bd5a1928505788ac00000000',
'fee': 0.001,
'fee_per_kb': 0.0,
'fee_per_kb_text': '0.00000000 MONA / 1 kB',
'fee_text': '0.00100000 MONA',
'locktime': datetime.datetime(2018, 3, 20, 14, 37, 1, 516711),
'recipient_address': 'MAHnD7u7JD4DPA3R267zcB1xbaaiZrDRmL',
'refund_address': 'MBriWYyfWNdrAmycN5otoUDWDMrdFK33DQ',
'secret': '',
'secret_hash': 'b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a702',
'size': 256,
'size_text': '256 bytes',
'transaction_address': '5d920e7093b2f0ac94cb1c13a42a79ed1c1290fcc4155d15a123d69b1afe05d2',
'value': 0.13,
'value_text': '0.13000000 MONA'}

Alice didn't redeem the transaction, so no secret key was published. Bob needed to get his monacoins back.

The process is parallel as in the [initial transaction](#I-Initial-transaction-refund).

### 1. Get a wallet from the newtork

from clove.network import Monacoin

bob_mona_wallet = Monacoin.get_wallet(private_key='bobprivatekey') # provide real key
bob_mona_wallet.address
'MBriWYyfWNdrAmycN5otoUDWDMrdFK33DQ'

### 2. Create refund transaction

from clove.network.bitcoin.contract import BitcoinContract

mona_network = Monacoin()

bob_contract = BitcoinContract(
network=mona_network,
contract='63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a9141a376f6634e41c22b28bc9ef3336a623717083a467047d0eb15ab17576a9142b6a3314e8fcf1f1fd6b4d70b112bd5a192850576888ac',
raw_transaction='0100000001daee049a9f9822743a0691ae4f51768e3b4431f5f6abe08da8d8f7afd048e6ff010000008b483045022100c316eb713d282337807de04cdbd67327d78b5deb850f831f0f9aa5c06aa6ab7902203777ed3b22ab88927b92a70b621f44342a6159f10f5a3f456a9d8393e06e9e440141044fbe9cf6ef9bf4a13a693ee1d431eb700a592e8097619e0cfe82aff2a5c231e7154e464e4ec94201007b403b6de9a5819b0bc31eef0741c4fe6e932bca6d9cca0000000002405dc6000000000017a91492e189107196d882ed245bf224940a21a23c5c0187c0fb6e0c000000001976a9142b6a3314e8fcf1f1fd6b4d70b112bd5a1928505788ac00000000'
)

refund_transaction = bob_contract.refund(bob_mona_wallet)
RuntimeError: This contract is still valid! It can't be refunded until 2018-03-20 14:37:01 UTC.

Oops! Something wen wrong! Contract is still valid! Bob was a bit impatient, wasn't he?

Participate transaction contract is set to be **valid for 24 hours**.

Okey! It is past 2018-03-20 14:37:01 UTC, so Bob is free to create a refund transaction!

refund_transaction = bob_contract.refund(bob_mona_wallet)

### 3. Sign and publish refund transaction

refund_transaction.fee = 0.001 # As monacoin is not in the blockcypher we need to add fee manually
refund_transaction.add_fee_and_sign()

{'fee': 0.001,
'fee_per_kb': 0.0,
'fee_per_kb_text': '0.00000000 MONA / 1 kB',
'fee_text': '0.00100000 MONA',
'recipient_address': 'MBriWYyfWNdrAmycN5otoUDWDMrdFK33DQ',
'size': 319,
'size_text': '319 bytes',
'transaction': '0100000001d205fe1a9bd623a1155d15c4fc90121ced792aa4131ccb94acf0b293700e925d00000000ea4730440220112731937e6e0a0f5c366e667961ba8d41bc6fd980055c0c911f6dff3cb857d0022033751626806881058120118915a0a7f20280f53952460fff0e2b4c547cc5a7690141044fbe9cf6ef9bf4a13a693ee1d431eb700a592e8097619e0cfe82aff2a5c231e7154e464e4ec94201007b403b6de9a5819b0bc31eef0741c4fe6e932bca6d9cca004c5d63a820b02f390cf0c6d445f8f3a730b2e9fce5dff10da4b47a523d2fd7bf73d8a7a7028876a9141a376f6634e41c22b28bc9ef3336a623717083a467047d0eb15ab17576a9142b6a3314e8fcf1f1fd6b4d70b112bd5a192850576888ac0000000001a0d6c400000000001976a9142b6a3314e8fcf1f1fd6b4d70b112bd5a1928505788ac7d0eb15a',
'transaction_address': '3582597e1c30759027d9e53843f79528e0f4f0ddc458449f9bb824dabb53ba14',
'value': 0.13,
'value_text': '0.13000000 MONA'}

refund_transaction.publish()
'3582597e1c30759027d9e53843f79528e0f4f0ddc458449f9bb824dabb53ba14'

### 4. Voilà! Bob should get his monacoins back. You can check it for example [here](https://bchain.info/MONA/addr/MBriWYyfWNdrAmycN5otoUDWDMrdFK33DQ).

0 comments on commit 4b18be6

Please sign in to comment.