deploy: adds Solana config

Author: scnale

deployment/config/config-types.ts

@@ -1,34 +1,99 @@
 import { ChainId } from "@wormhole-foundation/sdk-base";
 
+// TODO: check if solana has different needs for the TokenRouter
 export type TokenRouterConfiguration = {
   // Wormhole Chain ID of the token router configuration
   chainId: ChainId;
 
   // Mutable values
+  /**
+   * Account with the authority to add
+   * new token routers among other operations.
+   */
   ownerAssistant: string;
   fastTransferParameters: {
     enabled: boolean;
-    maxAmount: number;
-    baseFee: number;
-    initAuctionFee: number;
+    /**
+     * Expressed in μUSDC.
+     * E.g. 1000000000 is 1000 USDC.
+     */
+    maxAmount: string;
+    /**
+     * Expressed in μUSDC.
+     * E.g. 1250000 is 1.25 USDC.
+     */
+    baseFee: string;
+    /**
+     * Expressed in μUSDC.
+     * E.g. 950000 is 0.95 USDC.
+     */
+    initAuctionFee: string;
   };
   cctpAllowance: string;
   disableRouterEndpoints?: ChainId[];
 };
 
 export type MatchingEngineConfiguration = {
-  // Wormhole Chain ID of the matching engine configuration
+  /**
+   * Wormhole Chain ID of the matching engine configuration
+   */
   chainId: ChainId;
 
   // Immutable values
+  /**
+   * The part of the penalty that is awarded to the user when the auction is completed.
+   * E.g. 400000 is 40%.
+   */
   userPenaltyRewardBps: string;
+  /**
+   * The initial penalty proportion that is incurred once the grace period is over.
+   * E.g. 250000 is 25%.
+   */
   initialPenaltyBps: string;
+  /**
+   * Auction duration in Solana slots.
+   */
   auctionDuration: string;
+  /**
+   * Auction grace period in Solana slots.
+   * The grace period of the auction in slots. This is the number of slots the highest bidder
+   * has to execute the fast order before incurring a penalty.
+   * This value INCLUDES the `auctionDuration`.
+   */
   auctionGracePeriod: string;
-  auctionPenaltyBlocks: string;
+  /**
+   * The `securityDeposit` decays over this period.
+   * Expressed in Solana slots.
+   */
+  auctionPenaltySlots: string;
+  /**
+   * minimum offer increment for auctions.
+   * New offers need to surpass a threshold given by this parameter.
+   * E.g. 50000 is 5%.
+   */
+  minOfferDeltaBps: string;
+  /**
+   * The base security deposit, which will the the additional amount an auction participant must
+   * deposit to participate in an auction. Expressed in μUSDC.
+   * E.g. 1000000 is 1 USDC.
+   */
+  securityDepositBase: string;
+  /**
+   * Additional security deposit based on the notional of the order amount.
+   * E.g. 5000 is 0.5%.
+   */
+  securityDepositBps: string;
 
   // Mutable values
+  /**
+   * Solana account with the authority to add
+   * new token routers among other operations.
+   */
   ownerAssistant: string;
+  /**
+   * Fee recipient for relayer service of slow orders, i.e. those that do not
+   * have an associated auction.
+   */
   feeRecipient: string;
   cctpAllowance: string;
 };

deployment/config/testnet/matching-engine.json

@@ -7,7 +7,7 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   },
   {
     "chainId": 5,
@@ -17,7 +17,7 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   },
   {
     "chainId": 6,
@@ -27,7 +27,7 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   },
   {
     "chainId": 23,
@@ -37,7 +37,7 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   },
   {
     "chainId": 24,
@@ -47,7 +47,7 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   },
   {
     "chainId": 30,
@@ -57,6 +57,6 @@
     "initialPenaltyBps": "",
     "auctionDuration": "",
     "auctionGracePeriod": "",
-    "auctionPenaltyBlocks": ""
+    "auctionPenaltySlots": ""
   }
 ]

deployment/scripts/solana/initializeMatchingEngine.ts

@@ -12,18 +12,6 @@ import { ProgramId } from "@wormhole-foundation/example-liquidity-layer-solana/m
 import { SolanaLedgerSigner } from "@xlabs-xyz/ledger-signer-solana";
 import { circle } from "@wormhole-foundation/sdk-base";
 
-
-const AUCTION_PARAMS: AuctionParameters = {
-    userPenaltyRewardBps: 400000, // 40%
-    initialPenaltyBps: 250000, // 25%
-    duration: 5, // slots
-    gracePeriod: 10, // slots
-    penaltyPeriod: 20, // slots
-    minOfferDeltaBps: 50000, // 5%
-    securityDepositBase: uint64ToBN(1000000n), // 1 USDC
-    securityDepositBps: 5000, // 0.5%
-};
-
 runOnSolana("deploy-matching-engine", async (chain, signer, log) => {
     const config = await getChainConfig<MatchingEngineConfiguration>("matching-engine", chain.chainId);
     const matchingEngineId = getContractAddress("MatchingEngine", chain.chainId) as ProgramId;
@@ -49,13 +37,23 @@ async function initialize(matchingEngine: MatchingEngineProgram, signer: SolanaL
     }
 
     const signerPubkey = new PublicKey(await signer.getAddress());
+    const auctionParams: AuctionParameters = {
+        userPenaltyRewardBps: toIntegerNumber(config.userPenaltyRewardBps, "userPenaltyRewardBps"),
+        initialPenaltyBps: toIntegerNumber(config.initialPenaltyBps, "initialPenaltyBps"),
+        duration: toIntegerNumber(config.auctionDuration, "duration"),
+        gracePeriod: toIntegerNumber(config.auctionGracePeriod, "gracePeriod"),
+        penaltyPeriod: toIntegerNumber(config.auctionPenaltySlots, "penaltyPeriod"),
+        minOfferDeltaBps: toIntegerNumber(config.minOfferDeltaBps, "minOfferDeltaBps"),
+        securityDepositBase: uint64ToBN(BigInt(config.securityDepositBase)),
+        securityDepositBps: toIntegerNumber(config.securityDepositBps, "securityDepositBps"),
+    }
     const initializeIx = await matchingEngine.initializeIx(
         {
             owner: signerPubkey,
-            ownerAssistant: signerPubkey,
-            feeRecipient: signerPubkey,
+            ownerAssistant: new PublicKey(config.ownerAssistant),
+            feeRecipient: new PublicKey(config.feeRecipient),
         },
-        AUCTION_PARAMS,
+        auctionParams
     );
 
     const splToken = await import("@solana/spl-token");
@@ -72,3 +70,10 @@ async function initialize(matchingEngine: MatchingEngineProgram, signer: SolanaL
     log(`InitializeTxid ${initializeTxid}`);
 }
 
+function toIntegerNumber(text: string, name: string): number {
+    const res = Number(text);
+    if (!Number.isSafeInteger(res)) {
+        throw new Error(`${name} is not a safe integer. Received ${text}`)
+    }
+    return res;
+}