Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document message_data payloads based on message_type for /transactions api #2772

Open
luchenkob opened this issue Nov 25, 2024 · 0 comments
Open

Comments

@luchenkob
Copy link

EnhancedSend

Base Schema:

  • asset: string
  • quantity: number
  • address: string
  • memo: string | null

Verbose Additions:

  • asset_info: AssetInfo
  • quantity_normalized: string

Dispenser

Base Schema:

  • asset: string | null
  • give_quantity: number | null
  • escrow_quantity: number | null
  • mainchainrate: number | null
  • dispenser_status: number | null
  • action_address: string | null
  • oracle_address: string | null
  • status: string

Verbose Additions:

  • asset_info: AssetInfo (optional)
  • give_quantity_normalized: string | null (optional)
  • escrow_quantity_normalized: string | null (optional)

Destroy

Base Schema:

  • asset: string
  • quantity: number
  • tag: string

Verbose Additions:

  • asset_info: AssetInfo
  • quantity_normalized: string

Issuance

Base Schema:

  • asset_id: number
  • asset: string
  • subasset_longname: string | null
  • quantity: number
  • divisible: boolean
  • lock: boolean
  • reset: boolean
  • callable: boolean
  • call_date: number
  • call_price: number
  • description: string
  • description_locked: boolean (optional)
  • status: string

Verbose Additions:

  • quantity_normalized: string

Order

Base Schema:

  • give_asset: string
  • give_quantity: number
  • get_asset: string
  • get_quantity: number

Verbose Additions:

  • give_quantity_normalized: string
  • get_quantity_normalized: string

Fairmint

Base Schema:

  • asset: string
  • quantity: number

Verbose Additions:

  • asset_info: AssetInfo
  • quantity_normalized: string

Fairminter

Base Schema:

  • asset: string
  • asset_parent: string
  • price: number
  • quantity_by_price: number
  • max_mint_per_tx: number
  • hard_cap: number
  • premint_quantity: number
  • start_block: number
  • end_block: number
  • soft_cap: number
  • soft_cap_deadline_block: number
  • minted_asset_commission: string
  • burn_payment: boolean
  • lock_description: boolean
  • lock_quantity: boolean
  • divisible: boolean
  • description: string

Verbose Additions:

  • price_normalized: string
  • hard_cap_normalized: string
  • soft_cap_normalized: string
  • quantity_by_price_normalized: string

Broadcast

Base Schema:

  • timestamp: number
  • value: number
  • fee_fraction_int: number
  • text: string
  • status: string
  • memo: string (optional)

Verbose Additions:

  • fee_fraction_int_normalized: string

MPMASend

Base Schema:

  • asset: string
  • destination: string
  • quantity: number

Verbose Additions:

  • quantity_normalized: string

Also includes a special Transformed schema that wraps arrays of MPMASend.Verbose

Simple Message Types (No Verbose Variants)

Dispense

  • data: string

Detach

  • destination: string

Sweep

  • destination: string

Cancel

  • offer_hash: string
  • status: string

Send

  • asset: string
  • quantity: number
  • destination: string

Raw

Empty schema ({})

Dividend

Base Schema:

  • asset: string
  • quantity_per_unit: number
  • dividend_asset: string
  • status: string

Verbose Additions:

  • asset_info: AssetInfo
  • dividend_asset_info: AssetInfo
  • quantity_per_unit_normalized: string

Common Types

AssetInfo

Used in many verbose message types to provide additional asset information:

  • asset_longname: string | null
  • description: string
  • issuer: string | null
  • divisible: boolean
  • locked: boolean
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants