hak-saucerswap-plugin 2.0.0 → 2.1.0

package/README.md

@@ -32,25 +32,49 @@ npm install hak-saucerswap-plugin
 ## Quick Start
 
 ```ts
-import { saucerswapPlugin } from "hak-saucerswap-plugin";
+import { saucerswapPlugin, SAUCERSWAP_MAINNET } from "hak-saucerswap-plugin";
 
 const agent = new HederaAgent({
   plugins: [saucerswapPlugin],
   config: {
     saucerswap: {
+      ...SAUCERSWAP_MAINNET,
       apiKey: process.env.SAUCERSWAP_API_KEY,
-      routerV2ContractId: "0.0.1414040",
-      wrappedHbarTokenId: "0.0.15058",
     },
   },
 });
 ```
 
+Or use the `network` shorthand and set `SAUCERSWAP_NETWORK=mainnet` in your environment — no
+contract addresses needed:
+
+```ts
+const agent = new HederaAgent({
+  plugins: [saucerswapPlugin],
+  config: {
+    saucerswap: { network: "mainnet", apiKey: process.env.SAUCERSWAP_API_KEY },
+  },
+});
+```
+
 The SaucerSwap API requires an `x-api-key` header. Get a key from
 [saucerswap.finance](https://www.saucerswap.finance) and supply it via either
 `SAUCERSWAP_API_KEY` in the environment or `config.saucerswap.apiKey`. See
 [`.env.example`](./.env.example) for a copy-paste template of all supported environment variables.
 
+## Network Defaults
+
+The plugin ships with official contract addresses for both networks. Import the constants
+directly or use the `network` shorthand — individual fields always take precedence if set.
+
+| Export               | Network | routerContractId | routerV2ContractId | wrappedHbarTokenId |
+|----------------------|---------|------------------|--------------------|-------------------|
+| `SAUCERSWAP_MAINNET` | mainnet | `0.0.3045981`    | `0.0.3949434`      | `0.0.1456986`     |
+| `SAUCERSWAP_TESTNET` | testnet | `0.0.19264`      | `0.0.1414040`      | `0.0.15058`       |
+
+Both constants also include `tokenAliases` for `SAUCE` and `XSAUCE`. Contract addresses sourced
+from the [official SaucerSwap deployment docs](https://docs.saucerswap.finance/developerx/contract-deployments).
+
 ## Development
 
 ```bash