nftpy 1.2.0b0

A NFT specific Python library for easy NFT integration in Python

nftpy

A Python package designed to facilitate the integration and adoption of NFT (ERC721, ERC1155) tokens in software applications.

Changes in 1.2

NFT Exchanges added

• Rarible | 1.2.0
  • Support for Eth
  • Support for Polygon interactions
• Mintable | 1.2.1
  • Support for Eth
  • Support for Polygon interactions
• Foundation | 1.2.2
  • Support for Eth
  • Support for Polygon interactions
• LooksRare | 1.2.3
  • Support for Eth interactions
• X2Y2 | 1.2.4
  • Support for Eth interactions
• SuperRare | 1.2.5
  • Support for Eth interactions
• Treasureland | 1.2.7
  • Support for Eth
  • Support for BSC interactions
• Decentraland | 1.2.8
  • Support for Eth interactions
• Zapper | 1.2.9
  • Support for Eth
  • Support for Polygon interactions

Features

EVM Interaction with NFT Tokens

nftpy enables interaction with the Ethereum Virtual Machine (EVM) through RPC to retrieve contract details and token holders. It provides a direct communication pathway between the client and the blockchain. Currently, transactional methods are not supported but will be implemented in future updates. The following methods are available:

• get_balance: Retrieve the balance of NFTs for a given address.
• get_token_uri: Fetch the metadata URI of a specific token.
• get_owner: Determine the owner of a specific token.
• get_approved: Get the approved address for a specific ERC721 token.
• is_approved_for_all: Check if an address is approved for all tokens owned by another address (ERC721).
• get_token_metadata: Get the metadata for a specific ERC721 token.
• get_token_balance: Get the balance of a specific ERC1155 token for a specific wallet address.
• get_tokens_balance: Gets the balance of a specific list of tokens.
• is_approved_for_all_erc1155: Check if an address is approved for all tokens owned by another address (ERC1155).

EVM Wallet Interaction

nftpy includes comprehensive features for interacting with Ethereum wallets, including querying balances, fetching gas prices, and transferring NFTs. The wallet interface supports both read-only and transactional operations.

Wallet Features:

• get_balance: Retrieve the balance of NFTs for a given address in Ether.
• get_balance_wei: Retrieve the balance of NFTs for a given address in Wei.
• get_gas_price_wei: Fetch the current gas price in Wei.
• get_gas_price_gwei: Fetch the current gas price in Gwei.
• transfer_nft: Transfer an NFT from the wallet to another address.
• wait_until_transaction_processes: Delays the program until the transaction has fully processed in the blockchain
• get_transaction_count: Get the number of transactions sent from the wallet.
• estimate_gas: Estimate the gas required for a transaction.
• is_synced: Check if the blockchain is synced.
• get_latest_block: Get the latest block on the blockchain.

Built-in OpenSea Interface

nftpy includes a built-in interface for interacting with OpenSea via an API key. This allows for in-package queries to OpenSea, enabling access to pricing information and other OpenSea-specific data. The OpenSea interface can be configured to focus on a single collection or query multiple collections. The available methods include:

• get_collection_stats: Obtain statistics for a collection.
• list_events_by_nft: List events related to a specific NFT.
• get_collection: Fetch details of a specific collection.
• get_contract: Retrieve details of a specific contract.
• get_nft: Get details of a specific NFT.
• list_nfts_by_account: List NFTs owned by a specific account.
• list_nfts_by_collection: List NFTs in a specific collection.
• list_nfts_by_contract: List NFTs under a specific contract.
• get_payment_token: Get details of a specific payment token.
• get_traits: Get traits of a specific collection.
• get_all_listings_on_collection: Get all listings of a specific collection.

Interacting with OpenSea API | nftpy.OpenSea

We will first start by creating our class with the following arguments:

• api_key: Your OpenSea API key.
• chain: The blockchain network (e.g., Ethereum, Polygon).
• collection_slug: The slug of the collection you want to query (the last part of the URL when browsing the collection on OpenSea). This assigns the interface to a specific collection. If you are using the interface to view multiple collections, then you should leave this blank.

Please Note: When defining the chain, it should be done with nftpy.OpenSea.OpenSeaChain as the API requires a special format for chain definition.

Initializing the OpenSea Class:

from nftpy.OpenSea import OpenSea, OpenSeaChain

opensea = OpenSea(api_key='your-opensea-api-key', chain=OpenSeaChain.POLYGON, collection_slug='your-collection-slug')

Custom Chain Support

