@aastar/admin 0.16.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AAStar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/ProtocolGovernance.d.ts

@@ -0,0 +1,57 @@
+import { type Address, type Hash, type Hex } from 'viem';
+import { BaseClient, type ClientConfig, type TransactionOptions } from '@aastar/core';
+export interface ProtocolParams {
+    minStake: bigint;
+    treasury: Address;
+    entryPoint: Address;
+    superPaymaster: Address;
+}
+/**
+ * ProtocolGovernance - L3 Pattern
+ *
+ * Responsibilities:
+ * 1. Global Protocol Parameter Management (Registry, EntryPoint)
+ * 2. High-level Governance Operations (DAO Transfer, Upgrades)
+ * 3. SuperPaymaster & Module Approval
+ */
+export declare class ProtocolGovernance extends BaseClient {
+    registryAddress: Address;
+    entryPointAddress: Address;
+    constructor(config: ClientConfig & {
+        registryAddress: Address;
+        entryPointAddress: Address;
+    });
+    /**
+     * Update the Global Treasury Address where protocol fees are collected
+     */
+    setTreasury(treasury: Address, options?: TransactionOptions): Promise<Hash>;
+    /**
+     * Update the supported EntryPoint address
+     */
+    updateEntryPoint(entryPoint: Address, options?: TransactionOptions): Promise<Hash>;
+    /**
+     * Approve a new SuperPaymaster contract address
+     */
+    setSuperPaymaster(paymaster: Address, options?: TransactionOptions): Promise<Hash>;
+    /**
+     * Set the Staking contract address
+     */
+    setStaking(staking: Address, options?: TransactionOptions): Promise<Hash>;
+    /**
+     * Configure a Role's parameters (Admin only)
+     * e.g. Setting minStake for ROLE_PAYMASTER_SUPER
+     */
+    configureRole(params: {
+        roleId: Hex;
+        minStake?: bigint;
+        entryBurn?: bigint;
+        exitFeePercent?: bigint;
+        minExitFee?: bigint;
+    }, options?: TransactionOptions): Promise<Hash>;
+    /**
+     * Transfer Protocol Ownership to a DAO (Multisig/Timelock)
+     * This is the final step of "Protocol Admin" lifecycle.
+     */
+    transferToDAO(daoAddress: Address, options?: TransactionOptions): Promise<Hash>;
+    getProtocolParams(): Promise<ProtocolParams>;
+}

package/dist/ProtocolGovernance.js

@@ -0,0 +1,118 @@
+import { BaseClient } from '@aastar/core';
+import { registryActions } from '@aastar/core'; // L2/L1 Actions
+/**
+ * ProtocolGovernance - L3 Pattern
+ *
+ * Responsibilities:
+ * 1. Global Protocol Parameter Management (Registry, EntryPoint)
+ * 2. High-level Governance Operations (DAO Transfer, Upgrades)
+ * 3. SuperPaymaster & Module Approval
+ */
+export class ProtocolGovernance extends BaseClient {
+    registryAddress;
+    entryPointAddress;
+    constructor(config) {
+        super(config);
+        this.registryAddress = config.registryAddress;
+        this.entryPointAddress = config.entryPointAddress;
+    }
+    // ===========================================
+    // 1. Global Parameter Management
+    // ===========================================
+    /**
+     * Update the Global Treasury Address where protocol fees are collected
+     */
+    async setTreasury(treasury, options) {
+        // Note: Registry might not have direct setTreasury if it relies on SuperPaymaster's config.
+        // Assuming Registry has ownership pointers or config pointers.
+        // If Logic resides in SuperPaymaster, we would use superPaymasterActions.
+        // Based on provided ABI/Actions, Registry manages Role Configs mainly.
+        // Let's assume we are updating a System Role or similar global config if available,
+        // OR adhering to what registryActions provides.
+        // Checking registryActions... it has 'transferOwnership' but maybe not direct 'setTreasury' depending on version.
+        // If strictly following ABI, we might need to update a specific Role Parameter (e.g. AOA/Super config).
+        throw new Error("Method not mapped to RegistryABI v1. Please verify contract capabilities.");
+    }
+    /**
+     * Update the supported EntryPoint address
+     */
+    async updateEntryPoint(entryPoint, options) {
+        // Placeholder: Real implementation depends on if Registry stores EntryPoint
+        // registryActions typically provides getters. Setters usually restricted to Owner.
+        // If action not available, throw standard error.
+        throw new Error("Method not mapped to RegistryABI v1.");
+    }
+    // ===========================================
+    // 2. Role & Module Governance
+    // ===========================================
+    /**
+     * Approve a new SuperPaymaster contract address
+     */
+    async setSuperPaymaster(paymaster, options) {
+        const registry = registryActions(this.registryAddress);
+        return await registry(this.client).setSuperPaymaster({
+            paymaster,
+            account: options?.account
+        });
+    }
+    /**
+     * Set the Staking contract address
+     */
+    async setStaking(staking, options) {
+        const registry = registryActions(this.registryAddress);
+        return await registry(this.client).setStaking({
+            staking,
+            account: options?.account
+        });
+    }
+    /**
+     * Configure a Role's parameters (Admin only)
+     * e.g. Setting minStake for ROLE_PAYMASTER_SUPER
+     */
+    async configureRole(params, options) {
+        const registry = registryActions(this.registryAddress);
+        // Use the admin shortcut if only updating financial params
+        if (params.minStake !== undefined || params.entryBurn !== undefined) {
+            return await registry(this.client).adminConfigureRole({
+                roleId: params.roleId,
+                minStake: params.minStake || 0n, // Careful: this might overwrite if API expects full set
+                entryBurn: params.entryBurn || 0n,
+                exitFeePercent: params.exitFeePercent || 0n,
+                minExitFee: params.minExitFee || 0n,
+                account: options?.account
+            });
+        }
+        throw new Error("Invalid parameters for configureRole");
+    }
+    // ===========================================
+    // 3. Transfer to DAO (Exit/Upgrade)
+    // ===========================================
+    /**
+     * Transfer Protocol Ownership to a DAO (Multisig/Timelock)
+     * This is the final step of "Protocol Admin" lifecycle.
+     */
+    async transferToDAO(daoAddress, options) {
+        const registry = registryActions(this.registryAddress);
+        return await registry(this.client).transferOwnership({
+            newOwner: daoAddress,
+            account: options?.account
+        });
+    }
+    // ===========================================
+    // 4. Query Capabilities
+    // ===========================================
+    async getProtocolParams() {
+        const registry = registryActions(this.registryAddress)(this.client); // Read-only via Client
+        // Parallel fetch
+        const [sp, staking] = await Promise.all([
+            registry.SUPER_PAYMASTER(),
+            registry.GTOKEN_STAKING()
+        ]);
+        return {
+            minStake: 0n, // Global default not directly exposed, usually per role
+            treasury: await registry.owner(), // Approximation for now
+            entryPoint: this.entryPointAddress,
+            superPaymaster: sp
+        };
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './ProtocolGovernance.js';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './ProtocolGovernance.js';

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@aastar/admin",
+  "version": "0.16.16",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "description": "Admin/Governance client for AAstar SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "aastar",
+    "admin",
+    "governance",
+    "web3"
+  ],
+  "author": "AAstar Team",
+  "license": "MIT",
+  "dependencies": {
+    "viem": "2.43.3",
+    "@aastar/core": "0.16.16"
+  },
+  "devDependencies": {
+    "typescript": "5.7.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  }
+}