[CI] Fix devnet examples to use an API key

.github/workflows/devnet-examples.yaml

@@ -13,6 +13,7 @@ jobs:
       APTOS_FAUCET_URL: https://faucet.devnet.aptoslabs.com
       APTOS_INDEXER_URL: https://api.devnet.aptoslabs.com/v1/graphql
       APTOS_NODE_URL: https://fullnode.devnet.aptoslabs.com/v1
+      API_KEY: ${{ secrets.DEVNET_API_KEY }}
       FAUCET_AUTH_TOKEN: ${{ secrets.DEVNET_FAUCET_AUTH_TOKEN }}
     steps:
       - uses: actions/checkout@v4

examples/aptos_token.py

@@ -6,13 +6,13 @@
 from aptos_sdk.account import Account
 from aptos_sdk.account_address import AccountAddress
 from aptos_sdk.aptos_token_client import AptosTokenClient, Object, Property, PropertyMap
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 
-from .common import FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_URL, NODE_URL
 
 
 async def main():
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client)
     token_client = AptosTokenClient(rest_client)
     alice = Account.generate()

examples/common.py

@@ -19,4 +19,6 @@
     "https://api.devnet.aptoslabs.com/v1/graphql",
 )
 NODE_URL = os.getenv("APTOS_NODE_URL", "https://api.devnet.aptoslabs.com/v1")
+
+API_KEY = os.getenv("API_KEY")
 # <:!:section_1

examples/fee_payer_transfer_coin.py

@@ -4,7 +4,7 @@
 import asyncio
 
 from aptos_sdk.account import Account
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.authenticator import Authenticator, FeePayerAuthenticator
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.transactions import (
@@ -15,12 +15,12 @@
     TransactionPayload,
 )
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main():
     # :!:>section_1
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1

examples/hello_blockchain.py

@@ -21,7 +21,12 @@
 from aptos_sdk.account import Account
 from aptos_sdk.account_address import AccountAddress
 from aptos_sdk.aptos_cli_wrapper import AptosCLIWrapper
