Spice Functions YAML Specification

Spice Functions configuration and metadata is defined in YAML. To create a Spice Function, add a function.yaml manifest file to a connected GitHub repository.

function.yaml should be co-located with the function code in a subdirectory from the root of the repository.

YAML Schema Reference

output_dataset

The Dataset this function's output will populate.

runtime

The execution runtime for the function. Supported runtimes are:

Runtime	Description
python3.11	Python 3.11
go1.x	go1.x

handler

The entry point file/module and code function/method that handles triggered executions.

Runtime	Format	Example
Python	filename.function_name	my_python_file.process
Go	main() in main.go

triggers

Specifies the trigger conditions of the function.

Example definition

# nft_mint_counter/function.yaml
output_dataset: nft_mint_counter
triggers:
  - path: eth
runtime: python3.11
handler: spice_function.process