Managing Callbacks in a Web3 activity feed (Part 2)

Efficiently handle real-time data updates on Solana-powered dApps with smart callback management APIs.

Callback APIs can be used as a backbone structure for marketplace activity-based applications, as these APIs monitor blockchain events and send data to a specific callback URI whenever an event of interest occurs. In the previous part of this article, we have seen how we can register a new callback on Solana. Let us now explore more about how to manage callbacks on Solana using SHYFT APIs.

Read SHYFT API Documentation here.

In case you missed the previous part of this article, click here.

Updating Callbacks related to the Activity Feed

In certain scenarios, there may be a need to track additional events or addresses in a callback. For instance, if there’s a requirement to add an additional address or an event like TOKEN_MINT for all accounts, we must update the specification of existing callbacks. Fortunately, this can be easily accomplished by using the appropriate API to modify the existing callbacks.
Let us suppose we want to add one more address (say **Bx8j…..nhj3**) and we want to add one more event for all the accounts (such as **TOKEN_MINT**).

POST <https://api.shyft.to/sol/v1/callback/update>

Parameters required for this API call

Along with the x-api-key , this API key requires the id of the callback being modified. All other fields are optional, and only the fields being modified are to be supplied. The parameters are almost same as the ones we used while creating callbacks.

• addresses(optional): This accepts a list of addresses, whose activity (parsed transactions) we are attempting to fetch. In this case, we will provide the updated list, which would be [NFT_MINT , TOKEN_BURN , TOKEN_MINT ]
• callback_url(optional): URL to which the activity details (transactions) will be sent to. This can be typically a webhook, or a path to a server function, which will be listening for any new data received. Since we are not modifying this, we can skip this parameter.
• events(optional): Accepts a list of events to be notified about. This is an optional parameter that allows the creator to specify which events to be notified about along, thus allowing creators to add filters.
• enable_raw(optional): If set to true, raw Solana transactions are also returned along with the parsed one.

Once executed successfully, the callback will be updated and transactions related to the new events (along with the old ones) will be sent to the callback_url. To know more about updating callbacks, feel free to take a look at our docs here.

View Parsed Transactions from callbacks

Note: Callbacks can also be modified using our all new JS SDK for Solana. Feel free to checkout SHYFT’s all new JS SDK here. The request parameters and responses are very similar to what is illustrated above.

const {ShyftSdk,Network} = require("@shyft-to/js");

async function modifyCallback()
{
    const shyft = new ShyftSdk({apiKey:YOUR_SHYFT_API_KEY,network:Network.Mainnet});

    const updateCallback = shyft.callback.update({
      id: "2345182a72e6c61e348f33de12", // required field, the id of the callback being modified
      addresses: [
        "7xhjbLzLbnVPNpOj4vqBpU3ZeZXPQdEC3bp5MD71hb3",
        "8syNptuSVvn3fSk8RgW3yPddkp5oF72EXP3rA9ghsvs",
        "Bx8jPE2HZ15QCvHHCm8QzYdXKt9qReeT5P4aqSRAnhj3"
      ],
      events: ["NFT_MINT","TOKEN_BURN","TOKEN_MINT"]
      //only the fields being updated are provided, along with the id
    })
}

Removing a callback

It may happen in an activity feed, a user may have deactivated their account, or signed out, and the application no longer needs to listen to events. Stopping a callback may be required for saving undue credit usage or saving resources.

Get Team Shyft’s stories in your inbox

Join Medium for free to get updates from this writer.

The API endpoint for stopping callbacks.

DELETE <https://api.shyft.to/sol/v1/callback/remove>

This API requires only one parameter(along with the x-api-key in the header as described in the previous section) which is the id returned in the response when the callback was created.

Once successfully executed, the callback will be stopped.

{
    "success": true,
    "message": "Callbacks stopped for the given address",
    "result": {
        "id": "6437cb12044174e8098d3b40" //id received when creating
    }
}

Note: Callbacks can also be removed using our all new JS SDK for Solana as illustrated below.

const {ShyftSdk,Network} = require("@shyft-to/js");

async function removeCallback()
{
    const shyft = new ShyftSdk({apiKey:YOUR_SHYFT_API_KEY,network:Network.Mainnet});

    const remCallback = shyft.callback.remove({
      id:"6437cb12044174e8098d3b40" //id of the callback being removed
    })
}

Listing the details of a callback

This function is not directly related to the activity feed, instead, it helps us keep track of all the details of the callbacks previously created.

This API is used for getting information about existing callbacks.

GET <https://api.shyft.to/sol/v1/callback/list>

All SHYFT APIs accept x-api-key in their header, which is an authorization parameter used by SHYFT. You can get your own here for free. The x-api-key in header is the only parameter required here.

Conclusion

In Solana’s ecosystem, callbacks play a crucial role in enabling developers to build high-performance applications capable of handling thousands of transactions per second while maintaining low transaction costs. SHYFT APIs provide an API-based solution for NFTs, Tokens, Wallets, callbacks, etc. which helps users to enhance the experience of building scalable dApps and provide a seamless experience for interacting with Solana-based applications.

If you liked this article, please feel free to check out our other articles on creating a Web3 activity feed on Solana or How to get NFT owners on Solana. We hope you have a great time building dApps with SHYFT.

Previous: How to create a live Web3 activity feed on Solana.

Resources

SHYFT API Documentation
Shyft Website
Get API Key
GitHub
Join our Discord
Javascript SDK
Try out our APIs on Swagger UI