{"id":13620243,"url":"https://github.com/OlympusDAO/olympus-contracts","last_synced_at":"2025-04-14T19:31:34.958Z","repository":{"id":37877466,"uuid":"341376033","full_name":"OlympusDAO/olympus-contracts","owner":"OlympusDAO","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-07T20:24:57.000Z","size":21999,"stargazers_count":712,"open_issues_count":57,"forks_count":888,"subscribers_count":33,"default_branch":"main","last_synced_at":"2024-11-08T06:41:25.451Z","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":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OlympusDAO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":"audits/yacademy_ohm_final_report.pdf","citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-02-23T00:18:58.000Z","updated_at":"2024-11-07T11:54:02.000Z","dependencies_parsed_at":"2023-02-14T11:01:35.973Z","dependency_job_id":"ce4a5ee8-c206-41d5-a0f0-cc4546bf0e4a","html_url":"https://github.com/OlympusDAO/olympus-contracts","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlympusDAO%2Folympus-contracts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlympusDAO%2Folympus-contracts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlympusDAO%2Folympus-contracts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlympusDAO%2Folympus-contracts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OlympusDAO","download_url":"https://codeload.github.com/OlympusDAO/olympus-contracts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248945895,"owners_count":21187404,"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":"2024-08-01T21:00:53.748Z","updated_at":"2025-04-14T19:31:29.947Z","avatar_url":"https://github.com/OlympusDAO.png","language":"Solidity","funding_links":[],"categories":["Resources","Solidity"],"sub_categories":[],"readme":"# Ω Olympus Smart Contracts \n![image](https://img.shields.io/github/forks/OlympusDAO/olympus-contracts?style=social)\n\nThis is the main Olympus smart contract development repository.\n\n## 🔧 Setting up local development\n\n### Requirements\n\n-   [node v14](https://nodejs.org/download/release/latest-v14.x/)\n-   [git](https://git-scm.com/downloads)\n\n### Local Setup Steps\n\n```sh\n# Clone the repository\ngit clone https://github.com/OlympusDAO/olympus-contracts.git\n\n# Install dependencies\nyarn install\n\n# Set up environment variables (keys)\ncp .env.example .env # (linux)\ncopy .env.example .env # (windows)\n\n# compile solidity, the below will automatically also run yarn typechain\nyarn compile\n\n# if you want to explicitly run typechain, run\nyarn compile --no-typechain\nyarn typechain\n\n# run a local hardhat node\nyarn run start\n\n# test deployment or deploy \n# yarn run deploy:\u003cnetwork\u003e, example:\nyarn run deploy:hardhat\n```\n\n### Local Setup Steps (with Docker)\n\nA Docker image is available to simplify setup.\n\n```sh\n# First setup keys, to do this first copy as above\ncp .env.example .env # (linux)\ncopy .env.example .env # (windows)\n\n# Populate ALCHEMY_API_KEY and PRIVATE_KEY into `.env` afterwards\n# Then, start the node\nmake run\n```\n\n## 📜 Contract Addresses\n\n - For [Ethereum Mainnet](./docs/deployments/ethereum.md).\n - For [Rinkeby Testnet](./docs/deployments/rinkeby.md).\n\n### Notes for `localhost`\n-   The `deployments/localhost` directory is included in the git repository,\n    so that the contract addresses remain constant. Otherwise, the frontend's\n    `constants.ts` file would need to be updated.\n-   Avoid committing changes to the `deployments/localhost` files (unless you\n    are sure), as this will alter the state of the hardhat node when deployed\n    in tests.\n\n## 📖 Guides\n\n### Contracts\n- [Allocator Contribution Guidelines](https://hackmd.io/@3_ZONBhqRBukBJN302eDdQ/rk4qUyOlq)\n- [Allocator Interaction Instructions](https://hackmd.io/@OxbBIYzRTlqgmpSwc1bwWA/SJflVXcWq)\n- [Allocator version 1 guide (1.0.0)](./docs/guides/allocator_v1_guide.md).\n- [System Architecture (image)](./docs/guides/system_architecture.md)\n### Testing\n- [Hardhat testing guide](./docs/guides/hardhat_testing.md)\n- [Dapptools testing guide](./docs/guides/dapptools.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOlympusDAO%2Folympus-contracts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOlympusDAO%2Folympus-contracts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOlympusDAO%2Folympus-contracts/lists"}