Skip to main content

@cowprotocol/app-data

Namespaces

Classes

Interfaces

References

v1_3_0

Renames and re-exports latest

Type Aliases

AnyAppDataDocVersion

Ƭ AnyAppDataDocVersion: AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema | AppDataRootSchema

Defined in

generatedTypes/index.ts:33


AppDataParams

Ƭ AppDataParams: Partial<Omit<AppDataRootSchema, "version">>

Defined in

types.ts:3


IpfsHashInfo

Ƭ IpfsHashInfo: Object

Type declaration

NameTypeDescription
appDataContentstringFull appData content. It will be a the exact string that if hashed using keccak-256 you would get the returned appDataHex
appDataHexstringappData hex for CoW Orders. Its value is the multihash part of the IPFS CID, therefore it points to a IPFS document. Because its just the multihash, it doesn't have any infomation regarding the encoding and hashing algorithm. These parts are implicit. Currently, the implicit encoding is base16 and the implicit hashing algorithm is keccak256. See https://github.com/cowprotocol/app-data/blob/app-data-v1/src/api/appDataToCid.ts#L102 Previous versions used a different encoding and hashing algorithm (base58btc, dag-pb, sha2-256)
cidstringIPFS's content identifier See https://docs.ipfs.io/concepts/content-addressing/#identifier-formats

Defined in

types.ts:5


LatestAppDataDocVersion

Ƭ LatestAppDataDocVersion: AppDataRootSchema

Defined in

generatedTypes/index.ts:32


ValidationResult

Ƭ ValidationResult: Object

Type declaration

NameType
errors?string
successboolean

Defined in

types.ts:38

Variables

LATEST_APP_DATA_VERSION

Const LATEST_APP_DATA_VERSION: "1.3.0"

Defined in

generatedTypes/index.ts:21


LATEST_HOOKS_METADATA_VERSION

Const LATEST_HOOKS_METADATA_VERSION: "0.2.0"

Defined in

generatedTypes/index.ts:26


LATEST_ORDER_CLASS_METADATA_VERSION

Const LATEST_ORDER_CLASS_METADATA_VERSION: "0.3.0"

Defined in

generatedTypes/index.ts:24


LATEST_PARTNER_FEE_METADATA_VERSION

Const LATEST_PARTNER_FEE_METADATA_VERSION: "0.1.0"

Defined in

generatedTypes/index.ts:29


LATEST_QUOTE_METADATA_VERSION

Const LATEST_QUOTE_METADATA_VERSION: "1.1.0"

Defined in

generatedTypes/index.ts:22


LATEST_REFERRER_METADATA_VERSION

Const LATEST_REFERRER_METADATA_VERSION: "0.2.0"

Defined in

generatedTypes/index.ts:23


LATEST_REPLACED_ORDER_METADATA_VERSION

Const LATEST_REPLACED_ORDER_METADATA_VERSION: "0.1.0"

Defined in

generatedTypes/index.ts:30


LATEST_SIGNER_METADATA_VERSION

Const LATEST_SIGNER_METADATA_VERSION: "0.1.0"

Defined in

generatedTypes/index.ts:27


LATEST_UTM_METADATA_VERSION

Const LATEST_UTM_METADATA_VERSION: "0.2.0"

Defined in

generatedTypes/index.ts:25


LATEST_WIDGET_METADATA_VERSION

Const LATEST_WIDGET_METADATA_VERSION: "0.1.0"

Defined in

generatedTypes/index.ts:28

Functions

stringifyDeterministic

stringifyDeterministic(obj): Promise<string>

Parameters

NameType
objany

Returns

Promise<string>

Defined in

utils/stringify.ts:1