# @croptop/publisher

> Template used to code juicy solidity stuff - includes forge, libs, etc.

Latest version **0.0.4** (published 2023-10-02) · 0 weekly downloads

## Install

```sh
npm install @croptop/publisher
pnpm add @croptop/publisher
yarn add @croptop/publisher
bun add @croptop/publisher
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2023-10-02 |
| First published | 2023-07-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 25.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Maintainers | me.jango |

## Links

- npm: https://www.npmjs.com/package/@croptop/publisher
- npm.io page: https://npm.io/package/@croptop/publisher

## Dependencies (4)

- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) ^4.8.1
- [@jbx-protocol/juice-721-delegate](https://npm.io/package/@jbx-protocol/juice-721-delegate.md) ^8.0.0
- [@jbx-protocol/juice-contracts-v3](https://npm.io/package/@jbx-protocol/juice-contracts-v3.md) ^5.0.0
- [@jbx-protocol/juice-delegate-metadata-lib](https://npm.io/package/@jbx-protocol/juice-delegate-metadata-lib.md) git+https://github.com/jbx-protocol/juice-delegate-metadata-lib.git

## Recent versions

- 0.0.4 (latest) — 2023-10-02
- 0.0.3 — 2023-08-15
- 0.0.2 — 2023-08-15
- 0.0.1 — 2023-07-11

## README

# juice-contract-template
Template used to code juicy solidity stuff - includes forge, libs, etc. 

This template is a good starting point for building solidity extensions to the Juicebox Protocol. Forking this template may help you to avoid submodule related dependency issues down the road.

Do not push straight on main, rather create a new branch and open a PR - your reviewer will love you for this.

# Getting started
## Prerequisites
### Install & Update Foundry
Install 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).

### Install & Update Yarn
Follow 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+).

## Install Included Dependencies
Install dependencies (forge tests, Juice-contracts-V3, OZ) via `yarn install` (the `preinstall` script will run `forge install` for you)

# Adding dependencies
## With Yarn
If 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`.

Tell forge to look for node libraries by adding `node_modules` to the `foundry.toml` by updating `libs` like so: `libs = ['lib', 'node_modules']`.

Add dependencies to `remappings.txt` by running `forge remappings >> remappings.txt`. For example, the NPM package `jbx-protocol` is remapped as `@jbx-protocol/=node_modules/@jbx-protocol/`.

## With Forge
If 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.

Run `forge remappings > remappings.txt` to write the dependencies to `remappings.txt`. Note that this will overwrite that file. 

If nested dependencies are not installing, try this workaround `git submodule update --init --recursive --force`. Nested dependencies are dependencies of the dependencies you have installed. 

More information on remappings is available in the Forge Book.

# Updating dependencies
## With Yarn
Run `yarn upgrade [package]`.

## With Forge
Run `foundryup` to update forge. 

Run `forge update` to update all dependencies, or run `forge update [dependency]` to update a specific dependency.

# Usage
use `yarn test` to run tests

use `yarn test:fork` to run tests in CI mode (including slower mainnet fork tests)

use `yarn size` to check contract size

use `yarn doc` to generate natspec docs

use `yarn lint` to lint the code

use `yarn tree` to generate a Solidity dependency tree

use `yarn deploy:mainnet` and `yarn deploy:goerli` to deploy and verify (see .env.example for required env vars, using a ledger by default).

## Code coverage
Run `yarn coverage`to display code coverage summary and generate an LCOV report

To display code coverage in VSCode:
- 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
- ctrl shift p > "Coverage Gutters: Display Coverage" (coverage are the colored markdown lines in the left gutter, after the line numbers)

## PR
Github CI flow will run both unit and forked tests, log the contracts size (with the tests) and check linting compliance.

---
_Source: https://npm.io/package/@croptop/publisher · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._