-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
use dns resolver to get account key (#12)
* use dns resolver to get account key * add comment for get_key() * remove default value for first_mapping_account_key in PythClient * remove unused import Mock * add test for utils * add dnspython dependency * change fixture name * change fixture name in arguments
- Loading branch information
Showing
6 changed files
with
138 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import ast | ||
import dns.resolver | ||
from loguru import logger | ||
from typing import Optional | ||
|
||
DEFAULT_VERSION = "v2" | ||
|
||
|
||
# Retrieving keys via DNS TXT records should not be considered secure and is provided as a convenience only. | ||
# Accounts should be stored locally and verified before being used for production. | ||
def get_key(network: str, type: str, version: str = DEFAULT_VERSION) -> Optional[str]: | ||
""" | ||
Get the program or mapping keys from dns TXT records. | ||
Example dns records: | ||
devnet-program-v2.pyth.network | ||
mainnet-program-v2.pyth.network | ||
testnet-mapping-v2.pyth.network | ||
""" | ||
url = f"{network}-{type}-{version}.pyth.network" | ||
try: | ||
answer = dns.resolver.resolve(url, "TXT") | ||
except dns.resolver.NXDOMAIN: | ||
logger.error("TXT record for {} not found", url) | ||
return "" | ||
if len(answer) != 1: | ||
logger.error("Invalid number of records returned for {}!", url) | ||
return "" | ||
# Example of the raw_key: | ||
# "program=FsJ3A3u2vn5cTVofAjvy6y5kwABJAqYWpe4975bi2epH" | ||
raw_key = ast.literal_eval(list(answer)[0].to_text()) | ||
# program=FsJ3A3u2vn5cTVofAjvy6y5kwABJAqYWpe4975bi2epH" | ||
_, key = raw_key.split("=", 1) | ||
return key |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
from _pytest.logging import LogCaptureFixture | ||
import pytest | ||
|
||
from pytest_mock import MockerFixture | ||
|
||
from mock import Mock | ||
|
||
import dns.resolver | ||
import dns.rdatatype | ||
import dns.rdataclass | ||
import dns.message | ||
import dns.rrset | ||
import dns.flags | ||
|
||
from pythclient.utils import get_key | ||
|
||
|
||
@pytest.fixture() | ||
def answer_program() -> dns.resolver.Answer: | ||
qname = dns.name.Name(labels=(b'devnet-program-v2', b'pyth', b'network', b'')) | ||
rdtype = dns.rdatatype.TXT | ||
rdclass = dns.rdataclass.IN | ||
response = dns.message.QueryMessage(id=0) | ||
response.flags = dns.flags.QR | ||
rrset_qn = dns.rrset.from_text(qname, 100, rdclass, rdtype) | ||
rrset_ans = dns.rrset.from_text(qname, 100, rdclass, rdtype, '"program=gSbePebfvPy7tRqimPoVecS2UsBvYv46ynrzWocc92s"') | ||
response.question = [rrset_qn] | ||
response.answer = [rrset_ans] | ||
answer = dns.resolver.Answer( | ||
qname=qname, rdtype=rdtype, rdclass=rdclass, response=response) | ||
answer.rrset = rrset_ans | ||
return answer | ||
|
||
|
||
@pytest.fixture() | ||
def answer_mapping() -> dns.resolver.Answer: | ||
qname = dns.name.Name(labels=(b'devnet-mapping-v2', b'pyth', b'network', b'')) | ||
rdtype = dns.rdatatype.TXT | ||
rdclass = dns.rdataclass.IN | ||
response = dns.message.QueryMessage(id=0) | ||
response.flags = dns.flags.QR | ||
rrset_qn = dns.rrset.from_text(qname, 100, rdclass, rdtype) | ||
rrset_ans = dns.rrset.from_text(qname, 100, rdclass, rdtype, '"mapping=BmA9Z6FjioHJPpjT39QazZyhDRUdZy2ezwx4GiDdE2u2"') | ||
response.question = [rrset_qn] | ||
response.answer = [rrset_ans] | ||
answer = dns.resolver.Answer( | ||
qname=qname, rdtype=rdtype, rdclass=rdclass, response=response) | ||
answer.rrset = rrset_ans | ||
return answer | ||
|
||
|
||
@pytest.fixture() | ||
def mock_dns_resolver_resolve(mocker: MockerFixture) -> Mock: | ||
mock = Mock() | ||
mocker.patch('dns.resolver.resolve', side_effect=mock) | ||
return mock | ||
|
||
|
||
def test_utils_get_program_key(mock_dns_resolver_resolve: Mock, answer_program: dns.resolver.Answer) -> None: | ||
mock_dns_resolver_resolve.return_value = answer_program | ||
program_key = get_key("devnet", "program") | ||
assert program_key == "gSbePebfvPy7tRqimPoVecS2UsBvYv46ynrzWocc92s" | ||
|
||
|
||
def test_utils_get_mapping_key(mock_dns_resolver_resolve: Mock, answer_mapping: dns.resolver.Answer) -> None: | ||
mock_dns_resolver_resolve.return_value = answer_mapping | ||
mapping_key = get_key("devnet", "mapping") | ||
assert mapping_key == "BmA9Z6FjioHJPpjT39QazZyhDRUdZy2ezwx4GiDdE2u2" | ||
|
||
|
||
def test_utils_get_mapping_key_not_found(mock_dns_resolver_resolve: Mock, | ||
answer_mapping: dns.resolver.Answer, | ||
caplog: LogCaptureFixture) -> None: | ||
mock_dns_resolver_resolve.side_effect = dns.resolver.NXDOMAIN | ||
exc_message = f'TXT record for {str(answer_mapping.response.canonical_name())[:-1]} not found' | ||
key = get_key("devnet", "mapping") | ||
assert exc_message in caplog.text | ||
assert key == "" | ||
|
||
|
||
def test_utils_get_mapping_key_invalid_number(mock_dns_resolver_resolve: Mock, | ||
answer_mapping: dns.resolver.Answer, | ||
caplog: LogCaptureFixture) -> None: | ||
answer_mapping.rrset = None | ||
mock_dns_resolver_resolve.return_value = answer_mapping | ||
exc_message = f'Invalid number of records returned for {str(answer_mapping.response.canonical_name())[:-1]}!' | ||
key = get_key("devnet", "mapping") | ||
assert exc_message in caplog.text | ||
assert key == "" |