python: Add Connection.get_ledger_end.

Author: da-tanabe

VERSION

@@ -1 +1 @@
-7.8.1
+7.8.2

poetry.lock

@@ -3,7 +3,7 @@
 
 [tool.poetry]
 name = "dazl"
-version = "7.8.1"
+version = "7.8.2"
 description = "high-level Ledger API client for Daml ledgers"
 license = "Apache-2.0"
 authors = ["Davin K. Tanabe <davin.tanabe@digitalasset.com>"]
@@ -23,7 +23,7 @@ googleapis_common_protos = "^1"
 grpcio = ">=1.32.0"
 oauthlib = { version = "*", optional = true }
 prometheus_client = { version = "*", optional = true }
-protobuf = ">=3.19.0, <=3.20"
+protobuf = ">=3.19.0, <4"
 pygments = { version = "*", optional = true }
 pyOpenSSL = { version = "*", optional = true }
 requests = "*"

pyproject.toml

@@ -304,6 +304,7 @@ class Connection(PackageService, Protocol):
         read_as: Union[None, Party, Collection[Party]] = None,
         act_as: Union[None, Party, Collection[Party]] = None,
     ) -> Union[None, Awaitable[None]]: ...
+    def get_ledger_end(self) -> Union[str, Awaitable[str]]: ...
     def archive(
         self,
         __contract_id: ContractId,

python/dazl/ledger/__init__.pyi

@@ -169,6 +169,7 @@ class Connection(_Connection, PackageService, Protocol):
         read_as: Union[None, Party, Collection[Party]] = None,
         act_as: Union[None, Party, Collection[Party]] = None,
     ) -> ArchiveEvent: ...
+    async def get_ledger_end(self) -> str: ...
     def query(
         self,
         __template_id: Union[str, TypeConName] = "*",

python/dazl/ledger/aio/__init__.pyi

@@ -118,6 +118,7 @@ class Connection(_Connection, PackageService, Protocol):
         read_as: Union[None, Party, Collection[Party]] = None,
         act_as: Union[None, Party, Collection[Party]] = None,
     ) -> ArchiveEvent: ...
+    def get_ledger_end(self) -> str: ...
     def query(
         self,
         __template_id: Union[str, TypeConName] = "*",

python/dazl/ledger/blocking/__init__.pyi

@@ -82,6 +82,10 @@ def archive_by_key(self, *args, **kwargs):
         fut = run_coroutine_threadsafe(self._conn.archive_by_key(*args, **kwargs), self._loop)
         return fut.result()
 
+    def get_ledger_end(self, *args, **kwargs):
+        fut = run_coroutine_threadsafe(self._conn.get_ledger_end(*args, **kwargs), self._loop)
+        return fut.result()
+
     def query(self, *args, **kwargs):
         return QueryStreamThunk(self._conn.query(*args, **kwargs), self._loop)
 

python/dazl/ledger/blocking/_aiowrapper.py

@@ -552,6 +552,16 @@ def _command_meta(
 
     # region Read API
 
+    async def get_ledger_end(self) -> "str":
+        """
+        Return the offset at the end of the ledger.
+        """
+        stub = lapipb.TransactionServiceStub(self.channel)
+
+        request = lapipb.GetLedgerEndRequest(ledger_id=self._config.access.ledger_id)
+        response = await stub.GetLedgerEnd(request)
+        return response.offset.absolute
+
     def query(
         self,
         __template_id: Union[str, TypeConName] = "*",

python/dazl/ledger/grpc/conn_aio.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2017-2022 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+import dazl
+import pytest
+
+
+@pytest.mark.asyncio
+async def test_ledger_end(sandbox) -> None:
+    async with dazl.connect(url=sandbox, admin=True) as conn:
+        actual = await conn.get_ledger_end()
+
+    # the actual offset is unpredictable, but it will always be defined and non-empty
+    assert actual