haberdasher-labs_season-toggle_v0.1.0.json

{
  "id": "haberdasher-labs_season-toggle",
  "version": "v0.1.0",
  "name": "Season Toggle",
  "details": [
    "A Hats Protocol toggle module that allows an organization to configure certain hats to be automatically toggled off after a given interval, i.e. a 'season'.",
    "In Hats Protocol, hats can be configured with Toggle modules that programmatically control whether and when the hat is active or inactive. Season Toggle adds an automatic expiry for a group of hats within a given branch of an organization's hat tree, unless an admin of that branch explicitly extends it to a new season."
  ],
  "links": [
    {
      "label": "GitHub",
      "link": "https://github.com/Hats-Protocol/season-toggle"
    }
  ],
  "parameters": [
    {
      "label": "Season End",
      "functionName": "seasonEnd",
      "displayType": "timestamp"
    },
    {
      "label": "Season Duration (Current Season Length)",
      "functionName": "seasonDuration",
      "displayType": "seconds"
    }
  ],
  "type": {
    "eligibility": false,
    "toggle": true,
    "hatter": false
  },
  "tags": [],
  "implementationAddress": "0xFb6bD2e96B123d0854064823f6cb59420A285C00",
  "deployments": [
    {
      "chainId": "5",
      "block": "9597342"
    },
    {
      "chainId": "11155111",
      "block": "4655503"
    },
    {
      "chainId": "10",
      "block": "110683928"
    },
    {
      "chainId": "137",
      "block": "48562673"
    },
    {
      "chainId": "42161",
      "block": "139448916"
    },
    {
      "chainId": "100",
      "block": "30406143"
    },
    {
      "chainId": "8453",
      "block": "12330237"
    },
    {
      "chainId": "42220",
      "block": "24755867"
    }
  ],
  "creationArgs": {
    "useHatId": true,
    "immutable": [],
    "mutable": [
      {
        "name": "Season Duration",
        "description": "The length of the season, in seconds. Must be larger than 1 hour",
        "type": "uint256",
        "example": "2592000",
        "displayType": "seconds"
      },
      {
        "name": "Extension Delay",
        "description": "The proportion of the season that must elapse before the branch can be extended for another season, The value is treated as the numerator `x` in the expression `x / 10,000`",
        "type": "uint256",
        "example": "5000",
        "displayType": "default"
      }
    ]
  },
  "customRoles": [],
  "writeFunctions": [
    {
      "roles": ["hatAdmins"],
      "functionName": "extend",
      "label": "New Season",
      "description": "Extend the branch for a new season, optionally with a new season duration",
      "primary": true,
      "args": [
        {
          "name": "Duration",
          "description": "Optional new custom season duration, in seconds",
          "type": "uint256",
          "displayType": "seconds"
        },
        {
          "name": "Extension Delay",
          "description": "Optional new proportion of the season that must elapse before the branch can be extended for another season, The value is treated as the numerator `x` in the expression `x / 10,000`",
          "type": "uint256",
          "displayType": "default"
        }
      ]
    }
  ],
  "abi": [
    {
      "inputs": [
        { "internalType": "string", "name": "__version", "type": "string" }
      ],
      "stateMutability": "nonpayable",
      "type": "constructor"
    },
    {
      "inputs": [],
      "name": "SeasonToggle_InvalidExtensionDelay",
      "type": "error"
    },
    { "inputs": [], "name": "SeasonToggle_NotBranchAdmin", "type": "error" },
    { "inputs": [], "name": "SeasonToggle_NotExtendable", "type": "error" },
    {
      "inputs": [],
      "name": "SeasonToggle_SeasonDurationTooShort",
      "type": "error"
    },
    {
      "anonymous": false,
      "inputs": [
        {
          "indexed": false,
          "internalType": "uint256",
          "name": "_branchRoot",
          "type": "uint256"
        },
        {
          "indexed": false,
          "internalType": "uint256",
          "name": "_duration",
          "type": "uint256"
        },
        {
          "indexed": false,
          "internalType": "uint256",
          "name": "_extensionDelay",
          "type": "uint256"
        }
      ],
      "name": "Extended",
      "type": "event"
    },
    {
      "anonymous": false,
      "inputs": [
        {
          "indexed": false,
          "internalType": "uint8",
          "name": "version",
          "type": "uint8"
        }
      ],
      "name": "Initialized",
      "type": "event"
    },
    {
      "inputs": [],
      "name": "HATS",
      "outputs": [
        { "internalType": "contract IHats", "name": "", "type": "address" }
      ],
      "stateMutability": "pure",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "IMPLEMENTATION",
      "outputs": [{ "internalType": "address", "name": "", "type": "address" }],
      "stateMutability": "pure",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "MIN_SEASON_DURATION",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [
        { "internalType": "uint256", "name": "_duration", "type": "uint256" },
        {
          "internalType": "uint256",
          "name": "_extensionDelay",
          "type": "uint256"
        }
      ],
      "name": "extend",
      "outputs": [],
      "stateMutability": "nonpayable",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "extendable",
      "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "extensionDelay",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "extensionThreshold",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "name": "getHatStatus",
      "outputs": [
        { "internalType": "bool", "name": "_active", "type": "bool" }
      ],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "hatId",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "pure",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "seasonDuration",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "seasonEnd",
      "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [
        { "internalType": "bytes", "name": "_initData", "type": "bytes" }
      ],
      "name": "setUp",
      "outputs": [],
      "stateMutability": "nonpayable",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "version",
      "outputs": [{ "internalType": "string", "name": "", "type": "string" }],
      "stateMutability": "view",
      "type": "function"
    },
    {
      "inputs": [],
      "name": "version_",
      "outputs": [{ "internalType": "string", "name": "", "type": "string" }],
      "stateMutability": "view",
      "type": "function"
    }
  ]
}