Consensus helpers

[ernest-nowacki]

Evolution of helpers, the last one is what you can use if this PR gets merged.

No helpers, everything inline

const onCronTrigger = async (env: Environment<Config>): Promise<void> => {
  env.logger?.log("Hello, Calculator! Workflow triggered.");

  const aggregatedValue = await runInNodeMode(async () => {
    const http = new cre.capabilities.HTTPClient();
    const resp = await http.sendRequest({
      url: env.config?.apiUrl,
      method: "GET",
    });

    const bodyStr = new TextDecoder().decode(resp.body);
    const num = Number.parseFloat(bodyStr.trim());

    return create(SimpleConsensusInputsSchema, {
      observation: observationValue(val.float64(num)),
      descriptors: consensusDescriptorMedian,
    });
  });

  sendResponseValue(val.mapValue({ Result: aggregatedValue }));
};

No helpers, split logic into smaller functions

// This is where you fetch your offchain data
const fetchMathResult = async (config: Config) => {
  const response = await cre.utils.fetch({
    url: config.apiUrl,
  });
  return Number.parseFloat(response.body.trim());
};

// This is how you guide nodes how to agree on a result
const fetchAggregatedResult = async (config: Config) =>
  cre.runInNodeMode(async () => {
    const result = await fetchMathResult(config);
    return cre.utils.consensus.getAggregatedValue(
      cre.utils.val.float64(result),
      "median"
    );
  });

// This is your handler which will perform the desired action
const onCronTrigger = async (env: Environment<Config>) => {
  const aggregatedValue = await fetchAggregatedResult(env.config);
  cre.sendResponseValue(cre.utils.val.mapValue({ Result: aggregatedValue }));
};

Helpers + smaller functions

const fetchMathResult = useMedianConsensus(async (config: Config) => {
  const response = await cre.utils.fetch({
    url: config.apiUrl,
  });
  return Number.parseFloat(response.body.trim());
}, "float64");

const onCronTrigger = async (env: Environment<Config>) => {
  const aggregatedValue = await fetchMathResult(env.config);
  cre.sendResponseValue(cre.utils.val.mapValue({ Result: aggregatedValue }));
};

[github-actions]

👋 ernest-nowacki, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

[jeffrifwaldsmartcontract]

Do these exist as generated constants from the protos?

[ernest-nowacki]

Protos exposes these as ENUM with numeric values which is not perfect :S but yeah it's called AggregationType I believe.

[jeffrifwaldsmartcontract]

I think workflows are starting to look a lot better and really take shape.