nftpy allows the creation of custom chains with specific chain IDs, RPC URLs, explorer URLs, and names. This feature enhances flexibility by enabling the addition of blockchain networks that are not predefined in the library.

Creating a Custom Chain:

from nftpy.EVM import Chain

custom_chain = Chain(
        name = "Ethereum",
        symbol = "ETH",
        chain_id = 1,
        rpc_url = "https://eth.llamarpc.com",
        explorer_url = "https://etherscan.io",
        testnet = False
)

Example Usage

Interacting on-chain with a collection | nftpy.EVM.NFT

Using nftpy.EVM.NFT we are going to be querying the Pixelmon NFT collection on Ethereum mainnet! We will first start off by creating our class. We are going to define our class with three arguments:

• contract_address: The address of the contract you are trying to query.
• abi: The ABI of the contract you are trying to query. The EVM.ABI class provides presets for our ABI. You can also paste an ABI into the field.
• network: This dictates what RPC URL to use and sets a preset that works best with the network.
• rpc_url: If you do not want to use a preset and instead want to use a custom RPC, define it using this field.

import nftpy.EVM as EVM
Pixelmon = EVM.NFT("0x32973908FaeE0Bf825A343000fE412ebE56F802A", abi=EVM.ABI.ERC721, network=EVM.Chains.ETH)
#                   Contract Address                                ABI              Network To Query (Ethereum)

Now that we have created our NFT object, we can query it. We will start with getting the metadata of a token. I am just putting a random token as the argument.

print(Pixelmon.get_token_metadata(5580))

After running this we should see an output resembling this

{
  "name": "Pixelmon #5580",
  "image_url": "https://pixelmon-training-rewards.s3-accelerate.amazonaws.com/0/Moler.jpg",
  "external_url": "https://pixelmon.club/",
  "reward_bitmask": 6,
  "attributes": [
    {"trait_type": "Species", "value": "Moler"},
    {"trait_type": "Origin", "value": "Earth"},
    {"trait_type": "Rarity", "value": "Uncommon"},
    {"trait_type": "Evolution", "value": "Evolution 1"},
    {"trait_type": "Hatched On", "display_type": "date", "value": 1672272943}
  ],
  "animation_url": "https://pixelmon-training-rewards.s3-accelerate.amazonaws.com/6/Moler.mp4"
}

We can do a lot more with this. For example:

• Fetching the token URI
• Getting the owner of the token
• Getting the total balance of tokens for an address
• Getting the approved address and so much more.

print(Pixelmon.get_token_uri(5580))
print(Pixelmon.get_owner(5580))
print(Pixelmon.get_balance("0x5AF7875766D1a50d144DF63E581c0764f6573487"))
print(Pixelmon.get_approved(5580))

For ERC1155 tokens, you can query balances for multiple token IDs and check approvals:

erc1155_nft = EVM.NFT(contract_address='0xYourERC1155ContractAddress', network=EVM.Chains.ETH, abi=EVM.ABI.ERC1155)
wallet_address = '0xYourWalletAddress'
token_id = 1
token_ids = [1, 2, 3, 4, 5]

# Get the balance of a specific token owned by the wallet
token_balance = erc1155_nft.get_token_balance(wallet_address, token_id)
print(f'Token ID {token_id} Balance: {token_balance}')

# Get the balance of multiple tokens owned by the wallet
tokens_balance = erc1155_nft.get_tokens(wallet_address, token_ids)
print(f'Tokens Balance: {tokens_balance}')

# Check if an address is approved for all tokens (ERC1155)
is_approved_erc1155 = erc1155_nft.is_approved_for_all_erc1155(wallet_address, '0xOperatorAddress')
print(f'Is Approved For All (ERC1155): {is_approved_erc1155}')

Interacting with a Wallet | nftpy.NFTWallet

Creating an instance of NFTWallet requires either a private key for full access or just an address for read-only access. You can also specify multiple chains to connect to different networks simultaneously.

from nftpy import *

# Initialize the wallet with a private key and specify chains
wallet = NFTWallet(private_key="0x9015a0eb4c1ceab5f5544ac6e0a75eabb37d7dec26f1dfcb09adb43632330736", chains=[Chains.ETH_SEPOLIA])

# Get the balance of the wallet in Ether
print(wallet.get_balance()) 
# Output: {"Balances": {'Sepolia Testnet': Decimal('0.8341469847291797')}}

# Get the balance of the wallet in Wei
print(wallet.get_balance_wei()) 
# Output: {"Balances": {'Sepolia Testnet': 834146984729179700}}

# Get the current gas price in Wei
print(wallet.get_gas_price_wei()) 
# Output: {'Sepolia Testnet': 20000000000}

