[!NOTE] This repository is a submodule of the larger Plug monorepo that contains all the required pieces to run the entire Plug stack yourself.

The core package of Plug powers the building and verification of declarative messages in both a server-context and interactive-wallet environment using the connected wallet when possible.

Dependencies

In order to run @terminallyonline/plug-core it is necessary to install all of the following dependencies first:

├─ foundry - "Foundry is a blazing fast, portable and modular toolkit for Ethereum application."
└─ pnpm — "Efficient package manager for Node modules."

Deployment

The deployment pipeline of Plug is setup to be as simple as possible and multichain by default. There is a single script to run (for the current version) that will deploy all the instances of the implementation based contracts. Because we are using CREATE2 for deployments it does not matter who sends the transaction.

forge script \
    --chain <chain_name> \
    --rpc-url <rpc_url> \
    --broadcast \
    -vvvv \
    src/contracts/script/Plug.s.sol

If you don't care about verifying the contract right now you can skip this step. Please don't skip it unless you're doing something for development. When you want to verify the contract so you will need to add an ETHERSCAN_API_KEY to your .env and include the --verify tag when running the deployment script.

When you are setting everything up you will want to remove the --broadcast so that it just simulates everything and you can confirm you have everything setup right before running a transaction.

Built into the scripts are redeploy protection so if you are running a batch deploy and one succeeds, but one fails, you can just rerun the same script.

Addresses

All contracts that should be deterministic are. That means Plug.sol, Plug.Factory.sol and the base Plug.Socket.sol are all found at constant addresses across chains. The only time the address will change when a new version is deployed. This will happen most common for the Socket, but we will always keep the list updated.

[v0.5.4]:
├─ Mining Configuration:
│  ├─ Leading Zeros: 4
│  ├─ Total Zeros: 8
│  ├─ Factory: 0x0000000000ffe8b47b3e2130213b802212439497
│  └─ Quick Mode: Yes
│
└─ Contracts:
   ├─ Plug.Assert.sol [256] — "0x00000000E830C2dFfa9B69cF0a5eD7323ee5221C"
   ├─ Plug.Boolean.sol [256] — "0x0000000062b4cde8cf8AAB13CADC85bbfD5FeeE9"
   ├─ Plug.Coercion.sol [256] — "0x0000000021113D96a58E15F40b50af1149b34EA8"
   ├─ Plug.Database.sol [256] — "0x00000000507376e5E3106CAb060E8369e9ffb6e0"
   ├─ Plug.EVM.sol [256] — "0x000000005f138dC65676f1a4e6C523483B629F2A"
   ├─ Plug.Factory.sol [256] — "0x00000000D29C274c206F51528868E84651798292"
   ├─ Plug.Math.sol [256] — "0x00000000377FF51f3d4F23F0c963eD9d0CD6Bb34"
   ├─ Plug.Socket.sol [256] — "0x00000000E0397b53F8845cD642Fd1e09be1F59FF"
   ├─ Plug.Ticket.sol [4217] — "0x0000000048ff6276eF007caA363f659298F9753f"
   ├─ Plug.Time.sol [256] — "0x00000000c31784854546e6b1ffCa11917d2DfDD7"
   └─ Plug.sol [256] — "0x00000000F10e32471c86cE1d110D27f5D03e1A72"