appData-module.md

appData module

See also:

• CoW Swap Architecture
• Broader CoW Swap Architecture

Description

This module returns the appData metadata, which should be used for attaching additional information to the orders.

This module will facilitate to get this information, both in a object format, and in the hash that should be used in the app-data field of new orders.

App-data project

This module depends on the library https://github.com/cowprotocol/app-data

Details

This module will expose:

• useAppData(): Exposes the app hash and the document associated to it.
• AppDataUpdater: Component that makes sure the appData has the right content, required for useAppData hook to work
• useUploadAppData(): Returns a function which can be invoked when an appData should be uploaded. In case of errors, it will keep re-attempting.