{"id":17658938,"url":"https://github.com/nnnnicholas/l2inbox","last_synced_at":"2025-03-30T10:41:04.241Z","repository":{"id":182639252,"uuid":"668834144","full_name":"nnnnicholas/L2Inbox","owner":"nnnnicholas","description":"A Solidity contract that lets EVM wallets communicate via encrypted messages in a gas efficient way.","archived":false,"fork":false,"pushed_at":"2023-07-20T19:26:03.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T12:27:44.870Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nnnnicholas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-20T17:38:41.000Z","updated_at":"2023-07-20T17:38:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"24100b7a-dc0f-4892-ba14-2b52b30d1990","html_url":"https://github.com/nnnnicholas/L2Inbox","commit_stats":null,"previous_names":["nnnnicholas/l2inbox"],"tags_count":0,"template":false,"template_full_name":"nnnnicholas/contract-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nnnnicholas%2FL2Inbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nnnnicholas%2FL2Inbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nnnnicholas%2FL2Inbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nnnnicholas%2FL2Inbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nnnnicholas","download_url":"https://codeload.github.com/nnnnicholas/L2Inbox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246307932,"owners_count":20756478,"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-10-23T15:43:55.613Z","updated_at":"2025-03-30T10:41:04.191Z","avatar_url":"https://github.com/nnnnicholas.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# contract-template\n# Getting started\n## Prerequisites\n### Install \u0026 Update Foundry\nInstall Forge with `curl -L https://foundry.paradigm.xyz | bash`. If you already have Foundry installed, run `foundryup` to update to the latest version. More detailed instructions can be found in the [Foundry Book](https://book.getfoundry.sh/getting-started/installation).\n\n### Install \u0026 Update Yarn\nFollow the instructions in the [Yarn Docs](https://classic.yarnpkg.com/en/docs/install). People tend to use the latest version of Yarn 1 (not Yarn 2+).\n\n## Install Included Dependencies\nInstall dependencies (forge tests, Juice-contracts-V3, OZ) via `yarn install` (the `preinstall` script will run `forge install` for you)\n\n# Adding dependencies\n## With Yarn\nIf the dependency you would like to install has an NPM package, use `yarn add [package]` where [package] is the package name. This will install the dependency to `node_modules`.\n\nTell forge to look for node libraries by adding `node_modules` to the `foundry.toml` by updating `libs` like so: `libs = ['lib', 'node_modules']`.\n\n## With Forge\nIf the dependency you would like to install does not have an up-to-date NPM package, use `forge install [dependency]` where [dependency] is the path to the dependency repo. This will install the dependency to `/lib`. Forge manages dependencies using git submodules.\n\nRun `forge remappings \u003e remappings.txt` to write the dependencies to `remappings.txt`. Note that this will overwrite that file. \n\nIf nested dependencies are not installing, try this workaround `git submodule update --init --recursive --force`. Nested dependencies are dependencies of the dependencies you have installed. \n\nMore information on remappings is available in the Forge Book.\n\n# Updating dependencies\n## With Yarn\nRun `yarn upgrade [package]`.\n\n## With Forge\nRun `foundryup` to update forge. \n\nRun `forge update` to update all dependencies, or run `forge update [dependency]` to update a specific dependency.\n\n# Usage\nuse `yarn test` to run tests\n\nuse `yarn test:fork` to run tests in CI mode (including slower mainnet fork tests)\n\nuse `yarn size` to check contract size\n\nuse `yarn doc` to generate natspec docs\n\nuse `yarn lint` to lint the code\n\nuse `yarn tree` to generate a Solidity dependency tree\n\nuse `yarn deploy:mainnet` and `yarn deploy:goerli` to deploy and verify (see .env.example for required env vars, using a ledger by default).\n\n## Code coverage\nRun `yarn coverage`to display code coverage summary and generate an LCOV report\n\nTo display code coverage in VSCode:\n- You need to install the [coverage gutters extension (Ryan Luker)](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) or any other extension handling LCOV reports\n- ctrl shift p \u003e \"Coverage Gutters: Display Coverage\" (coverage are the colored markdown lines in the left gutter, after the line numbers)\n\n## PR\nGithub CI flow will run both unit and forked tests, log the contracts size (with the tests) and check linting compliance.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnnnnicholas%2Fl2inbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnnnnicholas%2Fl2inbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnnnnicholas%2Fl2inbox/lists"}