# Get the current gas price in Gwei
print(wallet.get_gas_price_gwei()) 
# Output: {'Sepolia Testnet': Decimal('20')}

# Transfer an NFT to another wallet
to_wallet = "0xa693190103733280E23055BE70C838d9b6708b9a"
contract = "0x725Ea5eEA79F1515e34A921b83D4307b325cC8b9"
gas_price = wallet.get_gas_price_gwei()["Sepolia Testnet"]
gas_limit = 65000   # Disclaimer! Gas Limit set for Sepolia, WILL fail on other networks

# Transfer the NFT and get the transaction hash and explorer URL
print(wallet.transfer_nft(to=to_wallet, contract_address=contract, amount=1, gas_limit=gas_limit,
                          gas_price_gwei=gas_price, abi=ABI.OPENSEA_ERC1155, token_id=1))
# Output: {'transaction_hash': '0x18a076a4a30c1cc014b1620aa907db06a04e8a709bda47e9beed2233a23f532f', 'explorer_url': 'https://sepolia.etherscan.io/tx/0x18a076a4a30c1cc014b1620aa907db06a04e8a709bda47e9beed2233a23f532f'}

Waiting For The Transaction To Process

After we get the transaction hash, we can have the program delay until the transaction processes on the blockchain.

# Wait until the transaction is processed
transaction_hash = "0xcd74c93bbf42cae24f329c45da995bde7e1c89ea848855d04db516c6460eda02"
print(wallet.wait_until_transaction_processes(transaction_hash, chain=Chains.ETH_SEPOLIA))
# Output: True | When the transaction fully processes on the blockchain

Read-Only Wallets

When using a read-only address (i.e., only providing an address and not a private key), you can still interact with the blockchain to query information, but you will not be able to perform transactions. This is useful for monitoring wallets and retrieving data without the need for sensitive credentials.

from nftpy import *

# Initialize the wallet with an address and specify chains
readonly_wallet = NFTWallet(address="0xYourReadOnlyWalletAddress", chains=[Chains.ETH_SEPOLIA])

# Get the balance of the wallet in Ether
print(readonly_wallet.get_balance()) 
# Output: {"Balances": {'Sepolia Testnet': Decimal('0.123456789012345678')}}

# Get the balance of the wallet in Wei
print(readonly_wallet.get_balance_wei()) 
# Output: {"Balances": {'Sepolia Testnet': 123456789012345678}}

# Get the current gas price in Wei
print(readonly_wallet.get_gas_price_wei()) 
# Output: {'Sepolia Testnet': 20000000000}

Interacting with OpenSea API | nftpy.OpenSea

We will first start by creating our class with the following arguments:

• api_key: Your OpenSea API key.
• chain: The blockchain network (e.g., Ethereum, Polygon).
• collection_slug: The slug of the collection you want to query (the last part of the url when browsing the collection on opensea) This assigns the interface to a specific collection. If you are using the interface to view multiple collections then you should leave this blank

Please Note: When defining the chain, it should be done with nftpy.OpenSea.Chain as the api requires a special format for chain definition

from nftpy import OpenSea, OpenSeaChain
opensea = OpenSea(api_key='your-opensea-api-key', chain=OpenSeaChain.POLYGON, collection_slug='your-collection-slug')

If we want to query the stats of the NFT collection we can run the following command. If you did not define a collection slug when initializing the interface you will need to define it inside this function

opensea.get_collection_stats()

After running that, we should see an output resembling this:

{
  "stats": {
    "one_day_volume": 12.34,
    "one_day_change": 0.56,
    "one_day_sales": 78,
    "one_day_average_price": 0.16,
    "total_volume": 1234.56,
    "total_sales": 7890,
    "total_supply": 10000,
    "count": 10000,
    "num_owners": 2345,
    "average_price": 0.123,
    "num_reports": 0,
    "market_cap": 4567.89,
    "floor_price": 0.123
  }
}

We can do a lot more with this. For example:

• Fetching details of a collection
• Getting details of a specific NFT
• Listing events related to a specific NFT
• Listing NFTs owned by an account

print(opensea.get_collection('your-collection-slug'))  # Fetch details of a collection
print(opensea.get_nft('0xYourContractAddress', '1'))  # Get details of a specific NFT
print(opensea.list_events_by_nft('0xYourContractAddress', '1'))  # List events related to a specific NFT
print(opensea.list_nfts_by_account('0xYourWalletAddress'))  # List NFTs owned by an account

Coming Soon

Marketplace Integration

Chain Integration | Coming in 2.0