# @hopelend/deploy

> [![npm (scoped)](https://img.shields.io/npm/v/@hopelend/deploy)](https://www.npmjs.com/package/@hopelend/deploy)

Latest version **1.0.1** (published 2023-08-08) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @hopelend/deploy
pnpm add @hopelend/deploy
yarn add @hopelend/deploy
bun add @hopelend/deploy
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-08-08 |
| First published | 2023-08-08 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 1 |
| Unpacked size | 49.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | HopeLend |
| Maintainers | hope_ecosystem |

## Links

- npm: https://www.npmjs.com/package/@hopelend/deploy
- Repository: https://github.com/Light-Ecosystem/lend-deploy
- Homepage: https://github.com/Light-Ecosystem/lend-deploy#readme
- Issues: https://github.com/Light-Ecosystem/lend-deploy/issues
- npm.io page: https://npm.io/package/@hopelend/deploy

## Dependencies (1)

- [defender-relay-client](https://npm.io/package/defender-relay-client.md) ^1.11.1

## Recent versions

- 1.0.1 (latest) — 2023-08-08
- 1.0.0 — 2023-08-08

## README

# HopeLend Deployments

[![npm (scoped)](https://img.shields.io/npm/v/@hopelend/deploy)](https://www.npmjs.com/package/@hopelend/deploy)

This Node.js repository contains the configuration and deployment scripts for the HopeLend protocol core and periphery contracts. The repository makes use of `hardhat` and `hardhat-deploy` tools to facilitate the deployment of HopeLend protocol.

## Requirements

- Node.js >= 16
- Alchemy or Infura API key
  - If you use a custom RPC node, you can change the default RPC provider URL at [./helpers/hardhat-config-helpers.ts:25](./helpers/hardhat-config-helpers.ts).
- Etherscan API key _(Optional)_

## Getting Started

1. Install Node.JS dependencies:

   ```
   npm i
   ```

2. Compile contracts before running any other command, to generate Typechain TS typings:

   ```
   npm run compile
   ```

## Project Structure

| Path                  | Description                                                                                                                     |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| deploy/               | Main deployment scripts dir location                                                                                            |
| ├─ 00-core/           | Core deployment, only needed to run once per network.                                                                           |
| ├─ 01-periphery_pre/  | Periphery contracts deployment, only need to run once per network.                                                              |
| ├─ 02-market/         | Market deployment scripts, depends of Core and Periphery deployment.                                                            |
| ├─ 03-periphery_post/ | Periphery contracts deployment after market is deployed.                                                                        |
| ├─ 04-upgrade/ | Upgrade contracts. 
| deployments/          | Artifacts location of the deployments, contains the addresses, the abi, solidity input metadata and the constructor parameters. |
| markets/              | Directory to configure HopeLend markets                                                                                             |
| tasks/                | Hardhat tasks to setup and review market configs                                                                                |
| helpers/              | Utility helpers to manage configs and deployments                                                                               |

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