nftpy
1.0.0
Пакет Python, предназначенный для облегчения интеграции и принятия токенов NFT (ERC721, ERC1155) в программных приложениях.
В 1.2.2A1 классы выходных данных интегрированы, но все функции возвращают необработанные
NFTPY позволяет взаимодействовать с виртуальной машиной Ethereum (EVM) через RPC, чтобы получить детали контракта и держателей токенов. Он обеспечивает прямой путь связи между клиентом и блокчейном. В настоящее время транзакционные методы не поддерживаются, но будут реализованы в будущих обновлениях. Доступны следующие методы:
NFTPY включает в себя всеобъемлющие функции для взаимодействия с кошельками Ethereum, в том числе остатки запроса, получение цен на газ и передачу NFT. Интерфейс кошелька поддерживает как только для чтения, так и транзакционные операции.
Особенности кошелька:
NFTPY включает в себя встроенный интерфейс для взаимодействия с OpenSEA через ключ API. Это позволяет запрашивать запросы в Package для OpenSEA, что обеспечивает доступ к информации о ценах и другим данным, специфичным для открытия. Интерфейс OpenSea может быть настроен, чтобы сосредоточиться на одной коллекции или нескольких коллекциях. Доступные методы включают в себя:
Открытый класс:
Класс OpenSeAcollection:
OpenSeaWallet Class:
NFTPY включает в себя комплексный интерфейс для взаимодействия с редкости через ключ API. Это позволяет запросить на упаковке редко, что обеспечивает доступ к информации NFT, рыночным данным и многим другим. Доступные методы включают в себя:
РАЗРИЧЕСКИЙ КЛАСС:
NFTPY позволяет создавать пользовательские цепочки с конкретными идентификаторами цепи, URL -адреса RPC, URL -адресами исследователей и именами. Эта функция повышает гибкость, позволяя добавить сетей блокчейна, которые не предопределены в библиотеке.
Создание пользовательской цепочки:
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
)Используя nftpy.evm.nft, мы собираемся запросить коллекцию Pixelmon NFT на Ethereum Mainnet! Сначала мы начнем с создания нашего класса. Мы собираемся определить наш класс с тремя аргументами:
import nftpy . EVM as EVM
Pixelmon = EVM . NFT ( "0x32973908FaeE0Bf825A343000fE412ebE56F802A" , abi = EVM . ABI . ERC721 , network = EVM . Chains . ETH )
# Contract Address ABI Network To Query (Ethereum)Теперь, когда мы создали наш объект NFT, мы можем запросить его. Мы начнем с получения метаданных токена. Я просто ставлю случайный токен в качестве аргумента.
print ( Pixelmon . get_token_metadata ( 5580 ))После запуска мы должны увидеть выход, напоминающий это
{
"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 "
}
Мы можем сделать с этим гораздо больше. Например:
print ( Pixelmon . get_token_uri ( 5580 ))
print ( Pixelmon . get_owner ( 5580 ))
print ( Pixelmon . get_balance ( "0x5AF7875766D1a50d144DF63E581c0764f6573487" ))
print ( Pixelmon . get_approved ( 5580 ))Для токенов ERC1155 вы можете запросить балансы для нескольких идентификаторов токенов и проверить разрешения:
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 } ' ) Создание экземпляра NFTWallet требует либо закрытого ключа для полного доступа, либо только адрес для доступа только для чтения. Вы также можете указать несколько цепей для подключения к различным сетям одновременно.
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'} После того, как мы получим хэш транзакций, мы можем иметь задержку программы до тех пор, пока транзакция не будет процессами на блокчейне.
# 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 При использовании адреса только для чтения (т.е. только предоставление адреса, а не закрытого ключа), вы все равно можете взаимодействовать с блокчейном, чтобы запросить информацию, но вы не сможете выполнять транзакции. Это полезно для мониторинга кошельков и получения данных без необходимости конфиденциальных учетных данных.
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}Сначала начнем с создания нашего класса со следующими аргументами:
Обратите внимание : при определении цепочки это должно быть сделано с помощью nftpy.OpenSea.OpenSeaChain поскольку API требует специального формата для определения цепи.
from nftpy import OpenSea , OpenSeaChain
opensea = OpenSea ( api_key = 'your-opensea-api-key' , chain = OpenSeaChain . POLYGON )Чтобы запросить статистику коллекции NFT, используйте следующий метод:
opensea . get_collection_stats ( 'your-collection-slug' )После запуска мы должны увидеть выход, напоминающий это:
{
"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
}
}Чтобы получить детали коллекции, используйте следующий метод:
opensea . get_collection ( 'your-collection-slug' )Чтобы получить подробную информацию о конкретном NFT, используйте следующий метод:
opensea . get_nft ( '0xYourContractAddress' , '1' )Чтобы перечислить события, связанные с конкретным NFT, используйте следующий метод:
opensea . list_events_by_nft ( '0xYourContractAddress' , '1' )Чтобы перечислить NFT, принадлежащие конкретной учетной записи, используйте следующий метод:
opensea . list_nfts_by_account ( '0xYourWalletAddress' )Чтобы управлять коллекцией, создайте экземпляр класса OpenSeAcollection :
from nftpy import OpenSeaCollection
collection = OpenSeaCollection ( collection_name = 'your-collection-name' , api_key = 'your-api-key' )Чтобы получить подробную информацию о конкретной коллекции, используйте следующий метод:
details = collection . get_collection_details ()Чтобы перечислить все NFT в сборе, используйте следующий метод:
nfts = collection . get_nfts ()Чтобы управлять кошельком, создайте экземпляр класса OpenSeaWallet :
from nftpy import OpenSeaWallet
wallet = OpenSeaWallet ( address = 'your-wallet-address' , api_key = 'your-api-key' )Чтобы проверить баланс кошелька, используйте следующий метод:
balance = wallet . get_balance ()Чтобы получить все NFT, принадлежащие кошельку, используйте следующий метод:
nfts = wallet . get_nfts ()Сначала начнем с создания нашего класса со следующими аргументами:
Обратите внимание : при определении цепочки это должно быть сделано с помощью nftpy.rarible.rariblechain , поскольку API требует специального формата для определения цепи.
from nftpy import Rarible , RaribleChain
rarible = Rarible ( api_key = 'your-rarible-api-key' , chain = RaribleChain . ETHEREUM )Чтобы получить подробную информацию о конкретном элементе по его идентификатору, используйте следующий метод:
rarible . get_item_by_id ( 'item_id' )Чтобы получить подробности нескольких элементов по их идентификаторам, используйте следующий метод:
rarible . get_items_by_ids ([ 'item_id1' , 'item_id2' ])Чтобы получить информацию о роялти для конкретного элемента по его идентификатору, используйте следующий метод:
rarible . get_item_royalties_by_id ( 'item_id' )Для извлечения элементов, принадлежащих конкретному адресу, используйте следующий метод:
rarible . get_items_by_owner ( 'owner_address' )Чтобы проверить подпись для данного набора данных, используйте следующий метод:
rarible . validate_signature ( data = { 'your' : 'data' })Чтобы получить входные данные, необходимые для генерации подписи, используйте следующий метод:
rarible . get_signature_input ( data = { 'your' : 'data' })Чтобы кодировать данные для редкого протокола, используйте следующий метод:
rarible . encode_data ( data = { 'your' : 'data' })Чтобы получить обменный курс доллара США за определенную валюту, используйте следующий метод:
rarible . get_usd_rate ( 'currency' )Чтобы получить все поддерживаемые валюты, используйте следующий метод:
rarible . get_all_currencies ()Чтобы получить баланс конкретного пользователя в указанной валюте, используйте следующий метод:
rarible . get_user_balance ( 'user_address' , 'currency' )
