
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@thirdweb-dev/sdk
Advanced tools
The main thirdweb SDK.
Best in class Web3 SDK for Browser, Node and Mobile apps
Install the latest version of the SDK with npm
:
npm install @thirdweb-dev/sdk ethers@5
or with yarn
:
yarn add @thirdweb-dev/sdk ethers@5
The quickest way to get started is to use the SDK as read only (no transactions). This will allow you to query data from any contract with no additional setup.
// my_script.js
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
// instantiate the SDK in read-only mode (our example is running on `polygon` here)
// all major chains and testnets are supported (e.g. `mainnet`, 'optimism`, 'arbitrum', 'polygon', `goerli`, 'mumbai', etc.)
const sdk = new ThirdwebSDK("polygon");
// access your deployed contracts
const contract = await sdk.getContract("0x...");
// Read data using direct calls to your contract
const myData = await contract.call("myFunction");
// Or Using the extensions API matching to your contract extensions
const allNFTs = await contract.erc721.getAll();
const tokenSupply = await contract.erc20.totalSupply();
You can execute this code as a node script by executing:
node my_script.js
Note that you can also access any deployed contract using its ABI, using sdk.getContractFromAbi(address, abi)
and get the same functionality. For contracts deployed via thirdweb, we handle the ABI for you.
In order to execute transactions on your contract, the SDK needs to know which wallet is executing those transactions. This can be done two ways:
Here's how to provide your own private key to the SDK to perform transactions with your account from scripts or from a node.js backend:
// my_script.js
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
// Learn more about securely accessing your private key: https://portal.thirdweb.com/web3-sdk/set-up-the-sdk/securing-your-private-key
const privateKey = "<your-private-key-here>";
// instantiate the SDK based on your private key, with the desired chain to connect to
const sdk = ThirdwebSDK.fromPrivateKey(privateKey, "polygon");
// deploy existing contracts, or your own using the thirdweb CLI
const deployedAddress = sdk.deployer.deployNFTCollection({
name: "My NFT Collection",
primary_sale_recipient: "0x...",
});
// access your deployed contracts
const contract = await sdk.getContract(deployedAddress);
// Execute any of your functions on your contracts from the connected wallet
await contract.call("myFunction", arg1, arg2);
// Or execute transactions using the extensions API
await contract.erc721.mint({
name: "Cool NFT",
description: "Minted NFT from code!",
image: fs.readFileSync("path/to/image.png"), // This can be an image url or file
});
You can execute this code as a node script by executing:
node my_script.js
For frontend applications, head over to our React Github repo which shows you how to connect to a user's wallet like Metamask, and automatically instantiate the thirdweb SDK for you.
Easiest way to get started on the frontend is using one of our templates in the thirdweb examples repo.
To build the project:
yarn install
yarn build
After building, to run the tests (requires a local hardhat node running):
yarn test:all
OR
If you have make and docker installed you can simply run
make test
FAQs
The main thirdweb SDK.
The npm package @thirdweb-dev/sdk receives a total of 15,531 weekly downloads. As such, @thirdweb-dev/sdk popularity was classified as popular.
We found that @thirdweb-dev/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.