@vetro-protocol/gateway 1.0.0-beta → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @vetro-protocol/gateway
 
-Vetro Protocol gateway actions for viem. Wraps the VUSD and vetBTC gateways with `deposit` / `redeem` / `requestRedeem` / `cancelRedeemRequest` flows, ERC20 approval included.
+Vetro Protocol gateway actions for viem clients. Mints pegged tokens (VUSD, vetBTC) from whitelisted underlying assets and handles redemptions back out.
 
 ## Installation
 
@@ -8,49 +8,42 @@ Vetro Protocol gateway actions for viem. Wraps the VUSD and vetBTC gateways with
 pnpm add @vetro-protocol/gateway viem viem-erc20
 ```
 
-## Gateway addresses
+## Overview
 
-The package exports the canonical gateway addresses and their peg-base metadata:
-
-```ts
-import { gatewayAddresses, gateways } from "@vetro-protocol/gateway";
-
-// gateways is an array of { address, pegBaseSymbol } entries:
-//   { address: "0xDaD5…16F", pegBaseSymbol: "USD" }   // VUSD
-//   { address: "0xCBA2…faB", pegBaseSymbol: "BTC" }   // vetBTC
-```
-
-Pass the address you want directly as `gatewayAddress` to any wallet action.
+- Two gateways ship by default — the VUSD gateway and the vetBTC gateway — exported as `gateways` (with `address` + `pegBaseSymbol`) and `gatewayAddresses` (just the addresses).
+- `deposit` mints the pegged token: checks `previewDeposit` for the expected output, runs an allowance + approval if needed, then calls `deposit(tokenIn, amountIn, minPeggedTokenOut, receiver)`.
+- Redemptions follow the gateway's two-step flow: `requestRedeem` opens a request, `redeem` finalises it once the optional withdrawal delay has elapsed (or immediately if the caller is on the instant-redeem whitelist), and `cancelRedeemRequest` aborts an open request.
+- Read actions cover everything a UI needs to drive these flows: previews, fee getters, request lookup, treasury / pegged-token addresses, and withdrawal-delay configuration.
 
 ## Usage
 
 ```ts
-import { deposit, getMintFee } from "@vetro-protocol/gateway/actions";
-import { gateways } from "@vetro-protocol/gateway";
+import { deposit, gateways, previewDeposit } from "@vetro-protocol/gateway";
 import { createPublicClient, createWalletClient, custom, http } from "viem";
-import { mainnet } from "viem/chains";
+import { hemi } from "viem/chains";
 
-const publicClient = createPublicClient({ chain: mainnet, transport: http() });
+const publicClient = createPublicClient({ chain: hemi, transport: http() });
 const walletClient = createWalletClient({
-  chain: mainnet,
+  chain: hemi,
   transport: custom(window.ethereum),
 });
 
-const vusdGateway = gateways.find((g) => g.pegBaseSymbol === "USD")!.address;
+const vusdGateway = gateways[0]; // VUSD gateway
 
