Introduction to Making an API Call - WalletSet Creation

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.

Defining a WalletSet

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.

Grasping the concept of idempotency

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.

Crafting Your WalletSet

Now that we've got the concept of idempotency covered, let's look at creating your WalletSet.

Request parameters

Documentation
  • 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!

Create WalletSet

Try it out:Create a WalletSet

Note: The input parameters of this component differ from those of the actual endpoint. For instance, we automatically generate the Entity Secret Ciphertext to simplify the process and ensure a better experience for you.

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.

Utilizing API Logs for Enhanced Monitoring

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.

Need help or have questions?

Here are some helpful links:

🎮Join our Discord Community: Engage, learn, and collaborate.
🛎Visit our Help-Desk Page: Dive into curated FAQs and guides.
📧Direct Email: We're always a message away.
📖Read docs: Check out our developer documentation.
© 2023 Circle Technology Services, LLC. All rights reserved.