Official Thirdweb sdk
Project description
NFTLabs Python SDK
PyPi package found here.
Deprecation Notices
1 of 2
The
nftlabs-sdk
pypi package will be deprecated on November 30th, 2021Please make sure you install the new
thirdweb-sdk
package found hereIn your code, update all imports to use the
thirdweb
package and switch to using theThirdwebSdk
package (instead of theNftlabsSdk
package)
2 of 2
The
collection
module has been renamed tobundle
and will be deprecated on November 30th, 2021All references to
collection
module and its associated classes should be updated tobundle
and its newely created classes.You can find the detailed documentation for the
bundle
module here
Docs
API Reference
https://python-docs.nftlabs.co/
Installing the SDK
$ pip install thirdweb-sdk
Package Structure
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())
Development
Generating ABI wrappers
The abi
package contains autogenerated code compiled by the
0xchain abi-gen
tool found here.
Our protocols are developer at this repo.
Install the 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.
Writing Documentation
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.
Example:
Do:
def my_method(self, arg1, arg2):
"""
This part goes into the documentation.
"""
return arg1 + arg2
Don't:
"""
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.
Example:
1 """Interact with the NFT module of the app""" # docstring
2 # Module code starts from here
3 # ...
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thirdweb_sdk-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 297f90710ad389ef0ee129d53c10acb9b8f6c5b15d84862a43bb009e92d7837d |
|
MD5 | 359a2ea81ac692a73df1aa12f32a131c |
|
BLAKE2b-256 | 4a9f2d0d4e7c895277f966a84149f2cb1efc9b99ed0dd6007892be5458f919a1 |