cadence-challenges's Introduction

Cadence Challenges

This is the repo to collect verifiable Cadence Quests.

Template of a quest

The folder structure:

- quests
|- [questKey]
  |- README.md // The guide of current quest.
  |- verify.json // The configuare file about how to verify the quest.
  |- *.cdc // The verification scripts for this quest

On-chain information:

questKey
URL of README.md and verify.json

Off-chain information:

Markdown contents of guide in README.md
Verification parameters and description in verify.json
Cadence verification scripts which were defined URLs in verify.json

The schema of verify.json
It should be an array of verification steps.

[
  // Onchain verification schema
  {
    "title": "The title of current quest step",
    "description": "The description of current quest step",
    "type": "onchain",
    "code": "URL of the verification scripts' code",
    "schema": [
      {
        "key": "parameter key",
        "type": "Address" // The input type, Address|String|UInt64|...
      }
    ],
    "test": { // All tests should be OK, then quest passed
      "network": "testnet",
      "expect": "return", // return or error; 'error' means some thing wrong when excuting this test
      "result": true // The result value of the execution for this test
    }
  },
  // Simple Quiz schema
  {
    "title": "The title of current quest step",
    "description": "The description of current quest step",
    "type": "quiz",
    "quiz": [
      {
        "type": "radio",
        "question": "Quiz question",
        "options": [
          {
            "key": "A",
            "description": "Quiz option's description"
          }
        ],
        "answer": "A"
      }
    ]
  },
]

Recommend Projects