Function debugTemplate

packages/cashscript/src/debugging.ts:36–64

(template: WalletTemplate, artifacts: Artifact[])

// debugs the template, optionally logging the execution data
export const debugTemplate = (template: WalletTemplate, artifacts: Artifact[]): DebugResults => {
  // If a contract has the same name, but a different bytecode, then it is considered a name collision
  const hasArtifactNameCollision = artifacts.some(
    (artifact) => (
      artifacts.some((other) => other.contractName === artifact.contractName && other.bytecode !== artifact.bytecode)
    ),
  );

  if (hasArtifactNameCollision) {
    throw new Error('There are multiple artifacts with the same contractName. Please make sure that all artifacts have unique names.');
  }

  const results: DebugResults = {};
  const unlockingScriptIds = Object.keys(template.scripts).filter((key) => 'unlocks' in template.scripts[key]);

  for (const unlockingScriptId of unlockingScriptIds) {
    const scenarioIds = (template.scripts[unlockingScriptId] as WalletTemplateScriptUnlocking).passes ?? [];

    const matchingArtifact = artifacts.find((artifact) => unlockingScriptId.startsWith(artifact.contractName));

    for (const scenarioId of scenarioIds) {
      results[`${unlockingScriptId}.${scenarioId}`] = debugSingleScenario(template, matchingArtifact, unlockingScriptId, scenarioId);
    }
  }

  verifyFullTransaction(template);

  return results;
};

const debugSingleScenario = (
  template: WalletTemplate, artifact: Artifact | undefined, unlockingScriptId: string, scenarioId: string,