Official Thirdweb sdk
NFTLabs Python SDK
PyPi package found here.
1 of 2
nftlabs-sdkpypi package will be deprecated on November 30th, 2021
Please make sure you install the new
thirdweb-sdkpackage found here
In your code, update all imports to use the
thirdwebpackage and switch to using the
ThirdwebSdkpackage (instead of the
2 of 2
collectionmodule has been renamed to
bundleand will be deprecated on November 30th, 2021
All references to
collectionmodule and its associated classes should be updated to
bundleand its newely created classes.
You can find the detailed documentation for the
Installing the SDK
$ pip install thirdweb-sdk
nftlabs ├── abi // contains autogenerated ABI contract wrappers ├── errors // commonly thrown errors ├── modules // NFT, Currency, Marketplace, Pack, Bundle, etc modules ├── options // Options classes used throughout the SDK ├── sdk.py // NftlabsSdk class, wrapper for the entire package ├── storage // Distributed file storage helper classes └── types // Types consumed by some of the methods exposed in the modules
Calling the modules
You can call the NFTLabs modules by instantiating an SDK object and fetching the module with your contract address like this:
import os from nftlabs import NftlabsSdk, SdkOptions sdk = NftlabsSdk(SdkOptions(), "https://rpc-mumbai.maticvigil.com") # polygon testnet as an example # Assumes your private key is assigned to the `PKEY` environment variable sdk.set_private_key(os.getenv("PKEY")) # Put your NFT contract address here if you want to mint your own NFTs! nft_module = sdk.get_nft_module("0xbDfF8fb43688fB4D2184DF8029A7238ac1413A24") print(nft_module.total_supply())
Generating ABI wrappers
abi package contains autogenerated code compiled by the
abi-gen tool found here.
Our protocols are developer at this repo.
abi-gen cli tool and use it to compile abi wrappers like this:
$ # assumes you have the nftlabs-protocols repo cloned in the parent directory $ abi-gen --language Python -o nftlabs/abi --abis ../nftlabs-protocols/abi/NFT.json
Anytime there are ABI contract changes, you should regenerate the abi wrappers.
This package uses
PyDoctor to auto-generate docs. Each method, class and variable should have a detailed description of what it is meant for as a comment enclosed in triple quoation marks (
""" """) just below the line they are defined.
def my_method(self, arg1, arg2): """ This part goes into the documentation. """ return arg1 + arg2
""" This part will not go into the documentation. """ def my_method(self, arg1, arg2): return arg1 + arg2
Addtionally, each module should also have a docstring at the top of the file. This will be used as a breif descroption of the module on the homepage of the documentation.
1 """Interact with the NFT module of the app""" # docstring 2 # Module code starts from here 3 # ...
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for nftlabs_sdk-0.4.0-py3-none-any.whl