Support npm i ava-labs/teleporter

[hsk81]

..to allow installing the Teleporter dependencies via the NPM registry (to use for example in a Hardhat project).

[samthompsonkennedy]

If you're using Hardhat, you can use hard-foundry in your Hardhat project.

1. Install hardhat-foundry

Install hardhat-foundry

pnpm i -D @nomicfoundation/hardhat-foundry

Add hardhat-foundry to your hardhat.config.js

import "@nomicfoundation/hardhat-foundry";

2. Install Teleporter with Forge

forge install https://github.com/ava-labs/teleporter

3. Ensure all dependancies have recursively installed

git submodule update --init --recursive
forge install

4. Add remappings.txt for Teleporter

This should be at the root, alongside your hardhat.config.ts

# remappings.txt

@teleporter/=lib/teleporter/contracts/src/Teleporter
@avalabs/subnet-evm-contracts@1.2.0/=lib/teleporter/contracts/lib/subnet-evm/contracts/
@openzeppelin/contracts@4.8.1=lib/teleporter/contracts/lib/openzeppelin-contracts/contracts/
@mocks/=lib/teleporter/contracts/src/Mocks/

5. You can now add Teleported to your contracts!

// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity ^0.8.18;

import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {ITeleporterReceiver} from "@teleporter/ITeleporterReceiver.sol";
import {ITeleporterMessenger, TeleporterMessageInput, TeleporterFeeInfo} from "@teleporter/ITeleporterMessenger.sol";
import {ITeleporterConfigEvents} from "./interfaces/ITeleporterConfigEvents.sol";
import {TeleporterOwnerUpgradeable} from "@teleporter/upgrades/TeleporterOwnerUpgradeable.sol";

abstract contract MyTeleporter is Ownable, TeleporterOwnerUpgradeable {
    ...
}