@yoroi/types/src/links/cardano.ts

The Yoroi Types package of Yoroi SDK

export interface LinksUriRules {
  readonly requiredParams: ReadonlyArray<string>
  readonly optionalParams: ReadonlyArray<string>
  readonly forbiddenParams: ReadonlyArray<string>
  readonly extraParams: 'include' | 'deny' | 'drop'
}

export interface LinksUriConfig {
  readonly rules: LinksUriRules

  readonly scheme?: string
  readonly authority?: string
  readonly version?: string
  readonly path?: string
}

export interface LinksWebCardanoUriConfig extends LinksUriConfig {
  readonly scheme: 'web+cardano'
  readonly authority: '' | 'transfer' | 'claim'
  readonly version: 'v1' | ''
}

export type LinksParams = Readonly<Record<string, any>>

export type LinksLink<T extends LinksUriConfig> = Readonly<{
  config: T
  params: LinksParams
  link: string
}>

export type LinksModule<T extends LinksUriConfig> = Readonly<{
  create: (args: {config: T; params: LinksParams}) => LinksLink<T>
  parse: (text: string) => LinksLink<T> | undefined
}>