mirror of
https://github.com/hwchase17/langchain
synced 2024-10-29 17:07:25 +00:00
ea64b1716d
The Blockchain Document Loader's default behavior is to return 100 tokens at a time which is the Alchemy API limit. The Document Loader exposes a startToken that can be used for pagination against the API. This enhancement includes an optional get_all_tokens param (default: False) which will: - Iterate over the Alchemy API until it receives all the tokens, and return the tokens in a single call to the loader. - Manage all/most tokenId formats (this can be int, hex16 with zero or all the leading zeros). There aren't constraints as to how smart contracts can represent this value, but these three are most common. Note that a contract with 10,000 tokens will issue 100 calls to the Alchemy API, and could take about a minute, which is why this param will default to False. But I've been using the doc loader with these utilities on the side, so figured it might make sense to build them in for others to use.
125 lines
3.7 KiB
Python
125 lines
3.7 KiB
Python
import os
|
|
import time
|
|
|
|
import pytest
|
|
|
|
from langchain.document_loaders import BlockchainDocumentLoader
|
|
from langchain.document_loaders.blockchain import BlockchainType
|
|
|
|
if "ALCHEMY_API_KEY" in os.environ:
|
|
alchemyKeySet = True
|
|
apiKey = os.environ["ALCHEMY_API_KEY"]
|
|
else:
|
|
alchemyKeySet = False
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_nfts_valid_contract() -> None:
|
|
max_alchemy_tokens = 100
|
|
contract_address = (
|
|
"0x1a92f7381b9f03921564a437210bb9396471050c" # CoolCats contract address
|
|
)
|
|
result = BlockchainDocumentLoader(contract_address).load()
|
|
|
|
print("Tokens returend for valid contract: ", len(result))
|
|
|
|
assert len(result) == max_alchemy_tokens, (
|
|
f"Wrong number of NFTs returned. "
|
|
f"Expected {max_alchemy_tokens}, got {len(result)}"
|
|
)
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_nfts_with_pagination() -> None:
|
|
contract_address = (
|
|
"0x1a92f7381b9f03921564a437210bb9396471050c" # CoolCats contract address
|
|
)
|
|
startToken = "0x0000000000000000000000000000000000000000000000000000000000000077"
|
|
|
|
result = BlockchainDocumentLoader(
|
|
contract_address,
|
|
BlockchainType.ETH_MAINNET,
|
|
api_key=apiKey,
|
|
startToken=startToken,
|
|
).load()
|
|
|
|
print("Tokens returend for contract with offset: ", len(result))
|
|
|
|
assert len(result) > 0, "No NFTs returned"
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_nfts_polygon() -> None:
|
|
contract_address = (
|
|
"0x448676ffCd0aDf2D85C1f0565e8dde6924A9A7D9" # Polygon contract address
|
|
)
|
|
result = BlockchainDocumentLoader(
|
|
contract_address, BlockchainType.POLYGON_MAINNET
|
|
).load()
|
|
|
|
print("Tokens returend for contract on Polygon: ", len(result))
|
|
|
|
assert len(result) > 0, "No NFTs returned"
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_nfts_invalid_contract() -> None:
|
|
contract_address = (
|
|
"0x111D4e82EA7eCA7F62c3fdf6D39A541be95Bf111" # Invalid contract address
|
|
)
|
|
|
|
with pytest.raises(ValueError) as error_NoNfts:
|
|
BlockchainDocumentLoader(contract_address).load()
|
|
|
|
assert (
|
|
str(error_NoNfts.value)
|
|
== "No NFTs found for contract address " + contract_address
|
|
)
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_all() -> None:
|
|
start_time = time.time()
|
|
|
|
contract_address = (
|
|
"0x448676ffCd0aDf2D85C1f0565e8dde6924A9A7D9" # Polygon contract address
|
|
)
|
|
result = BlockchainDocumentLoader(
|
|
contract_address=contract_address,
|
|
blockchainType=BlockchainType.POLYGON_MAINNET,
|
|
api_key=os.environ["ALCHEMY_API_KEY"],
|
|
startToken="100",
|
|
get_all_tokens=True,
|
|
).load()
|
|
|
|
end_time = time.time()
|
|
|
|
print(
|
|
f"Tokens returned for {contract_address} "
|
|
f"contract: {len(result)} in {end_time - start_time} seconds"
|
|
)
|
|
|
|
assert len(result) > 0, "No NFTs returned"
|
|
|
|
|
|
@pytest.mark.skipif(not alchemyKeySet, reason="Alchemy API key not provided.")
|
|
def test_get_all_10sec_timeout() -> None:
|
|
start_time = time.time()
|
|
|
|
contract_address = (
|
|
"0x1a92f7381b9f03921564a437210bb9396471050c" # Cool Cats contract address
|
|
)
|
|
|
|
with pytest.raises(RuntimeError):
|
|
BlockchainDocumentLoader(
|
|
contract_address=contract_address,
|
|
blockchainType=BlockchainType.ETH_MAINNET,
|
|
api_key=os.environ["ALCHEMY_API_KEY"],
|
|
get_all_tokens=True,
|
|
max_execution_time=10,
|
|
).load()
|
|
|
|
end_time = time.time()
|
|
|
|
print("Execution took ", end_time - start_time, " seconds")
|