We refreshed our doc site!
Bookmarked links may have changed
Read release notesWe refreshed our doc site!
Bookmarked links may have changed
Read release notesWelcome to the dynamic world of Web3. Whether you're a seasoned blockchain enthusiast or stepping into the decentralized sphere for the first time, this guide tailored for Developer-Controlled Wallets using Circle's Web3 Services Console awaits.
Harness the power of Web3 technology to provide an unparalleled experience for your users, while maintaining full control and enhanced security over their wallets. Let's take a peek at the standout features that make the Web3 Services Console an irresistible choice for your application
Advanced Security
Benefit from MPC technology, which eliminates single points of failure and enhances security against unauthorized access and theft.
Innovative Blockchain Functionality
Grant users access to digital currencies, NFTs, and other blockchain-powered experiences with ease.
Blockchain Agnostic
Build once, deploy across multiple blockchains, such as Ethereum, Polygon, and Avalanche.
Reliable Operations Monitoring
Built-in transaction logs, user-level monitoring, and error reporting help you troubleshoot and support your users effectively.
Instant Access
Get started immediately, with pay-as-you-go pricing and no upfront fees or contracts.
Before you get started, ensure that you have:
Have a Web3 Services account
Created your API key
The Entity Secret is an integral component in Developer-Controlled Wallets, serving as a key element in bolstering security.
The Entity Secret is a robust 32-byte key engineered to enhance the security mechanisms of Developer Controlled Wallets. Its value lies not only in its complexity but also in the specific security benefits it confers.
Exclusivity
The Entity Secret is generated by you and remains known exclusively to you. Consider it as your private password or a cryptographic signature that distinguishes your activities.
Enhanced Security for Critical API Requests
For critical actions such as wallet creation or initiating transactions, the Entity Secret comes into play. Attaching an encrypted version of the Entity Secret to these API requests provides an added authentication factor, reinforcing the security infrastructure.
Dynamic Protection
With a requirement to re-encrypt the Entity Secret for each API request, you avoid the risks associated with having a static key, which could be vulnerable to security breaches. This dynamic approach means that every request is identifiably distinct, providing fortified protection against potential attacks.
Sole Authority
While our platform enables operations using the Entity Secret, it does not store it. This design choice comes with dual implications: First, it ensures you are the sole entity capable of using your private keys, thus preserving absolute control over them. Second, it places the responsibility squarely on your shoulders to secure the Entity Secret conscientiously, as its security is paramount to the overall protection of your Developer-Controlled Wallets.
The Entity Secret embodies the level of trust and authority that our platform confers upon developers. It enables smooth access to the extensive capabilities of developer-controlled wallets, while simultaneously ensuring their security is maintained. However, great power necessitates equally great responsibility. The safeguarding, encryption, and periodic renewal of the Entity Secret are duties that rest with you, the developer.
This dynamic of empowering developers while also entrusting them with critical security tasks reflects the core principles of decentralization intrinsic to the web3 ecosystem. As a developer, you're more than a creator; you assume the role of a guardian of security and a proponent of distributed authority.
Should you sense the weight of this role, rest assured that guidance is at hand. We are here to support you in effectively managing and protecting your Entity Secret.
const crypto = require('crypto')
const secret = crypto.randomBytes(32).toString('hex')
console.log(secret)
It's crucial to safeguard your Entity Secret akin to a key to your home—misplacing it or divulging it to others could have serious ramifications. Ensure you securely store the Entity Secret because you'll require it shortly to create an Entity Secret Ciphertext. Just as the name implies, the Entity Secret is sensitive information; treat it with the utmost confidentiality and security to prevent unauthorized access or use.
With your Entity Secret now created, we're ready to advance to a critical juncture. You're about to convert the Entity Secret into Ciphertext and register it with the system. This process sets the stage for you to create your first wallet—a milestone to look forward to.
Begin by acquiring your entity's public key. This key is retrievable via our APIs and is instrumental in the upcoming steps. To obtain it, use your API key for authentication. The entity's public key plays a crucial role as it encrypts your Entity Secret. Once encrypted, the Entity Secret remains secure, ensuring the information is shared exclusively between you and the platform, keeping it out of reach from outsiders.
After obtaining the public key, the next step involves using RSA encryption to secure your Entity Secret. Follow these steps:
Employ RSA encryption with the public key to encrypt your Entity Secret. This cryptographic process ensures that the secret is encoded in such a way that only someone with the private key can decrypt it.
After encryption, convert the encrypted data into Base64 format. Encoding in Base64 ensures the encrypted data can be safely conveyed and interpreted in various contexts, including those that may not handle binary data well.
Ensure that the generated Ciphertext is 684 characters in length. This specific length confirms the encryption process has been executed properly and that the data will be maintained correctly upon receipt.
The code provided will assist in automating this encryption process, generating a unique Entity Secret Ciphertext every time it is executed. The resulting Ciphertext is what you'll use to interact securely with the platform's API when performing operations that require it.
const forge = require('node-forge')
const entitySecret = forge.util.hexToBytes('YOUR_ENTITY_SECRET');
const publicKey = forge.pki.publicKeyFromPem('YOUR_PUBLIC_KEY');
const encryptedData = publicKey.encrypt(entitySecret, 'RSA-OAEP', { md: forge.md.sha256.create(), mgf1: { md: forge.md.sha256.create(), }, });
console.log(forge.util.encode64(encryptedData))
Once you've taken the necessary steps to safeguard your Entity Secret by converting it to Ciphertext, you'll need to register it within our Web3 Services Console. This action is vital as it authenticates the Ciphertext, effectively setting up a secure foundation for all subsequent interactions using our Developer-Controlled Wallets. The registration links your encrypted key with your developer account, ensuring that you can confidently manage wallet creation and transactions with the assurance of robust security measures in place.
As you proceed with the registration of your Entity Secret Ciphertext, pay close attention to the recovery file that will be generated. This file is a critical safety measure for your operations. In the event that your Entity Secret is ever lost, the recovery file will act as your fallback, enabling you to regain access to your Developer-Controlled Wallets. Ensure that you store this file securely and in a location that you can access readily if needed.
By meticulously completing the registration and protection of your Entity Secret, you've not only guaranteed the security of your key but also laid down a bedrock of trust for all activities involving our developer-controlled wallets. We prioritize the safety of your data and are committed to providing a seamless and secure user experience.
Welcome to a foundational step in utilizing our Web3 Services: initiating your first API call to construct a WalletSet. We'll guide you through the process and clarify what a WalletSet entails within our platform.
A WalletSet within our ecosystem is a sophisticated grouping of wallets, securely tied together by a singular cryptographic key. Leveraging the Hierarchical Deterministic (HD) wallet technology, WalletSets offer an enhanced way to handle wallet management that spans multiple blockchain networks. This is particularly relevant for Ethereum Virtual Machine (EVM) compatible blockchains, where it is common for wallets on different networks to share the same address, thanks to the underlying technology.
As we approach the creation of your inaugural WalletSet, it's important to comprehend a critical aspect of our APIs: idempotency keys.
Idempotency is a fundamental concept which guarantees that an operation is repeatable without changing the outcome. This concept is extremely important in API requests to make sure that if a request is accidentally sent more than once, it doesn't result in duplicate operations.
Consider situations like an unstable internet connection leading to multiple unintentional request submissions, or a user who accidentally activates a command several times. Without idempotency, such events might cause numerous unwanted operations.
To prevent this, an idempotency key is used. Each request includes a distinct key that, when recognized by the server within a certain timeframe as a repeat submission, prevents the repeated processing of that request. This mechanism is crucial to preserving the integrity of your operations, ensuring that only intended actions are carried out.
Now that we've got the concept of idempotency covered, let's look at creating your WalletSet.
Term | Definition |
---|---|
idempotencyKey | Think of this as a safety net. By using a unique UUID for every transaction request, you ensure no transaction is mistakenly processed more than once. It's a measure against unintended duplicates. |
entitySecretCiphertext | Remember the encryption we discussed earlier? You'll need to provide this encrypted string for security and authorization. |
name | The name for your new WalletSet. |
Let's create our first wallet set!
Ensure that your idempotency key is unique for every distinct request. Our APIs require the idempotency key to be of type uuidv4. Remember, its primary role is to ensure that the same request isn't processed more than once.
For a comprehensive overview of each transaction you execute with Circle's Web3 APIs, the Web3 Services Console provides detailed access to API logs. By examining these logs, you gain valuable visibility into how your application interacts with Circle APIs, which can be pivotal for various aspects including troubleshooting, performance optimization, and security oversight by highlighting any abnormal activities. For detailed records of your API interactions, please refer to the API Logs section.
Within the scope of our Quickstart guide, the API log is indispensable for gaining insights into specific API calls and the objects that are created as a result. Think of the API log as a detailed record that allows you to retrieve the unique IDs of objects that have been generated, especially when these IDs are needed for subsequent API interactions. API logs are a crucial educational resource that simplify the debugging process and help you methodically comprehend the intricacies of the API's operations. Hence, the API log is not only instrumental in improving operational workflows but also serves as a valuable asset for your development projects.
Ah, the most exhilarating phase: shaping your very first developer-controlled wallet in the vastness of web3. With your prepped API key and Entity Secret Ciphertext, we're only a few steps away from crafting a masterpiece. Let's dive right in!
In web3, a wallet isn't just a storage mechanism for digital tokens or NFTs, but the very essence of user interactions on the blockchain. Essentially, it's a blend of a unique address and accompanying metadata stored on the blockchain.
For developer-controlled wallets:
Address
A unique identifier on a blockchain. Notably, while an address remains distinct, multiple wallets can have the same address across different EVM blockchains.
Custody Type
This signifies who controls the private key invocation — either the user or the developer. For our purpose, we're focusing on developer-controlled wallets, which are inherently more manageable and tailored for specific app requirements.
With that foundational knowledge, let's get to the hands-on part.
To create a wallet you use the following parameters:
Term | Definition |
---|---|
idempotencyKey | Ensures that a request is executed only once, even if it's received multiple times. |
entitySecretCiphertext | The encrypted form of your Entity Secret, ensuring robust security for your API requests. |
walletSetId | The ID of the wallet set that you created in the preceding step. |
blockchains | Specifies the blockchains on which the wallet should be manifested. |
count | The number of wallets you aim to create. Note: The parameter should not exceed 20. |
To ensure the best possible experience, we will automatically create and fund two wallets with testnet tokens. Each wallet will be funded with 10 USDC, allowing you to dive right into the Quickstart without delay. Rest assured, this amount will be sufficient for you to initiate your first transaction.
And there you have it! By the end of this step, you'll have fully functional developer-controlled wallets, ready to shape web3 experiences.
Now that you have a wallet that contains some Testnet tokens, let's dive into initiating your first transaction. It's simpler than you might think, especially with our streamlined approach.
Cross-Blockchain Transfers: Tokens are native to specific blockchains, meaning they can't be sent directly across different chains. For instance, Ethereum tokens stay on the Ethereum network unless other mechanisms, like bridges, are used.
Before we can proceed, we need to determine the tokenId
. You can do this by retrieving the token balances for your wallet.
Term | Definition |
---|---|
idempotencyKey | A unique string that ensures your transaction isn 't processed more than once even if sent multiple times. A critical measure to prevent duplicates. |
amounts | Specify the amount of tokens you're transferring. |
destinationAddress | The wallet address where you're sending the tokens. |
entitySecretCiphertext | A crucial security layer, this encrypted string ensures only authorized transactions go through. |
tokenId | This is the id we just extract from your wallet balance. It is the unique identifier for the specific token type you're moving. This id is unique. |
walletId | Indicates the source of the transaction, i.e., from which wallet you're sending the tokens. |
The preceding parameters are just the essentials for initiating a transaction. The endpoint offers a richer, more detailed configuration to cater to a variety of transaction types. For a comprehensive list of the supported parameters, see the official documentation.
Blockchain transactions pose a challenge with gas fees. Gas fees are charges in blockchain networks, typically paid with native assets like Ether (ETH) on Ethereum. This complicates the user experience as it requires users to hold these assets. However, with Developer-Controlled smart contract wallets, you can sponsor gas fees, removing the need to possess native assets. The Gas Station acts as an intermediary, allowing you to cover fees for your users, improving their transaction experience. In testnet, the Gas Station is already setup for you, ready for testing. In the Production phase, you gain more control with spending limits and configuration options. Learn more here.
Once you've validated your transaction and everything checks out, you're all set. Transactions on the blockchain are immutable, meaning once they're validated, they cannot be reversed or altered. So, always double-check before sending!
After initiating a transaction through our API, you can look up the transaction hash on the Dev Controlled Wallets Transactions page for in the Web3 Services Console. The transaction hash is a unique identifier for your transaction.
You can validate transactions in multiple ways:
This is the preferred method. It enables you to inspect the transaction state directly.
Make sure you're logged in to our Web3 Services Console.
Open the Dev Controlled Wallets Transactions page.
You can see the state of your transaction directly in the table.
For more details about your transaction, click on the relevant line in the transaction details.
By using the transaction hash or wallet id, you can view the transaction state on a blockchain explorer.
Depending on the blockchain your token resides on, select a suitable explorer:
On the explorer's main page, there's a search bar. Paste your transaction hash or wallet id there and search. You can find the transactionHash or the wallet id in your list of transactions.
Whether you provide a wallet ID or transaction hash, details regarding your wallet and the associated transactions will be visible. This includes particularities of each transaction such as the number of confirmations and the gas used, letting you verify that all aligns with your expectations.
Established your Entity Secret
You took the initiative to generate and secure your unique Entity Secret, ensuring that your interactions remain encrypted and safe.
Created your first Developer Controlled Wallet
By setting up your wallet, you now possess a powerful tool that allows you to engage with web3 networks with full autonomy.
Got Testnet tokens via faucets
You've effectively tapped into the Faucets, filling your wallets with Testnet tokens, a crucial step for practical, risk-free experimentation on Testnet.
Initiated a blockchain transaction & validated it
Not only did you initiate a blockchain transaction, but you also took the proactive step of validating it using blockchain explorers, assuring transparency and trust in every move.
Your journey with us doesn't stop here. There's so much more to discover und dive into:
Engage, Build, Share! Dive into our forums, share your feedback, and keep an eye out for exciting challenges and hackathons. Your unique perspective and skills are valuable, and we're eager to see the innovations you'll introduce to our growing ecosystem.
Before you embark further on your journey, we'd love to hear from you. Your feedback shapes the future of our platform and helps us provide a better experience for all developers.
What did you love about the process? Was there something you wish was different? Every insight, no matter how small, matters to us.
Thank you for your trust, dedication, and enthusiasm. Here's to the next chapter in your web3 journey and the marvelous innovations you'll bring forth.
Happy Building! 🚀
Next: Explore more Quickstarts