Schema description audit decoded - GoldRush API Documentation

Schema Description Audit — Decoded Events & Related Types
Priority 1: Decoded Event Types (blocks decoded-events page generation)
DecodedDetails (INTERFACE)
ApproveTransaction (OBJECT)
BridgeTransaction (OBJECT)
DepositTransaction (OBJECT)
ErrorDetails (OBJECT)
HyperLiquidFillTransaction (OBJECT)
HyperLiquidFundingTransaction (OBJECT)
HyperLiquidLedgerTransaction (OBJECT)
SwapTransaction (OBJECT)
TransferTransaction (OBJECT)
WithdrawTransaction (OBJECT)
Sub-object types referenced by decoded events
TransactionType (ENUM)
Priority 2: Gems & Other Types
Summary

Date: 2026-04-10 Total missing: 192 descriptions These types have no descriptions in the GraphQL introspection response. Adding descriptions to the backend schema will allow the docs site to auto-generate the Decoded Events page and improve all field-level documentation.

Priority 1: Decoded Event Types (blocks decoded-events page generation)

The DecodedDetails INTERFACE and all 10 implementing types have zero descriptions — neither type-level nor field-level.

`DecodedDetails` (INTERFACE)

Type description: ❌ missing

Field	Type	Description
`typeString`	string	❌ missing

`ApproveTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount`	string	❌ missing
`quote_usd`	float	❌ missing
`quote_rate_usd`	float	❌ missing
`spender`	string	❌ missing
`contract_metadata`	object (`TokenContractMetadata`)	❌ missing

`BridgeTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount`	string	❌ missing
`quote_usd`	float	❌ missing
`quote_rate_usd`	float	❌ missing
`contract_metadata`	object (`TokenContractMetadata`)	❌ missing
`from`	string	❌ missing
`to`	string	❌ missing

`DepositTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount`	string	❌ missing
`quote_usd`	float	❌ missing
`quote_rate_usd`	float	❌ missing
`contract_metadata`	object (`TokenContractMetadata`)	❌ missing
`from`	string	❌ missing
`to`	string	❌ missing

`ErrorDetails` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`message`	string	❌ missing
`typeString`	string	❌ missing

`HyperLiquidFillTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`liquidation`	object (`HyperLiquidLiquidation`)	❌ missing
`side`	string	❌ missing
`closedPnl`	string	❌ missing
`fee`	string	❌ missing
`feeToken`	string	❌ missing
`oid`	string	❌ missing
`dir`	string	❌ missing
`startPosition`	string	❌ missing
`tid`	string	❌ missing
`size`	string	❌ missing
`price`	string	❌ missing
`time`	string	❌ missing
`crossed`	boolean	❌ missing
`hash`	string	❌ missing
`coin`	string	❌ missing

`HyperLiquidFundingTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`szi`	string	❌ missing
`time`	string	❌ missing
`usdc`	string	❌ missing
`coin`	string	❌ missing
`fundingRate`	string	❌ missing

`HyperLiquidLedgerTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	string	❌ missing
`typeString`	string	❌ missing
`fee`	string	❌ missing
`toPerp`	boolean	❌ missing
`time`	string	❌ missing
`usdc`	string	❌ missing
`hash`	string	❌ missing

`SwapTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount_out`	string	❌ missing
`amount_in`	string	❌ missing
`token_out`	object (`TokenContractMetadata`)	❌ missing
`token_in`	object (`TokenContractMetadata`)	❌ missing

`TransferTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount`	string	❌ missing
`quote_usd`	float	❌ missing
`quote_rate_usd`	float	❌ missing
`contract_metadata`	object (`TokenContractMetadata`)	❌ missing
`from`	string	❌ missing
`to`	string	❌ missing

`WithdrawTransaction` (OBJECT)

Type description: ❌ missing

Field	Type	Description
`type`	enum (`TransactionType`)	❌ missing
`typeString`	string	❌ missing
`amount`	string	❌ missing
`quote_usd`	float	❌ missing
`quote_rate_usd`	float	❌ missing
`contract_metadata`	object (`TokenContractMetadata`)	❌ missing
`from`	string	❌ missing
`to`	string	❌ missing

Sub-object types referenced by decoded events

TokenContractMetadata: ✅ all fields have descriptions HyperLiquidLiquidation:

Field	Type	Description
`marketPrice`	string	❌ missing
`method`	string	❌ missing
`liquidatedUser`	string	❌ missing

`TransactionType` (ENUM)

Value	Description
`APPROVE`	❌ missing
`BRIDGE`	❌ missing
`DEPOSIT`	❌ missing
`FILL`	❌ missing
`FUNDING`	❌ missing
`LEDGER`	❌ missing
`LIQUIDATION`	❌ missing
`SWAP`	❌ missing
`TRANSFER`	❌ missing
`WITHDRAW`	❌ missing

Priority 2: Gems & Other Types

These types are not yet documented but have zero descriptions. Lower priority — add when ready.

GainerGem: 14 fields missing descriptions
LoserGem: 14 fields missing descriptions
MomentumGem: 12 fields missing descriptions
NewGem: 12 fields missing descriptions
SpikeGem: 11 fields missing descriptions
SafetySnapshot: 7 fields missing descriptions
ModuleScore: 2 fields missing descriptions
TokenBalance: 6 fields missing descriptions
BalanceItem: 4 fields missing descriptions
ChainDexInfo: 2 fields missing descriptions
Entry_String_String: 2 fields missing descriptions

Summary

Category	Missing	Impact
Decoded event type descriptions	11	Blocks decoded-events page generation
Decoded event field descriptions	79	Empty field descriptions in docs
Sub-object field descriptions (HyperLiquidLiquidation)	3	Incomplete nested docs
TransactionType enum values	10	No enum value context
Gems & other types	86	Future documentation
Total	192

⌘I