Skip to content

Latest commit

 

History

History
134 lines (99 loc) · 10.9 KB

06_4_Sending_a_Transaction_with_a_Locktime.md

File metadata and controls

134 lines (99 loc) · 10.9 KB

6.4: Sending a Transaction with a Locktime

NOTE: This is a draft in progress, so that I can get some feedback from early reviewers. It is not yet ready for learning.

The second way to vary how you send a basic transaction is to choose a locktime. This gives you the ability to send raw transactions at some time in the future.

Understand How Locktime Works

When you create a locktime transaction, you lock it with a number that represents either a block height (if it's a small number) or a UNIX timestamp (if it's a big number). This tells the Bitcoin network that the transaction may not be put into a block until either the specified time has arrived or the blockchain has reached the specified height.

What is block height? It's the total count of blocks in the chain, going back to the genesis block for Bitcoin.

When a locktime transaction is waiting to go into a block, it can be cancelled. This means that it is far, far from finalized. In fact, the ability to cancel is the whole purpose of a locktime transaction.

What is nLockTime? It's the same thing as locktime. More specifically, it's what locktime is called internal to the Bitcoin Core source code.

What is Timelock? Locktime is just one way to lock Bitcoin transactions until some point in the future; collectively these methods are called timelocks. Locktime is the most basic timelock method. It locks an entire transaction with an absolute time, and it's available through bitcoin-cli (which is why it's the only timelock covered in this section). A parallel method, which locks a transaction with a relative time is defined in BIP 68 and covered in §9.3: Using CSV in Scripts. Bitcoin Script further empowers both sorts of timelocks, allowing for the locking of individual outputs instead of entire transactions. Absolute timelocks are linked to OP_CHECKLOCKTIMEVERIFY, which is defined in BIP 65 and covered in §9.2: Using CLTV in Scripts, while relative timelocks are linked to OP_CHECKSEQUENCEVERIFY, which is defined in BIP 112 and also covered in §9.3.

Create a Locktime Transaction

In order to create a locktime transaction, you need to first determine what you will set the locktime to.

Figure Out Your Locktime By UNIX Timestamp

Most frequently you will set the locktime to a UNIX timestamp representing a specific date and time. You can calculate a UNIX timestamp at a web site like UNIX Time Stamp or Epoch Convertor. However, it would be better to write your own script on your local machine, so that you know the UNIX timestamp you receive is accurate. If you don't do that, at least double check on two different sites.

Why Would I Use a UNIX Timestamp? Using a UNIX timestamp makes it easy to definitively link a transaction to a specific time, without worrying about whether the speed of block creation might change at some point. Particularly if you're creating a locktime that's far in the future, it's the safer thing to do. But, beyond that, it's just more intuitive, creating a direct correlation between some calendar date and the time when the transaction can be mined.

WARNING: Locktime with UNIX timestamps has a bit of wriggle room: the release of blocks isn't regular and block times can be two hours ahead of real time, so a locktime actually means "within a few hours of this time, plus or minus".

Figure Out Your Locktime By Block Height

Alternatively, you can set the locktime to a smaller number representing a block height. To calculate your future block height, you need to first know what the current block height is. bitcoin-cli getblockcount will tell you what your local machine thinks the block height is. You can verify that it's up to date with the btcblock alias, which compares the blockheight from your bitcoind with a block height taken from the network.

Once you've figured out the current height, you can decide how far in the future to set your locktime to. Remember that on average a new block will be created every 10 minutes. So, for example, if you wanted to set the locktime to a week in the future, you'd choose a block height that is 6 x 24 x 7 = 1,008 blocks in advance of the current one.

Why Would I Use a Blockheight? Unlike with timestamps, there's no fuzziness for blockheights. If you set a blockheight of 120,000 for your locktime, then there's absolutely no way for it to go into block 119,999. This can make it easier to algorithmically control your locktimed transaction. The downside is that you can't be as sure of when precisely the locktime will be.

WARNING: If you want to set a block-height locktime, you must set the locktime to less than 500 million. If you set it to 500 million or over, your number will instead be interpreted as a timestamp. Since the UNIX timestamp of 500 million was November 5, 1985, that probably means that your transaction will be put into a block at the miners' first opportunity.

Write Your Transaction

Once you have figured out your locktime, all you need to do is write up a typical raw transaction, with a third variable for locktime:

$ rawtxhex=$(bitcoin-cli -named createrawtransaction inputs='''[ { "txid": "'$utxo_txid'", "vout": '$utxo_vout' } ]''' outputs='''{ "'$recipient'": 0.8, "'$changeaddress'": 0.0895 }''' locktime=1119160)

Note that this usage of locktime is under 500 million, which means that it defines a block height. In this case, it's just a few blocks past the current block height, meant to exemplify how locktime works without sitting around for a long time to wait and see what happens.

Here's what the created transaction looks like:

