Simplify Nabla project

pendulum-chain · Oct 8, 2024 · 48bf572 · 48bf572
1 parent c597a83
commit 48bf572
Show file tree

Hide file tree

Showing 34 changed files with 401 additions and 3,327 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,25 @@
 
 Usage for the example project:
 
-1. Pull the Solidity source files from git: `npx ts-node src/index.ts pull nabla`
-2. Deploy: `npx ts-node src/index.ts deploy nabla --network foucoco`
+1. Pull the Solidity source files from git: `npx tsx src/index.ts pull nabla`
+2. Deploy: `npx tsx src/index.ts deploy nabla --network foucoco --deployment mockTestnet`
 
 Alternatively you can use the parameter `local` instead of `foucoco`. This expects that there is a local chain running
 on port `9944` – this is particularly useful to run together with
 the [foucoco-standalone](https://github.com/pendulum-chain/foucoco-standalone) node.
 
+## General deployment instructions
+
+The `deploy` command takes two required arguments:
+
+- `--network`: one of the networks defined in the file `nabla/config.json` (`pendulum`, `foucoco` or `local`)
+- `--deployment`: one of the deployment definitions, see `nabla/deployments/selector.ts`:
+  - `usdtVortexPrototype`: described [on Notion](https://www.notion.so/satoshipay/24-05-16-USDT-Prototype-Deployment-1118b1b29b2f806f9070e734a10162d3)
+  - `usdcAxelarVortexPrototype`: described [on Notion](https://www.notion.so/satoshipay/24-07-04-USDC-axl-Prototype-Deployment-1118b1b29b2f80c7ba3ad321c6bb3e8b)
+  - `productionPendulum`: described [on Notion](https://www.notion.so/satoshipay/24-09-30-Public-Deployment-1118b1b29b2f807283dbd10e0a6ae8b9)
+  - `mockTestnet`: described [on Notion](https://www.notion.so/satoshipay/24-09-30-Nabla-Foucoco-Paseo-Deployment-1118b1b29b2f804eababf94383a56f7b)
+  - `slippageTest`: used for validating slippage calulcations, see [this page on Notion](https://www.notion.so/satoshipay/24-09-30-Public-Deployment-1118b1b29b2f807283dbd10e0a6ae8b9?pvs=4#1158b1b29b2f80bc8be8efb7bc5197b4)
+
 # Required
 
 ```
@@ -90,4 +102,4 @@ subdirectories of `target/git`.
 These are only available if the `npm install` or `yarn install` command was executed successfully in the respective
 directory.
 This should automatically be done by the 'deploy' script though, so if you encounter this issue, try debugging
-dependency issues in the respective `package.json` file.
+dependency issues in the respective `package.json` file.
diff --git a/nabla-pendulum/NablaCurve.contract b/nabla-pendulum/NablaCurve.contract
diff --git a/nabla-pendulum/README.md b/nabla-pendulum/README.md
diff --git a/nabla-pendulum/VendingMachine.contract b/nabla-pendulum/VendingMachine.contract
diff --git a/nabla-pendulum/_lib.ts b/nabla-pendulum/_lib.ts
diff --git a/nabla-pendulum/config.json b/nabla-pendulum/config.json
diff --git a/nabla-pendulum/deploy/01_deploy_router.ts b/nabla-pendulum/deploy/01_deploy_router.ts
diff --git a/nabla-pendulum/deploy/02_deploy_token_wrappers.ts b/nabla-pendulum/deploy/02_deploy_token_wrappers.ts
diff --git a/nabla-pendulum/deploy/03_deploy_oracle_wrappers.ts b/nabla-pendulum/deploy/03_deploy_oracle_wrappers.ts
diff --git a/nabla-pendulum/deploy/04_deploy_curves.ts b/nabla-pendulum/deploy/04_deploy_curves.ts