1515
1616<p align =" center " ><strong >All-in-one web3 SDK for Browser, Node and Mobile apps</strong ></p >
1717
18- ## Features
19-
20- - Support for React & React-Native
21- - First party support for [ Embedded Wallets] ( https://portal.thirdweb.com/wallets ) (social/email login)
22- - First party support for [ Account Abstraction] ( https://portal.thirdweb.com/wallets/sponsor-gas )
23- - Instant connection to any chain with RPC Edge integration
24- - Integrated IPFS upload/download
25- - UI Components for connection, transactions, nft rendering
26- - High level contract extensions for interacting with common standards
18+ ## Core Package
19+
20+ #### [ ` thirdweb ` ] ( ./packages/thirdweb/README.md )
21+
22+ The main SDK package providing all-in-one web3 functionality for Browser, Node, and Mobile applications.
23+
24+ ``` bash
25+ npm install thirdweb
26+ ```
27+
28+ ** Features:**
29+
30+ - Type-safe contract and transaction APIs
31+ - In-app wallets with social/email login
32+ - Account abstraction (ERC4337/EIP7702) support
33+ - 500+ external wallets supported
34+ - Built in infra (RPC, bundler, paymaster, indexer)
35+ - React hooks and UI components
2736- Automatic ABI resolution
37+ - IPFS upload/download
38+ - Cross-platform support (Web, React Native)
39+
40+ ### Documentation
41+
42+ Visit the [ developer portal] ( https://portal.thirdweb.com ) for full documentation.
43+
44+ ### 🚀 Quick Start
45+
46+ #### For React Applications
47+
48+ ``` bash
49+ npm install thirdweb
50+ ```
51+
52+ ``` typescript
53+ import { createThirdwebClient } from " thirdweb" ;
54+ import { ConnectButton , useActiveAccount } from " thirdweb/react" ;
55+
56+ const client = createThirdwebClient ({
57+ clientId: " YOUR_CLIENT_ID" ,
58+ });
59+
60+ function App() {
61+ const account = useActiveAccount ();
62+ console .log (" Connected as" , account ?.address );
63+
64+ return <ConnectButton client ={client} />;
65+ }
66+ ```
67+
68+ For React Native Applications, you'll also need to install the ` @thirdweb-dev/react-native-adapter ` package and import it at app startup for polyfills.
69+
70+ #### For Backend Applications
71+
72+ ``` bash
73+ npm install thirdweb
74+ ```
75+
76+ ``` typescript
77+ import { createThirdwebClient , Engine } from " thirdweb" ;
78+
79+ const client = createThirdwebClient ({
80+ secretKey: " YOUR_SECRET_KEY" ,
81+ });
82+
83+ const wallet = Engine .serverWallet ({
84+ client ,
85+ address: " 0x..." ,
86+ });
87+
88+ const transaction = transfer ({
89+ contract: getContract ({
90+ client ,
91+ address: " 0x..." , // token contract
92+ chain: defineChain (1 ),
93+ }),
94+ to: " 0x..." , // recipient
95+ amount: " 0.01" , // amount in tokens
96+ });
97+
98+ await wallet .enqueueTransaction ({
99+ transaction ,
100+ });
101+ ```
102+
103+ ## Adapters
104+
105+ #### [ ` @thirdweb-dev/react-native-adapter ` ] ( ./packages/react-native-adapter/README.md )
106+
107+ Required polyfills and configuration for running the thirdweb SDK in React Native applications.
108+
109+ ``` bash
110+ npm install @thirdweb-dev/react-native-adapter
111+ ```
112+
113+ #### [ ` @thirdweb-dev/wagmi-adapter ` ] ( ./packages/wagmi-adapter/README.md )
114+
115+ Integration layer for using thirdweb's in-app wallets with wagmi.
116+
117+ ``` bash
118+ npm install @thirdweb-dev/wagmi-adapter
119+ ```
120+
121+ ## Type safe API wrappers
122+
123+ #### [ ` @thirdweb-dev/api ` ] ( ./packages/api/README.md )
124+
125+ TypeScript SDK for thirdweb's API, combining all of thirdweb products.
126+
127+ ``` bash
128+ npm install @thirdweb-dev/api
129+ ```
130+
131+ #### [ ` @thirdweb-dev/engine ` ] ( ./packages/engine/README.md )
132+
133+ TypeScript SDK for Engine, thirdweb's backend onchain executor service.
134+
135+ ``` bash
136+ npm install @thirdweb-dev/engine
137+ ```
138+
139+ #### [ ` @thirdweb-dev/insight ` ] ( ./packages/insight/README.md )
140+
141+ TypeScript SDK for Insight, thirdweb's multichain indexer service.
142+
143+ ``` bash
144+ npm install @thirdweb-dev/insight
145+ ```
146+
147+ #### [ ` @thirdweb-dev/vault-sdk ` ] ( ./packages/vault-sdk/README.md )
148+
149+ SDK for interacting with Vault, thirdweb's secure key management service.
150+
151+ ``` bash
152+ npm install @thirdweb-dev/vault-sdk
153+ ```
154+
155+ #### [ ` @thirdweb-dev/nebula ` ] ( ./packages/nebula/README.md )
156+
157+ TypeScript SDK for Nebula, thirdweb's AI agent service.
28158
29- ## Library Comparison
30-
31- | | thirdweb | Wagmi + Viem | Ethers@6 |
32- | ----------------------------------------- | -------- | ------------------ | -------- |
33- | Type safe contract API | ✅ | ✅ | ✅ |
34- | Type safe wallet API | ✅ | ✅ | ✅ |
35- | EVM utils | ✅ | ✅ | ✅ |
36- | RPC for any EVM | ✅ | ⚠️ public RPC only | ❌ |
37- | Automatic ABI Resolution | ✅ | ❌ | ❌ |
38- | IPFS Upload/Download | ✅ | ❌ | ❌ |
39- | Embedded wallet (email/ social login) | ✅ | ⚠️ via 3rd party | ❌ |
40- | Account abstraction (ERC4337) support | ✅ | ⚠️ via 3rd party | ❌ |
41- | Web3 wallet connectors | ✅ | ✅ | ❌ |
42- | Local wallet creation | ✅ | ✅ | ✅ |
43- | Auth (SIWE) | ✅ | ✅ | ❌ |
44- | Extensions functions for common standards | ✅ | ✅ | ❌ |
45- | React Hooks | ✅ | ✅ | ❌ |
46- | React UI components | ✅ | ❌ | ❌ |
47- | React Native Hooks | ✅ | ✅ | ❌ |
48- | React Native UI Components | ✅ | ❌ | ❌ |
159+ ``` bash
160+ npm install @thirdweb-dev/nebula
161+ ```
49162
50163## Contributing
51164
@@ -55,7 +168,8 @@ See our [open source page](https://thirdweb.com/open-source) for more informatio
55168
56169## Additional Resources
57170
58- - [ Documentation] ( https://portal.thirdweb.com/typescript/v5 )
171+ - [ Dashboard] ( https://thirdweb.com/login )
172+ - [ Documentation] ( https://portal.thirdweb.com/ )
59173- [ Templates] ( https://thirdweb.com/templates )
60174- [ YouTube] ( https://www.youtube.com/c/thirdweb )
61175
0 commit comments