$ bitcoin-cli -named decoderawtransaction hexstring=$rawtxhex 
{
  "txid": "34650e513b9b84bc47bc10f39ab7f66f59915b65c0c07fdcaf786502d88cec4a",
  "hash": "34650e513b9b84bc47bc10f39ab7f66f59915b65c0c07fdcaf786502d88cec4a",
  "size": 119,
  "vsize": 119,
  "version": 2,
  "locktime": 1119160,
  "vin": [
    {
      "txid": "4dcef95a7bb24d907cc0954d75754f8bf1b70cc0542ca071a023abde425a734b",
      "vout": 1,
      "scriptSig": {
        "asm": "",
        "hex": ""
      },
      "sequence": 4294967294
    }
  ],
  "vout": [
    {
      "value": 0.80000000,
      "n": 0,
      "scriptPubKey": {
        "asm": "OP_DUP OP_HASH160 e7c1345fc8f87c68170b3aa798a956c2fe6a9eff OP_EQUALVERIFY OP_CHECKSIG",
        "hex": "76a914e7c1345fc8f87c68170b3aa798a956c2fe6a9eff88ac",
        "reqSigs": 1,
        "type": "pubkeyhash",
        "addresses": [
          "n2eMqTT929pb1RDNuqEnxdaLau1rxy3efi"
        ]
      }
    }, 
    {
      "value": 0.08950000,
      "n": 1,
      "scriptPubKey": {
        "asm": "OP_DUP OP_HASH160 695c79109dc8424573ca6963bda9beeb5d8a6c68 OP_EQUALVERIFY OP_CHECKSIG",
        "hex": "76a914695c79109dc8424573ca6963bda9beeb5d8a6c6888ac",
        "reqSigs": 1,
        "type": "pubkeyhash",
        "addresses": [
          "mq842Ku2f2ySWpapEwxjuTCjR3Btvz88nx"
        ]
      }
    }
  ]
}

Note that the sequence number (4294967294) is less than 0xffffffff. This is necessary signalling to show that the transaction includes a locktime. It's also done automatically by bitcoin-cli. If the sequence number is instead set to 0xffffffff, your locktime will be ignored.

SEQUENCE NOTE (II): This is the second use of the nSequence value in Bitcoin. As with RBF, nSequence is again used as an opt-in, this time for the use of locktime. 0xffffffff-1 (4294967294) is the preferred value for signalling locktime because it purposefully disallows the use of both RBF (which requires nSequence < 0xffffffff-1) and relative timelock (which requires nSequence < 0xf0000000), the other two uses of the nSequence value. If you set nSequence lower than 0xf0000000, then you will also relative timelock your transaction, which is probably not what you want.

WARNING: If you are creating a locktime raw transaction by some other means than bitcoin-cli, you will have to set the sequence to less than 0xffffffff by hand.

Send Your Transaction

By now you're probably well familiar with finishing things up:

$ signedtx=$(bitcoin-cli -named signrawtransaction hexstring=$rawtxhex | jq -r '.hex')
$ bitcoin-cli -named sendrawtransaction hexstring=$signedtx
error code: -26
error message:
64: non-final

Whoop! What's that error!?

Since 2013, you generally can't place the timelocked transaction into the mempool until its lock has expired. However, you can still hold the transaction, occasionally resending it to the Bitcoin network until it's accepted into the mempool. Alternatively, you could send the signed transaction ($signedtx) to the recipient, so that he could place it in the mempool when the locktime has expired.

Once the locktime is past, anyone can send that signed transaction to the network, and the recipient will receive the money as intended ... provided that the transaction hasn't been cancelled.

Cancel a Locktime Transaction

Cancelling a locktime transaction is very simple: you send a new transactions using at least one of the same UTXOs.

Summary: Sending a Transaction with a Locktime

Locktime offers a way to create a transaction that should not be relayable to the network and that will not be accepted into a block until the appropriate time has arrived. In the meantime, it can be cancelled simply by reusing a UTXO.

What is the Power of Locktime? The power of locktime may not be immediately obvious because of the ability to cancel it so easily. However, it's another of the bases of Smart Contracts: it has a lot of utility in a variety of custodial or contractual applications. For example, consider a situation where a third party is holding your bitcoins. In order to guarantee the return of your bitcoins if the custodian ever disappeared, they could produce a timelock transition to return the coins to you, then update that every once in a while with a new one, further in the future. If they ever failed to update, then the coins would return to you when the current timelock expired. Locktime could similarly be applied to a payment network, where the network holds coins while they're being exchanged by network participants. Finally, a will offers an example of a more complex contract, where payments are sent out to a number of people. These payments would be build on locktime transactions, and would be continually updated as long as the owner continues to show signs of life. (The unifying factor of all of these applications is, of course, trust. Simple locktime transactions only work if the holder of the coins can be trusted to send them out under the appropriate conditions.)

What's Next?

Continue "Expanding Bitcoin Transactions" with §6.5: Sending a Transaction with Data.