-from aptos_sdk.async_client import FaucetClient, ResourceNotFound, RestClient
+from aptos_sdk.async_client import (
+    ClientConfig,
+    FaucetClient,
+    ResourceNotFound,
+    RestClient,
+)
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.package_publisher import PackagePublisher
 from aptos_sdk.transactions import (
@@ -30,7 +35,7 @@
     TransactionPayload,
 )
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 class HelloBlockchainClient(RestClient):
@@ -64,7 +69,7 @@ async def set_message(
 
 async def publish_contract(package_dir: str) -> AccountAddress:
     contract_publisher = Account.generate()
-    rest_client = HelloBlockchainClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
     await faucet_client.fund_account(contract_publisher.address(), 10_000_000)
 

examples/large_package_publisher.py

@@ -19,11 +19,11 @@
 from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.package_publisher import MODULE_ADDRESS, PackagePublisher
 
-from .common import APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def publish_large_packages(large_packages_dir) -> AccountAddress:
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     alice = Account.generate()
@@ -41,7 +41,7 @@ async def main(
     client_config = ClientConfig()
     client_config.transaction_wait_in_seconds = 120
     client_config.max_gas_amount = 1_000_000
-    rest_client = RestClient(NODE_URL, client_config)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     alice = Account.generate()

examples/multikey.py

@@ -7,7 +7,7 @@
 from aptos_sdk.account import Account
 from aptos_sdk.account_address import AccountAddress
 from aptos_sdk.asymmetric_crypto_wrapper import MultiSignature, Signature
-from aptos_sdk.async_client import FaucetClient, IndexerClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, IndexerClient, RestClient
 from aptos_sdk.authenticator import AccountAuthenticator, MultiKeyAuthenticator
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.transactions import (
@@ -17,12 +17,12 @@
     TransactionPayload,
 )
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, INDEXER_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, INDEXER_URL, NODE_URL
 
 
 async def main():
     # :!:>section_1
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1

examples/multisig.py

@@ -7,7 +7,7 @@
 
 from aptos_sdk.account import Account, RotationProofChallenge
 from aptos_sdk.account_address import AccountAddress
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.authenticator import Authenticator, MultiEd25519Authenticator
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.ed25519 import MultiPublicKey, MultiSignature
@@ -22,7 +22,7 @@
 )
 from aptos_sdk.type_tag import StructTag, TypeTag
 
-from .common import APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 should_wait = True
 
@@ -37,7 +37,7 @@ async def main(should_wait_input=True):
     global should_wait
     should_wait = should_wait_input
 
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     # :!:>section_1

examples/object_code_deployment.py

@@ -7,14 +7,14 @@
 
 from aptos_sdk.account import Account
 from aptos_sdk.aptos_cli_wrapper import AptosCLIWrapper
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.package_publisher import MODULE_ADDRESS, PackagePublisher, PublishMode
 
-from .common import APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, APTOS_CORE_PATH, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main(package_dir):
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
     package_publisher = PackagePublisher(rest_client)
     alice = Account.generate()

examples/read_aggregator.py

@@ -4,13 +4,13 @@
 import asyncio
 
 from aptos_sdk.account_address import AccountAddress
-from aptos_sdk.async_client import RestClient
+from aptos_sdk.async_client import ClientConfig, RestClient
 
-from .common import NODE_URL
+from .common import API_KEY, NODE_URL
 
 
 async def main():
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     total_apt = await rest_client.aggregator_value(
         AccountAddress.from_str("0x1"),
         "0x1::coin::CoinInfo<0x1::aptos_coin::AptosCoin>",

examples/rotate_key.py

@@ -5,7 +5,7 @@
 import aptos_sdk.ed25519 as ed25519
 from aptos_sdk.account import Account, RotationProofChallenge
 from aptos_sdk.account_address import AccountAddress
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.authenticator import Authenticator
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.transactions import (
@@ -14,7 +14,7 @@
     TransactionPayload,
 )
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 WIDTH = 19
 
@@ -124,7 +124,7 @@ def rotation_payload(
 
 async def main():
     # Initialize the clients used to interact with the blockchain
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     # Generate random accounts Alice and Bob

examples/secp256k1_ecdsa_transfer_coin.py

@@ -4,14 +4,14 @@
 import asyncio
 
 from aptos_sdk.account import Account
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main():
     # :!:>section_1
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1

examples/simple_aptos_token.py

@@ -14,9 +14,9 @@
     ReadObject,
     Token,
 )
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 def get_owner(obj: ReadObject) -> AccountAddress:
@@ -53,7 +53,7 @@ async def get_token_data(
 async def main():
     # Create API and faucet clients.
     # :!:>section_1a
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1a

examples/simple_nft.py

@@ -6,13 +6,13 @@
 
 from aptos_sdk.account import Account
 from aptos_sdk.aptos_tokenv1_client import AptosTokenV1Client
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main():
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
     token_client = AptosTokenV1Client(rest_client)
 

examples/simulate_transfer_coin.py

@@ -5,7 +5,7 @@
 import json
 
 from aptos_sdk.account import Account
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.transactions import (
     EntryFunction,
@@ -14,11 +14,11 @@
 )
 from aptos_sdk.type_tag import StructTag, TypeTag
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main():
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1

examples/transaction_batching.py

@@ -24,15 +24,16 @@
     TransactionPayload,
 )
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 def generate_rest_client(node_url: str) -> RestClient:
     client_config = ClientConfig()
     client_config.http2 = True
     client_config.max_gas_amount = 100
     client_config.transaction_wait_in_seconds = 60
-    return RestClient(NODE_URL, client_config)
+    client_config.api_key = API_KEY
+    return RestClient(node_url, client_config)
 
 
 class TransactionGenerator:

examples/transfer_coin.py

@@ -4,14 +4,14 @@
 import asyncio
 
 from aptos_sdk.account import Account
-from aptos_sdk.async_client import FaucetClient, IndexerClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, IndexerClient, RestClient
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, INDEXER_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, INDEXER_URL, NODE_URL
 
 
 async def main():
     # :!:>section_1
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(
         FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN
     )  # <:!:section_1

examples/transfer_two_by_two.py

@@ -5,14 +5,14 @@
 import os
 
 from aptos_sdk.account import Account
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.transactions import Script, ScriptArgument, TransactionPayload
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 async def main():
-    rest_client = RestClient(NODE_URL)
+    rest_client = RestClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     alice = Account.generate()

examples/your_coin.py

@@ -18,7 +18,7 @@
 from aptos_sdk.account import Account
 from aptos_sdk.account_address import AccountAddress
 from aptos_sdk.aptos_cli_wrapper import AptosCLIWrapper
-from aptos_sdk.async_client import FaucetClient, RestClient
+from aptos_sdk.async_client import ClientConfig, FaucetClient, RestClient
 from aptos_sdk.bcs import Serializer
 from aptos_sdk.package_publisher import PackagePublisher
 from aptos_sdk.transactions import (
@@ -28,7 +28,7 @@
 )
 from aptos_sdk.type_tag import StructTag, TypeTag
 
-from .common import FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
+from .common import API_KEY, FAUCET_AUTH_TOKEN, FAUCET_URL, NODE_URL
 
 
 class CoinClient(RestClient):
@@ -87,7 +87,7 @@ async def main(moon_coin_path: str):
     print(f"Alice: {alice.address()}")
     print(f"Bob: {bob.address()}")
 
-    rest_client = CoinClient(NODE_URL)
+    rest_client = CoinClient(NODE_URL, client_config=ClientConfig(api_key=API_KEY))
     faucet_client = FaucetClient(FAUCET_URL, rest_client, FAUCET_AUTH_TOKEN)
 
     alice_fund = faucet_client.fund_account(alice.address(), 20_000_000)