TypeScript Setup
Learn how to create a TypeScript application and initialize it with the Okto SDK, including setting up authentication and executing your first token transfer.
Quick Start Template Available!
Skip the manual setup and get started in minutes with our template repository. It includes pre-configured Okto SDK integration, authentication setup, and example components and operations.
Before you begin, set up your developer dashboard by making sure you have :
- Created your Okto Developer Dashboard account
- Get your Okto credits from the dashboard
- Obtained your API keys from the dashboard
- Enabled the specific Chains and Tokens you plan to use in your application
- Optional: Enabled Sponsorship for the desired chains
If you need help, reach out to us on our troubleshooting form and we will contact you.
TypeScript App
This approach shows how to create a TypeScript application and manually configure the Okto SDK. Follow these steps to set up your project and execute your first token transfer.
Prerequisites
Before getting started, ensure you have the following:
- Node.js (v18+) and npm/pnpm/yarn: Download Node.js
- Okto API Keys: You need your
CLIENT_PRIVATE_KEY
andCLIENT_SWA
. Obtain these from the Okto Developer Dashboard. - Google OAuth Credentials: Create OAuth 2.0 credentials in the Google Cloud Console to get your
GOOGLE_CLIENT_ID
.
- Go to Google Cloud Console.
- Create OAuth 2.0 credentials for your project.
- Set the redirect URI to:
[YOUR_APP_URL]/api/auth/callback/google
(for example,http://localhost:3000/api/auth/callback/google
during local development). - Save your Client ID.
Need detailed instructions? Check our Google Console Setup Guide.
Initialize a TypeScript Project
If you already have a TypeScript project, you can skip this step and proceed directly to Step 2 to start integrating Okto.
Configure Environment Variables
Create a .env
file in your project root:
Create a configuration file to load these variables:
Implement Authentication
Currently, you can onboard users and support on-chain interaction via the Okto Embedded wallet. To do this you must first authenticate your user via social login. We currently support Google OAuth.
Update your main file to include authentication:
Congratulations!
🎉 Your basic Okto integration is now complete! You're ready to bring your dApp to life. Let's try out a simple user operation!
Trying Out a User Operation
Now that we have our basic setup complete, let's implement a token transfer on Polygon Amoy Testnet to understand how user operations work in Okto.
2. Fund Your Wallet
To perform a token transfer, you'll need some funds in your wallet. Add funds to this address using the Polygon Amoy Faucet.
3. Check Network Information
Before creating the user operation, check the Network Information Guide for getting the correct CAIP-2 IDs of chains.
Verify The Transfer
After the transfer is complete, you can verify it through:
- The
getPortfolio
method to check your updated balance - The Polygon Amoy Explorer using the transaction hash which can be fetched using the
getOrdersHistory
method using thejobId
.
Now that you've completed your first user operation, you're ready to explore more advanced features! Check out our Usage Guide to learn about other operations like NFT transfers, contract interactions, and more.
SDK Reference
Get Commands
Method | Description | Documentation |
---|---|---|
const account = await getAccount(oktoClient); | Get user's wallet details | Method Overview |
const chains = await getChains(oktoClient); | List supported blockchain networks | Method Overview |
const tokens = await getTokens(oktoClient); | List supported tokens | Method Overview |
const portfolio = await getPortfolio(oktoClient); | Get user's token holdings | Method Overview |
const nfts = await getPortfolioNFT(oktoClient); | Get user's NFT holdings | Method Overview |
const activity = await getPortfolioActivity(oktoClient); | Get transaction history | Method Overview |
const orders = await getOrdersHistory(oktoClient); | Get transaction order history | Method Overview |
const collections = await getNftCollections(oktoClient); | Get NFT collections | Method Overview |
User Operations (Intents)
Intents are pre-built action templates within the Okto SDK that simplify common Web3 tasks. They provide one-liner functions for complex blockchain interactions.
1. Token Transfer
Send tokens to another address. Learn more
2. NFT Transfer
Transfer NFTs between addresses. Learn more
3. Raw Transaction (EVM)
Execute custom EVM contract calls. Learn more
Quick Start Template Available!
Skip the manual setup and get started in minutes with our template repository. It includes pre-configured Okto SDK integration, authentication setup, and example components and operations.
Additional Resources
Need help? Join our Discord community or email us at [email protected]
.