Analyze Transaction

Phase 2: Create/Update YAML Documentation

1. Determine file path: public/yaml/transactions/v2/{system}/{role}/{tx-name}.yaml

   • Use endpoint-registry.json to confirm the correct system/role/action

2. Create or update the YAML file with these sections:

   • name, id, metadata (role, system, description, api_endpoint)
   • costs (txFee, protocolFee, minUtxo, executionUnits)
   • inputs (validator, address, redeemer, datum reference)
   • reference_inputs (UTxO references for scripts)
   • outputs (validator, address, value, datum)
   • mints (policy, tokens, redeemer)
   • withdraws (observer, redeemer) if applicable
   • registry (local summary of validators/policies used)

3. Update registries if new validators/policies discovered:

   • Add to address-registry.json with inferredFrom tracking
   • Add to cost-registry.json if new fee patterns found
   • Update endpoint-registry.json if schema differs from documented

Phase 3: Align with TypeScript Definitions (Required)

After completing the YAML documentation, verify and update the monorepo transaction definition:

1. Locate the definition file:

   • Path: ~/projects/01-projects/andamio-platform/andamio-platform-monorepo/packages/andamio-transactions/src/definitions/v2/{system}/{role}/{tx-name}.ts
   • If the file doesn't exist, create it following existing patterns

2. Verify alignment between YAML and TypeScript:

   • txParams schema matches the API request body from YAML
   • endpoint matches metadata.api_endpoint from YAML
   • estimatedCost aligns with costs section from YAML
   • docs.protocolDocs points to the correct MDX documentation path

3. Do NOT modify:

   • onSubmit and onConfirmation side effects (separate concern)
   • ui section (unless specifically requested)

4. Update index.ts exports if creating a new definition file

Phase 4: Handle Metadata (If Present)

If the transaction includes auxiliary_data.metadata, document it:

1. CIP-25 NFT Metadata (label 721):

   • Extract the policy ID and asset name
   • Document the metadata fields (name, image, description, etc.)
   • Add a metadata section to the YAML:

   metadata_721:
     policy: "{policy-name}"
     asset: "{token-name}"
     fields:
       name: "{NFT name}"
       description: "{description}"
       image: "{IPFS URI}"
       # ... other fields
   

2. Other metadata labels:

   • Document the label number and structure
   • Note any protocol-specific conventions

3. Update hex-patterns.md if new token naming patterns are discovered in metadata

Phase 5: Ask Clarifying Questions

When you find ambiguities, ask about:

• Redeemer action names (e.g., "Is this SpendIndex or UpdateIndex?")
• Datum field semantics (e.g., "What does the third field represent?")
• Token name patterns (e.g., "Is this a hash or an alias?")
• Optional vs required inputs (e.g., "Is this input always present?") </workflow>

# V2 Transaction: {Transaction Name}
# Source: Decoded from CBOR transaction