Skip to main content

Hooks: Integrating Composable Onchain Actions

Hooks allow you to automate onchain actions to occur after a write operation passes the rules.

Syntax​

"hooks": {
  "onchain": {
    "create": "<action>",
    "update": "<action>",
    "delete": "<action>"
  }
}

Example Hook:

"hooks": {
  "onchain": {
    "create": "@TokenPlugin.transferWholeTokens(@TokenPlugin.USDC, @user.address, get(/chatrooms/$roomId).feeReceiverAddress, get(/chatrooms/$roomId).feeAmount)"
  }
}

This hook transfers USDC tokens from the user's wallet to a specified recipient when a new document is created.

A hook is similar to rules and still has the option for hooks to be attached to create, delete, or update. The one difference for hooks is that they run in order after all rules have run and that you may access transactional plugins from a hook. This means that it allows state to change on the blockchain.

Plugins: Extending Functionality​

Plugins provide additional functionality that can be used within policies, and allow for transactional functions to be used in hooks as described above. The @TokenPlugin is a built-in plugin for token-related operations.

TokenPlugin Actions:​

  • @TokenPlugin.transferWholeTokens(tokenAddress, fromAddress, toAddress, amount)
  • @TokenPlugin.transfer(tokenAddress, fromAddress, toAddress, amountInWei)

Example Usage:​

"hooks": {
  "onchain": {
    "create": "@TokenPlugin.transferWholeTokens(@TokenPlugin.USDC, @user.address, recipientAddress, amount)"
  }
}

More information on the TokenPlugin can be found at Token Plugin.

Future Plugins and Extensibility​

More plugins will be added to Tarobase in the near future to expand the available functionality. Additionally, the entire plugin system will be made open source, allowing developers to create and integrate their own custom plugins. This will enable you to extend Tarobase's capabilities with specialized functionality tailored to your application's needs.