Inside Bitcoin

501
502        self.test_rest_request(f"/block/{blockhash}", status=200, req_type=ReqType.BIN, ret_type=RetType.OBJ)
503        self.test_rest_request(f"/blockpart/{blockhash}", query_params={"offset": 0, "size": 1}, status=200, req_type=ReqType.BIN, ret_type=RetType.OBJ)
504        blk_files = list(self.nodes[0].blocks_path.glob("blk*.dat"))
505        for blk_file in blk_files:
506            blk_file.rename(blk_file.with_suffix('.bkp'))
507        self.test_rest_request(f"/block/{blockhash}", status=500, req_type=ReqType.BIN, ret_type=RetType.OBJ)
508        self.test_rest_request(f"/blockpart/{blockhash}", query_params={"offset": 0, "size": 1}, status=500, req_type=ReqType.BIN, ret_type=RetType.OBJ)
509        for blk_file in blk_files:
510            blk_file.with_suffix('.bkp').rename(blk_file)
511
512        self.log.info("Test the /deploymentinfo URI")
513
514        deployment_info = self.nodes[0].getdeploymentinfo()
515        assert_equal(deployment_info, self.test_rest_request('/deploymentinfo'))
516
517        previous_bb_hash = self.nodes[0].getblockhash(self.nodes[0].getblockcount() - 1)
518        deployment_info = self.nodes[0].getdeploymentinfo(previous_bb_hash)
519        assert_equal(deployment_info, self.test_rest_request(f"/deploymentinfo/{previous_bb_hash}"))
520
521        non_existing_blockhash = '42759cde25462784395a337460bde75f58e73d3f08bd31fdc3507cbac856a2c4'
522        resp = self.test_rest_request(f'/deploymentinfo/{non_existing_blockhash}', ret_type=RetType.OBJ, status=400)
523        assert_equal(resp.read().decode('utf-8').rstrip(), "Block not found")
524
525        resp = self.test_rest_request(f"/deploymentinfo/{INVALID_PARAM}", ret_type=RetType.OBJ, status=400)
526        assert_equal(resp.read().decode('utf-8').rstrip(), f"Invalid hash: {INVALID_PARAM}")
527
528        self.log.info("Test Cache-Control headers on REST responses")
529
530        blockhash = self.nodes[0].getbestblockhash()
531        height = self.nodes[0].getblockcount()
532        immutable = "public, immutable, max-age=86400"
533        no_store = "no-store"
534
535        def assert_cache_control(
536            uri: str,
537            expected: str,
538            *,
539            req_type: typing.Optional[ReqType] = ReqType.JSON,
540            status: int = 200,
541            query_params: typing.Union[dict[str, typing.Any], str, None] = None,
542        ) -> bytes:
543            """Assert `uri` has expected Cache-Control and return the response body."""
544            response = self.test_rest_request(
545                uri,
546                req_type=req_type,
547                status=status,
548                ret_type=RetType.OBJ,
549                query_params=query_params,
550            )
551            assert isinstance(response, http.client.HTTPResponse)
552            assert_equal(response.getheader("Cache-Control"), expected)
553            return response.read()
554
555        # Immutable endpoints
556        immutable_block = assert_cache_control(f"/block/{blockhash}", immutable, req_type=ReqType.BIN)
557        immutable_spenttxouts = assert_cache_control(f"/spenttxouts/{blockhash}", immutable)
558        assert_cache_control(f"/spenttxouts/{blockhash}", immutable, req_type=ReqType.BIN)
559        assert_cache_control(f"/spenttxouts/{blockhash}", immutable, req_type=ReqType.HEX)
560        immutable_blockfilter = assert_cache_control(
561            f"/blockfilter/basic/{blockhash}", immutable, req_type=ReqType.JSON
562        )
563        assert_cache_control(f"/blockfilter/basic/{blockhash}", immutable, req_type=ReqType.BIN)
564        assert_cache_control(f"/blockfilter/basic/{blockhash}", immutable, req_type=ReqType.HEX)
565
566        # Mutable endpoints are not stored until validator support is available.
567        mutable_block = assert_cache_control(f"/block/{blockhash}", no_store)
568        assert_cache_control(f"/block/notxdetails/{blockhash}", no_store)
569        mutable_headers = assert_cache_control(
570            f"/headers/{blockhash}", no_store, req_type=ReqType.JSON, query_params={"count": 2}
571        )
572        assert_cache_control(f"/headers/{blockhash}", no_store, req_type=ReqType.BIN, query_params={"count": 1})
573        assert_cache_control(f"/headers/{blockhash}", no_store, req_type=ReqType.HEX, query_params={"count": 1})
574        assert_cache_control(f"/blockfilterheaders/basic/{blockhash}", no_store, req_type=ReqType.JSON, query_params={"count": 1})
575        assert_cache_control(f"/blockfilterheaders/basic/{blockhash}", no_store, req_type=ReqType.BIN, query_params={"count": 1})
576        assert_cache_control(f"/blockfilterheaders/basic/{blockhash}", no_store, req_type=ReqType.HEX, query_params={"count": 1})
577        assert_cache_control(f"/blockhashbyheight/{height}", no_store)
578        assert_cache_control(f"/blockhashbyheight/{height}", no_store, req_type=ReqType.BIN)
579        assert_cache_control(f"/blockhashbyheight/{height}", no_store, req_type=ReqType.HEX)
580
581        # Dynamic endpoints
582        mutable_chaininfo = assert_cache_control("/chaininfo", no_store)
583        assert_cache_control("/mempool/info", no_store)
584        mutable_deploymentinfo = assert_cache_control("/deploymentinfo", no_store)
585        immutable_deploymentinfo = assert_cache_control(f"/deploymentinfo/{blockhash}", immutable)
586
587        cache_tx = self.wallet.send_self_transfer(from_node=self.nodes[0])
588        mempool_txid = cache_tx["txid"]
589        cache_utxo = cache_tx["new_utxo"]
590        cache_utxo_path = f"/getutxos/{mempool_txid}-{cache_utxo['vout']}"
591
592        mempool_tx_response = assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.JSON)
593        mempool_tx = json.loads(mempool_tx_response, parse_float=Decimal)
594        assert "blockhash" not in mempool_tx
595        assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.BIN)
596        assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.HEX)
597
598        self.generate(self.nodes[0], 1)
599        sync_txindex(self, self.nodes[0])
600
601        self.log.info("Test Cache-Control response behavior across a newly mined block")
602        assert_equal(immutable_block, assert_cache_control(f"/block/{blockhash}", immutable, req_type=ReqType.BIN))
603        assert_equal(immutable_spenttxouts, assert_cache_control(f"/spenttxouts/{blockhash}", immutable))
604        assert_equal(
605            immutable_blockfilter,
606            assert_cache_control(f"/blockfilter/basic/{blockhash}", immutable, req_type=ReqType.JSON),
607        )
608        assert_equal(immutable_deploymentinfo, assert_cache_control(f"/deploymentinfo/{blockhash}", immutable))
609
610        # no-store responses need not change after every block. Only compare responses
611        # that are guaranteed to incorporate this active chain extension.
612        assert_not_equal(mutable_block, assert_cache_control(f"/block/{blockhash}", no_store))
613        assert_not_equal(
614            mutable_headers,
615            assert_cache_control(f"/headers/{blockhash}", no_store, req_type=ReqType.JSON, query_params={"count": 2}),
616        )
617        assert_not_equal(mutable_chaininfo, assert_cache_control("/chaininfo", no_store))
618        assert_not_equal(mutable_deploymentinfo, assert_cache_control("/deploymentinfo", no_store))
619
620        confirmed_tx_response = assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.JSON)
621        assert_not_equal(mempool_tx_response, confirmed_tx_response)
622        confirmed_tx = json.loads(confirmed_tx_response, parse_float=Decimal)
623        assert_equal(confirmed_tx["txid"], mempool_txid)
624        assert "blockhash" in confirmed_tx
625        assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.BIN)
626        assert_cache_control(f"/tx/{mempool_txid}", no_store, req_type=ReqType.HEX)
627        assert_cache_control(cache_utxo_path, no_store, req_type=ReqType.JSON)
628        assert_cache_control(cache_utxo_path, no_store, req_type=ReqType.BIN)
629        assert_cache_control(cache_utxo_path, no_store, req_type=ReqType.HEX)
630
631        self.log.info("Test Cache-Control headers on REST error responses")
632        assert_cache_control(f"/block/{blockhash}.invalid", no_store, status=400, req_type=None)
633        assert_cache_control(f"/tx/{INVALID_PARAM}", no_store, status=400)
634        assert_cache_control(f"/deploymentinfo/{INVALID_PARAM}", no_store, status=400)
635        assert_cache_control("/blockhashbyheight/999999999", no_store, status=404)
636        assert_cache_control(f"/block/{UNKNOWN_PARAM}", no_store, status=404)
637        assert_cache_control(f"/tx/{'f' * 64}", no_store, status=404)
638        assert_cache_control("", no_store, status=404, query_params={"x": 1}, req_type=None)
639        assert_cache_control("/tx", no_store, status=404, req_type=None)
640        assert_cache_control("/does-not-exist", no_store, status=404, req_type=None)
641        assert_cache_control("/mempool/not-a-valid-path", no_store, status=400)
642        assert_cache_control(f"/deploymentinfo/{non_existing_blockhash}", no_store, status=400)
643
644if __name__ == '__main__':
645    RESTTest(__file__).main()
646