nftpy
1.0.0
Um pacote Python projetado para facilitar os tokens de integração e adoção da NFT (ERC721, ERC1155) em aplicativos de software.
Em 1.2.2a1, as classes de saída são integradas, mas todas as funções retornam cru
O NFTPY permite a interação com a Ethereum Virtual Machine (EVM) através do RPC para recuperar detalhes do contrato e titulares de token. Ele fornece uma via de comunicação direta entre o cliente e o blockchain. Atualmente, os métodos transacionais não são suportados, mas serão implementados em atualizações futuras. Os seguintes métodos estão disponíveis:
O NFTPY inclui recursos abrangentes para interagir com carteiras Ethereum, incluindo saldos de consulta, buscar preços de gás e transferir NFTs. A interface da carteira suporta operações somente leitura e transacional.
Carteira dos recursos:
O NFTPY inclui uma interface embutida para interagir com o OpenSea por meio de uma chave da API. Isso permite que as consultas no pacote sejam abertas, permitindo o acesso a informações de preços e outros dados específicos do OpenSea. A interface OpenSea pode ser configurada para se concentrar em uma única coleção ou consulta várias coleções. Os métodos disponíveis incluem:
Aula de openSea:
Classe OpenSeacollection:
Classe OpenSeawallet:
O NFTPY inclui uma interface abrangente para interagir com o rarível por meio de uma chave de API. Isso permite que as consultas no pacote raras, permitindo acesso a informações da NFT, dados de mercado e muito mais. Os métodos disponíveis incluem:
Classe rarível:
O NFTPY permite a criação de cadeias personalizadas com IDs de cadeia específicos, URLs de RPC, URLs de explorador e nomes. Esse recurso aprimora a flexibilidade, permitindo a adição de redes blockchain que não são predefinidas na biblioteca.
Criando uma cadeia personalizada:
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
)Usando nftpy.evm.nft, vamos consultar a coleção Pixelmon NFT no Ethereum Mainnet! Começaremos pela primeira vez criando nossa classe. Vamos definir nossa classe com três argumentos:
import nftpy . EVM as EVM
Pixelmon = EVM . NFT ( "0x32973908FaeE0Bf825A343000fE412ebE56F802A" , abi = EVM . ABI . ERC721 , network = EVM . Chains . ETH )
# Contract Address ABI Network To Query (Ethereum)Agora que criamos nosso objeto NFT, podemos consultá -lo. Começaremos com os metadados de um token. Estou apenas colocando um token aleatório como argumento.
print ( Pixelmon . get_token_metadata ( 5580 ))Depois de executar isso, devemos ver uma saída parecida com isso
{
"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 "
}
Podemos fazer muito mais com isso. Por exemplo:
print ( Pixelmon . get_token_uri ( 5580 ))
print ( Pixelmon . get_owner ( 5580 ))
print ( Pixelmon . get_balance ( "0x5AF7875766D1a50d144DF63E581c0764f6573487" ))
print ( Pixelmon . get_approved ( 5580 ))Para os tokens ERC1155, você pode consultar saldos para vários IDs de token e verificar as aprovações:
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 } ' ) Criar uma instância do NFTWallet requer uma chave privada para acesso total ou apenas um endereço para acesso somente leitura. Você também pode especificar várias cadeias para se conectar a diferentes redes simultaneamente.
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'} Depois de obter o hash da transação, podemos ter o atraso do programa até que os processos de transação no 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 Ao usar um endereço somente leitura (ou seja, fornecendo apenas um endereço e não uma chave privada), você ainda pode interagir com o blockchain para consultar informações, mas não poderá realizar transações. Isso é útil para monitorar as carteiras e a recuperação de dados sem a necessidade de credenciais sensíveis.
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}Começaremos pela primeira vez criando nossa classe com os seguintes argumentos:
Observação : Ao definir a corrente, ela deve ser feita com nftpy.OpenSea.OpenSeaChain pois a API requer um formato especial para definição de cadeia.
from nftpy import OpenSea , OpenSeaChain
opensea = OpenSea ( api_key = 'your-opensea-api-key' , chain = OpenSeaChain . POLYGON )Para consultar as estatísticas de uma coleção da NFT, use o seguinte método:
opensea . get_collection_stats ( 'your-collection-slug' )Depois de executar isso, devemos ver uma saída parecida com isso:
{
"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
}
}Para buscar detalhes de uma coleção, use o seguinte método:
opensea . get_collection ( 'your-collection-slug' )Para obter detalhes de uma NFT específica, use o seguinte método:
opensea . get_nft ( '0xYourContractAddress' , '1' )Para listar eventos relacionados a uma NFT específica, use o seguinte método:
opensea . list_events_by_nft ( '0xYourContractAddress' , '1' )Para listar as NFTs de propriedade de uma conta específica, use o seguinte método:
opensea . list_nfts_by_account ( '0xYourWalletAddress' )Para gerenciar uma coleção, crie uma instância da classe OpenSeaclection :
from nftpy import OpenSeaCollection
collection = OpenSeaCollection ( collection_name = 'your-collection-name' , api_key = 'your-api-key' )Para obter detalhes de uma coleção específica, use o seguinte método:
details = collection . get_collection_details ()Para listar todos os NFTs dentro de uma coleção, use o seguinte método:
nfts = collection . get_nfts ()Para gerenciar uma carteira, crie uma instância da classe OpenSeawallet :
from nftpy import OpenSeaWallet
wallet = OpenSeaWallet ( address = 'your-wallet-address' , api_key = 'your-api-key' )Para verificar o saldo da carteira, use o seguinte método:
balance = wallet . get_balance ()Para recuperar todos os NFTs de propriedade da carteira, use o seguinte método:
nfts = wallet . get_nfts ()Começaremos pela primeira vez criando nossa classe com os seguintes argumentos:
Observação : Ao definir a corrente, ela deve ser feita com nftpy.Rarible.RaribleChecain , pois a API requer um formato especial para definição de cadeia.
from nftpy import Rarible , RaribleChain
rarible = Rarible ( api_key = 'your-rarible-api-key' , chain = RaribleChain . ETHEREUM )Para buscar detalhes de um item específico por seu ID, use o seguinte método:
rarible . get_item_by_id ( 'item_id' )Para buscar detalhes de vários itens por seus IDs, use o seguinte método:
rarible . get_items_by_ids ([ 'item_id1' , 'item_id2' ])Para recuperar as informações de royalties para um item específico por seu ID, use o seguinte método:
rarible . get_item_royalties_by_id ( 'item_id' )Para buscar itens pertencentes a um endereço específico, use o seguinte método:
rarible . get_items_by_owner ( 'owner_address' )Para validar uma assinatura para um determinado conjunto de dados, use o seguinte método:
rarible . validate_signature ( data = { 'your' : 'data' })Para obter dados de entrada necessários para gerar uma assinatura, use o seguinte método:
rarible . get_signature_input ( data = { 'your' : 'data' })Para codificar dados para o protocolo rarível, use o seguinte método:
rarible . encode_data ( data = { 'your' : 'data' })Para obter a taxa de câmbio de USD para uma moeda específica, use o seguinte método:
rarible . get_usd_rate ( 'currency' )Para buscar todas as moedas suportadas, use o seguinte método:
rarible . get_all_currencies ()Para recuperar o saldo de um usuário específico em uma moeda especificada, use o seguinte método:
rarible . get_user_balance ( 'user_address' , 'currency' )
