{"id":25322400,"url":"https://github.com/checkernetwork/spark-rsr-contract","last_synced_at":"2025-04-07T22:22:27.884Z","repository":{"id":259393736,"uuid":"874703275","full_name":"CheckerNetwork/spark-rsr-contract","owner":"CheckerNetwork","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-06T10:05:08.000Z","size":137,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T12:36:30.194Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CheckerNetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-18T10:02:42.000Z","updated_at":"2024-11-06T10:05:12.000Z","dependencies_parsed_at":"2024-10-25T03:38:44.356Z","dependency_job_id":"27c55363-e984-4622-9f2d-2078eae40ec1","html_url":"https://github.com/CheckerNetwork/spark-rsr-contract","commit_stats":null,"previous_names":["filecoin-station/spark-rsr-contract","checkernetwork/spark-rsr-contract"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fspark-rsr-contract","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fspark-rsr-contract/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fspark-rsr-contract/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fspark-rsr-contract/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CheckerNetwork","download_url":"https://codeload.github.com/CheckerNetwork/spark-rsr-contract/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247737920,"owners_count":20987762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-13T23:40:41.809Z","updated_at":"2025-04-07T22:22:27.867Z","avatar_url":"https://github.com/CheckerNetwork.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spark-rsr-contract\n\n- Mainnet: `0x620bfc5AdE7eeEE90034B05DC9Bb5b540336ff90`\n- Calibration: `0x006fD9D10FCd2CFc830670e1c665ac23b478C252`\n\n[Abi](out/SparkRsr.sol/SparkRsr.json)\n\n[Interface spec](https://www.notion.so/protocollabs/Design-Spark-SLI-on-chain-interface-121837df73d4801aaaa4f13ff7839cd0?d=126837df73d4803a95c1001caac0aa71#b70f9a9b99dd43739b136393d08c2091)\n\n## Usage\n\nGet all provider retrieval result stats CIDs:\n\n```\nindex = 0\nloop:\n  try:\n    cid = contract.providerRetrievalResultStats(index++)\n  catch:\n    if (revert):\n      break\n```\n\nEach CID refers to a DAG-JSON object hosted on Storacha:\n\n```\nhttps://$CID.ipfs.w3s.link?format=car\n```\n\nYou can explore data from your browser using IPLD:\n\n```\nhttps://explore.ipld.io/#/explore/$CID\n```\n\nExample: https://explore.ipld.io/#/explore/baguqeera27yois66ac3fq3elk6ksdswk2em7lw3252l4osiogn7m5tyxusca\n\nEach provider retrieval result stats object is of this shape:\n\n```js\n{\n  \"date\": \"\u003cYYYY-MM-DD\u003e\",\n  \"meta\": {\n    \"rounds\": [\n      {\n        \"index\": \"\u003croundIndex\u003e\",\n        \"contractAddress\": \"\u003ccontractAddress\u003e\",\n        \"details\": { \"/\": \"\u003ccid\u003e\" }\n        \"measurementBatches\": [{ \"/\": \"\u003ccid\u003e\" }, ...],\n        \"sparkEvaluateVersion\": {\n          \"gitCommit\": \"\u003chash\u003e\",\n        },\n      },\n      ...\n    ]\n  },\n  \"providerRetrievalResultStats\": [\n    {\n      \"providerId\": \"\u003cproviderId\u003e\",\n      \"successful\": \u003cn\u003e,\n      \"total\": \u003cn\u003e\n    },\n    ...\n  ]\n}\n```\n\nSee full documentation at https://github.com/filecoin-project/service-classes/blob/main/service-level-indicators/spark-retrieval-success-rate.md#provider-retrieval-result-stats\n\n## Getters\n\n### `.providerRetrievalResultStats(uint offset) -\u003e string`\n\n## Methods\n\n### `new SparkRsr(address writer)`\n### `.addProviderRetrievalResultStats(address string)`\n\nMay only be called by `writer`.\n\n## Development\n\nThis repo requires Rust, Cargo and Foundry:\n- https://doc.rust-lang.org/book/ch01-01-installation.html\n- https://book.getfoundry.sh/getting-started/installation\n\n### Clone Repo and Install\n\n```console\ngit clone https://github.com/filecoin-station/spark-impact-evaluator.git\ncd spark-impact-evaluator\ngit submodule update --init --recursive\nforge test\n```\n\n## Tests\n\n```console\nforge test\n```\n\n## Deployment\n\nCalibration:\n\n```console\nforge create --rpc-url https://api.calibration.node.glif.io/rpc/v0 --mnemonic secrets/mnemonic src/SparkRsr.sol:SparkRsr --constructor-args \"0x...\"\n```\n\nMainnet:\n\n```console\nforge create --rpc-url https://api.node.glif.io/rpc/v0 src/SparkRsr.sol:SparkRsr --ledger --constructor-args \"0x...\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckernetwork%2Fspark-rsr-contract","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckernetwork%2Fspark-rsr-contract","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckernetwork%2Fspark-rsr-contract/lists"}