-// Quote the protocol fee for a given deposit
-const fee = await getMintFee(publicClient, {
-  address: vusdGateway,
-  amountIn: 1_000_000n,
+// 1. Quote how much VUSD a USDT deposit would mint.
+const expectedOut = await previewDeposit(publicClient, {
+  address: vusdGateway.address,
+  amountIn: 1_000_000n, // 1 USDT (6 decimals)
+  tokenIn: "0x...", // USDT address
 });
 
-// Deposit collateral, mint the pegged token (approval handled automatically)
+// 2. Deposit (approval handled automatically).
 const { emitter, promise } = deposit(walletClient, {
   amountIn: 1_000_000n,
-  gatewayAddress: vusdGateway,
-  minPeggedTokenOut: 950_000n,
+  gatewayAddress: vusdGateway.address,
+  minPeggedTokenOut: expectedOut,
   receiver: "0x...",
-  tokenIn: "0x...", // e.g. USDC
+  tokenIn: "0x...",
 });
 
 emitter.on("user-signed-deposit", (hash) => console.log("tx hash:", hash));
@@ -61,46 +54,22 @@ emitter.on("deposit-transaction-succeeded", (receipt) =>
 await promise;
 ```
 
-The same actions are available via `.extend()` factories (`gatewayPublicActions()`, `gatewayWalletActions()`) for callers who prefer viem's extension pattern.
-
-## Redeem model
-
-Redeeming the pegged token back to collateral has two modes:
-
-- **Instant** — if the account is on the instant-redeem whitelist (or withdrawal delay is disabled), `redeem` settles in one transaction.
-- **Delayed** — otherwise, call `requestRedeem` to open a request, wait for the configured `withdrawalDelay`, then `redeem` claims the collateral. `cancelRedeemRequest` cancels a pending request.
-
-Use the public actions to inspect state: `getMintFee`, `getRedeemFee`, `previewDeposit`, `previewRedeem`, `getMaxWithdraw`, `getPeggedToken`, `getTreasury`, `getWithdrawalDelay`, `getWithdrawalDelayEnabled`, `isInstantRedeemWhitelisted`, `getRedeemRequest`.
-
-## Events
-
-Every wallet action returns `{ emitter, promise }` (via `to-promise-event`). The emitter fires a granular lifecycle:
-
-- `pre-approve` → `user-signed-approval` → `approve-transaction-succeeded` / `approve-transaction-reverted` (only when an ERC20 approval is needed)
-- `pre-<action>` → `user-signed-<action>` → `<action>-transaction-succeeded` / `<action>-transaction-reverted`
-- `user-signing-<action>-error` if the user rejects in the wallet
-- `<action>-failed-validation` if input validation fails (payload is a human-readable reason)
-- `unexpected-error` for anything that escapes
-- `<action>-settled` always emitted in the `finally` block
-
-Event-map types are exported per action: `DepositEvents`, `RedeemEvents`, `RequestRedeemEvents`, `CancelRedeemRequestEvents`.
+The same actions are also available via `.extend()` factories (`gatewayPublicActions()`, `gatewayWalletActions()`) for callers who prefer viem's extension pattern.
 
 ## API
 
-Public actions (take a `Client`):
-
-- `getMaxWithdraw`, `getMintFee`, `getPeggedToken`, `getRedeemFee`, `getRedeemRequest`, `getTreasury`, `getWithdrawalDelay`, `getWithdrawalDelayEnabled`, `isInstantRedeemWhitelisted`, `previewDeposit`, `previewRedeem`
-
-Wallet actions (take a `WalletClient`, return `{ emitter, promise }`):
-
-- `deposit`, `redeem`, `requestRedeem`, `cancelRedeemRequest`
-
-Encoders (return ABI-encoded calldata):
-
-- `encodeDeposit`, `encodeRedeem`, `encodeRequestRedeem`, `encodeCancelRedeemRequest`
-
-Extension factories:
-
-- `gatewayPublicActions()`, `gatewayWalletActions()`
-
-Also exported: `gatewayAbi`, `gatewayAddresses`, `gateways`, and the `Gateway` type.
+- Public actions (reads):
+  - `previewDeposit(client, params)` — expected pegged-token output for a deposit.
+  - `previewRedeem(client, params)` — expected underlying output for a redeem.
+  - `getMintFee(client, params)` / `getRedeemFee(client, params)` — current fees.
+  - `getMaxWithdraw(client, params)` — maximum withdrawable amount.
+  - `getPeggedToken(client, params)` — pegged-token address minted by the gateway.
+  - `getTreasury(client, params)` — treasury address backing the gateway.
+  - `getRedeemRequest(client, params)` — details for a specific redeem request.
+  - `getWithdrawalDelay(client, params)` / `getWithdrawalDelayEnabled(client, params)` — delay configuration.
+  - `isInstantRedeemWhitelisted(client, params)` — whether an account can bypass the delay.
+- Wallet actions (writes): `deposit`, `requestRedeem`, `redeem`, `cancelRedeemRequest`. Each returns `{ emitter, promise }`.
+- `gatewayPublicActions()` / `gatewayWalletActions()` — viem extension factories that wire the same actions onto a client via `.extend()`.
+- `gatewayAbi` — the minimal ABI subset used by the package.
+- Constants: `gateways`, `gatewayAddresses`.
+- Types: `Gateway`, `CancelRedeemRequestEvents`, `DepositEvents`, `RedeemEvents`, `RequestRedeemEvents`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vetro-protocol/gateway",
-  "version": "1.0.0-beta",
+  "version": "1.0.0",
   "description": "Vetro Protocol gateway actions for viem.",
   "license": "MIT",
   "files": [
@@ -10,6 +10,11 @@
     "_types",
     "src"
   ],
+  "repository": {
+    "directory": "packages/gateway",
+    "type": "git",
+    "url": "git+https://github.com/vetro-protocol/vetro-monorepo.git"
+  },
   "dependencies": {
     "to-promise-event": "1.0.0",
     "viem-erc20": "2.1.0"
@@ -31,7 +36,7 @@
   "private": false,
   "publishConfig": {
     "access": "public",
-    "provenance": false
+    "provenance": true
   },
   "type": "module",
   "exports": {