@raac/rpc 1.2.0-beta.9 → 2.0.0-beta.0

package/dist/utils/contracts.js

@@ -48,13 +48,15 @@ const getContract = (chainId, contractName, provider) => {
     return new ethers_1.ethers.Contract(address, abi, provider);
 };
 exports.getContract = getContract;
+/** The zero address, used in the chain configs for a contract that is not deployed on that chain. */
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
 const getContractAddress = (chainId, contractName) => {
     const normalizedContractName = contractName.toLowerCase();
     const config = (0, exports.getConfig)(chainId);
     if (!config) {
         throw new Error(`Unsupported chain ID: ${chainId}`);
     }
-    const chainKeys = ["contracts", "governance", "assets", "pools", "nfts", "lockers", "zap", "gauges"];
+    const chainKeys = ["contracts", "governance", "assets", "pools", "nfts", "lockers", "zap"];
     const keys = Object.keys(config).filter((key) => chainKeys.includes(key));
     let address = null;
     for (const key of keys) {
@@ -69,6 +71,9 @@ const getContractAddress = (chainId, contractName) => {
             .join("\n");
         throw new Error(`Contract ${normalizedContractName} not found for chain ID: ${chainId}.\nHas:\n${hasIds}`);
     }
+    if (address.toLowerCase() === ZERO_ADDRESS) {
+        throw new Error(`Contract ${normalizedContractName} is not deployed on chain ${chainId}`);
+    }
     return address;
 };
 exports.getContractAddress = getContractAddress;

package/dist/wallet/assets/approveAsset.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+/**
+ * Approves `spender` to pull an asset from the signer.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config.
+ * @param spender The address to approve.
+ * @param amount The allowance in the token's base units. Pass `ethers.MaxUint256` for an unlimited approval.
+ * @param signer The token owner.
+ * @returns The transaction receipt.
+ */
 async function approveAsset(chainId, assetId, spender, amount, signer) {
     if (!signer) {
         throw new Error("Wallet not connected");
@@ -12,10 +21,7 @@ async function approveAsset(chainId, assetId, spender, amount, signer) {
         // @ts-ignore
         const abi = (0, artifacts_1.getABI)(assetId);
         const tokenContract = new ethers_1.ethers.Contract(tokenAddress, abi, signer);
-        const amountInWei = ethers_1.ethers.parseEther(amount);
-        // const { maxFeePerGas } = await estimateGasPrice(signer);
-        const tx = await tokenContract.approve(spender, amountInWei, {
-            // maxFeePerGas,
+        const tx = await tokenContract.approve(spender, amount, {
             nonce: await signer.getNonce(),
         });
         console.log(`Approval transaction sent for ${assetId}:`, tx.hash);

package/dist/wallet/assets/burnAsset.js

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+/**
+ * Burns an asset from the signer.
+ * @param chainId The chain id.
+ * @param assetId The asset id in the chain config.
+ * @param amount The amount to burn in the token's base units.
+ * @param signer The holder.
+ * @returns The transaction receipt.
+ */
 async function burnAsset(chainId, assetId, amount, signer) {
     try {
         if (!signer) {
@@ -20,11 +28,10 @@ async function burnAsset(chainId, assetId, amount, signer) {
         // @ts-ignore
         const abi = (0, artifacts_1.getABI)(assetId);
         const contract = new ethers_1.ethers.Contract(contractAddress, abi, signer);
-        const amountToBurn = ethers_1.ethers.parseEther(amount.toString());
         if (!contract.burn) {
             throw new Error(`Burn function not found on contract ${contractAddress}`);
         }
-        const tx = await contract.burn(amountToBurn, {
+        const tx = await contract.burn(amount, {
             nonce: +(await signer.getNonce()),
         });
         console.log(`Burning transaction sent for ${assetId}:`, tx.hash);

package/dist/wallet/assets/getAllowance.js

@@ -2,11 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
+const amount_1 = require("../../utils/amount");
+/**
+ * Reads how much of an asset `spender` may pull from `owner`.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config, or `"eth"` for native ETH.
+ * @param owner The token owner.
+ * @param spender The approved spender.
+ * @param provider The provider to read with.
+ * @returns The allowance in base units with the asset's decimals. Native ETH has no allowance, so it returns `ethers.MaxUint256` with 18 decimals.
+ * @throws If the read fails.
+ */
 async function getAllowance(chainId, assetId, owner, spender, provider) {
     try {
         if (assetId === "eth") {
-            // ETH doesn't have an allowance concept, return max uint256 value ?
-            return ethers_1.ethers.MaxUint256;
+            return (0, amount_1.toAmount)(ethers_1.ethers.MaxUint256, amount_1.WAD_DECIMALS, "ETH");
         }
         const ALLOWANCE_ABI = [
             "function allowance(address,address) view returns (uint256)",
@@ -14,13 +24,12 @@ async function getAllowance(chainId, assetId, owner, spender, provider) {
         const contractAddress = (0, contracts_1.getContractAddress)(chainId, assetId);
         const contract = new ethers_1.ethers.Contract(contractAddress, ALLOWANCE_ABI, provider);
         const allowance = await contract.allowance(owner, spender);
-        return allowance;
+        return (0, amount_1.toTokenAmount)(chainId, assetId, allowance);
     }
     catch (error) {
         console.error(`Error getting allowance for asset ${assetId}:`, error);
         console.log({ assetId, owner, spender });
-        console.log(error);
-        return 0n;
+        throw error;
     }
 }
 exports.default = getAllowance;

package/dist/wallet/assets/getAsset.js

@@ -1,22 +1,29 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const contracts_1 = require("../../utils/contracts");
+const getBalance_1 = __importDefault(require("./getBalance"));
+/**
+ * Reads a configured asset's config entry together with a wallet's balance of it.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config.
+ * @param address The wallet address.
+ * @param provider The provider to read with.
+ * @returns The asset's config entry plus `balance`, the wallet balance as a `TokenAmount`.
+ * @throws If the balance read fails.
+ */
 async function getAsset(chainId, assetId, address, provider) {
     const { assets } = (0, contracts_1.getConfig)(chainId);
-    // @ts-ignore
     const asset = assets[assetId];
-    let response = {
-        ...asset,
-        balance: 0,
-    };
-    const owner = address;
     try {
-        const balance = await this.getBalance(chainId, assetId, owner, provider);
-        response.balance = balance;
+        const balance = await (0, getBalance_1.default)(chainId, assetId, address, provider);
+        return { ...asset, balance };
     }
     catch (error) {
         console.log(`Error getting balance: ${error}`);
+        throw error;
     }
-    return response;
 }
 exports.default = getAsset;

package/dist/wallet/assets/getAssets.js

@@ -1,26 +1,27 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const contracts_1 = require("../../utils/contracts");
+const getAsset_1 = __importDefault(require("./getAsset"));
+const _helpers_1 = require("../../assets/_helpers");
+/**
+ * Reads every configured asset with a wallet's balance of it.
+ * @param chainId The chain id.
+ * @param address The wallet address.
+ * @param provider The provider to read with.
+ * @returns A map of asset id to the asset's config entry plus `balance` as a `TokenAmount`. Assets the chain config does not have a deployment for are left out.
+ */
 async function getAssets(chainId, address, provider) {
     const { assets } = (0, contracts_1.getConfig)(chainId);
-    const responses = {};
-    const assetIds = Object.keys(assets);
-    const assetPromises = assetIds.map(async (assetId) => {
-        // @ts-ignore
-        const asset = await this.getAsset(chainId, assetId, address, signer);
-        responses[assetId] = {
-            // @ts-ignore
-            ...assets[assetId],
-            ...asset,
-        };
-        return responses[assetId];
-    });
-    const assetResponses = await Promise.all(assetPromises);
+    const assetResponses = await Promise.all(Object.keys(assets)
+        .filter((assetId) => (0, _helpers_1.isAssetDeployed)(chainId, assetId))
+        .map((assetId) => (0, getAsset_1.default)(chainId, assetId, address, provider)));
     const response = {};
-    assetResponses.forEach((asset) => {
-        // @ts-ignore
+    for (const asset of assetResponses) {
         response[asset.id] = asset;
-    });
+    }
     return response;
 }
 exports.default = getAssets;

package/dist/wallet/assets/getBalance.js

@@ -2,37 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("../../assets/_helpers");
+/**
+ * Reads a wallet's balance of a configured asset or native ETH.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config, or `"eth"` for native ETH.
+ * @param address The wallet address.
+ * @param provider The provider to read with.
+ * @returns The balance in base units with decimals and symbol from the token registry (`"ETH"` and 18 for native ETH).
+ * @throws If the asset is not deployed on the chain, or the read fails.
+ */
 async function getBalance(chainId, assetId, address, provider) {
-    const BALANCE_OF_ABI = ["function balanceOf(address) view returns (uint256)", "function symbol() view returns (string)", "function decimals() view returns (uint8)"];
+    const BALANCE_OF_ABI = ["function balanceOf(address) view returns (uint256)"];
     try {
         if (assetId === "eth") {
             const balance = await provider.getBalance(address);
-            const parsedBalance = (ethers_1.ethers.formatEther(balance));
-            return {
-                balance: parsedBalance,
-                symbol: "ETH",
-                decimals: 18,
-            };
+            return (0, amount_1.toAmount)(balance, amount_1.WAD_DECIMALS, "ETH");
         }
+        (0, _helpers_1.assertAssetDeployed)(chainId, assetId);
         const contractAddress = (0, contracts_1.getContractAddress)(chainId, assetId);
         const contract = new ethers_1.ethers.Contract(contractAddress, BALANCE_OF_ABI, provider);
         const balance = await contract.balanceOf(address);
-        const symbol = (await contract.symbol())?.toString() || "";
-        const decimals = parseInt(await contract.decimals()) || 0;
-        const parsedBalance = ethers_1.ethers.formatUnits(balance, decimals);
-        return {
-            balance: parsedBalance,
-            symbol: symbol,
-            decimals,
-        };
+        return (0, amount_1.toTokenAmount)(chainId, assetId, balance);
     }
     catch (error) {
         console.error(`Error getting balance for asset ${assetId}:`, error);
-        return {
-            balance: "0",
-            symbol: "",
-            decimals: 0,
-        };
+        throw error;
     }
 }
 exports.default = getBalance;

package/dist/wallet/assets/mintAsset.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+/**
+ * Mints an asset to `address`.
+ * @param chainId The chain id.
+ * @param assetId The asset id in the chain config.
+ * @param amount The amount to mint in the token's base units.
+ * @param address The recipient.
+ * @param signer The minter.
+ * @returns The transaction receipt.
+ */
 async function mintAsset(chainId, assetId, amount, address, signer) {
     try {
         if (!signer) {
@@ -25,7 +34,7 @@ async function mintAsset(chainId, assetId, amount, address, signer) {
         if (!contract.mint) {
             throw new Error(`Mint function not found on contract ${contractAddress}`);
         }
-        const tx = await contract.mint(address, ethers_1.ethers.parseEther(amount.toString()), {
+        const tx = await contract.mint(address, amount, {
             // maxFeePerGas,
             nonce: +(await signer.getNonce()),
         });

package/dist/wallet/assets/transferAsset.js

@@ -3,17 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+/**
+ * Transfers an asset or native ETH from the signer.
+ * @param chainId The chain id.
+ * @param assetId The asset id in the chain config, or `"eth"` for native ETH.
+ * @param amount The amount in the token's base units (wei for ETH).
+ * @param fromAddress The sender, used for logging.
+ * @param toAddress The recipient.
+ * @param signer The sender.
+ * @returns The transaction receipt.
+ */
 async function transferAsset(chainId, assetId, amount, fromAddress, toAddress, signer) {
     try {
         if (!signer) {
             throw new Error("Wallet not connected");
         }
-        const amountToTransfer = ethers_1.ethers.parseEther(amount.toString());
         if (assetId.toLowerCase() === "eth") {
             // Handle ETH transfer
             const tx = await signer.sendTransaction({
                 to: toAddress,
-                value: amountToTransfer,
+                value: amount,
                 nonce: await signer.getNonce(),
             });
             console.log(`ETH transfer transaction sent:`, tx.hash);
@@ -38,7 +47,7 @@ async function transferAsset(chainId, assetId, amount, fromAddress, toAddress, s
             if (!contract.transfer) {
                 throw new Error(`Transfer function not found on contract ${contractAddress}`);
             }
-            const tx = await contract.transfer(toAddress, amountToTransfer, {
+            const tx = await contract.transfer(toAddress, amount, {
                 nonce: await signer.getNonce(),
             });
             console.log(`Transfer transaction sent for ${assetId}:`, tx.hash);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raac/rpc",
-	"version": "1.2.0-beta.9",
+	"version": "2.0.0-beta.0",
 	"description": "RPC Library for RAAC",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",
@@ -9,7 +9,7 @@
 	],
 	"scripts": {
 		"dev": "ts-node-dev --transpile-only --env-file=.env scripts/index.ts",
-		"build": "npm run generate:errors && tsc && cp -r typechain-types dist/types",
+		"build": "npm run generate:errors && tsc && cp -r typechain-types dist/types && cp -r generated dist/generated",
 		"build:watch": "tsc --watch",
 		"test": "echo \"Error: no test specified\" && exit 1",
 		"sync": "bash setup.sh",

package/dist/contracts/governance/distributor/getStartEpoch.js

@@ -1,28 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStartEpoch = void 0;
-const ethers_1 = require("ethers");
-const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
-const artifacts_1 = require("../../../utils/artifacts");
-/**
- * Gets the distributor's start epoch timestamp.
- *
- * @param chainId - The chain/network to use.
- * @param provider - Optional ethers.js Provider instance.
- * @returns Start epoch (bigint).
- */
-const getStartEpoch = async (chainId, provider) => {
-    if (!provider) {
-        const rpc = chains_1.default[chainId].rpcs[0];
-        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
-    }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
-    return contract.startEpoch();
-};
-exports.getStartEpoch = getStartEpoch;

package/dist/contracts/governance/distributor/withdrawUnallocatedRewards.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withdrawUnallocatedRewards = void 0;
-const ethers_1 = require("ethers");
-const getContractAddress_1 = require("../../getContractAddress");
-const artifacts_1 = require("../../../utils/artifacts");
-/**
- * Withdraws unallocated rewards to a recipient.
- * Requires DEFAULT_ADMIN_ROLE.
- *
- * @param chainId - The chain/network to use.
- * @param recipient - Address to receive the withdrawn rewards.
- * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
- */
-const withdrawUnallocatedRewards = async (chainId, recipient, signer) => {
-    if (!signer)
-        throw new Error("Signer is required");
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, signer);
-    const tx = await contract.withdrawUnallocatedRewards(recipient);
-    await tx.wait();
-    return tx;
-};
-exports.withdrawUnallocatedRewards = withdrawUnallocatedRewards;

package/dist/contracts/governance/gauge/setDistributorApproval.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setDistributorApproval = void 0;
-const ethers_1 = require("ethers");
-const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
-/**
- * Sets the approval flag for a distributor on the gauge (requires GAUGE_ADMIN).
- * @param chainId - The chain/network to use.
- * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
- * @param distributor - Address of the distributor.
- * @param isApproved - Whether the distributor should be approved.
- * @param signer - An ethers.js Signer instance (required).
- */
-const setDistributorApproval = async (chainId, gaugeAddressOrId, distributor, isApproved, signer) => {
-    if (!signer)
-        throw new Error("Signer is required");
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
-    const abi = (0, artifacts_1.getABI)("basegauge");
-    const contract = new ethers_1.ethers.Contract(gaugeAddress, abi, signer);
-    const tx = await contract.setDistributorApproval(distributor, isApproved);
-    await tx.wait();
-    return tx;
-};
-exports.setDistributorApproval = setDistributorApproval;

package/dist/types/contracts/governance/distributor/getStartEpoch.d.ts

@@ -1,10 +0,0 @@
-import { Provider } from "ethers";
-import { ChainId } from "../../../configs/chains";
-/**
- * Gets the distributor's start epoch timestamp.
- *
- * @param chainId - The chain/network to use.
- * @param provider - Optional ethers.js Provider instance.
- * @returns Start epoch (bigint).
- */
-export declare const getStartEpoch: (chainId: ChainId, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/withdrawUnallocatedRewards.d.ts

@@ -1,12 +0,0 @@
-import { Signer } from "ethers";
-import { ChainId } from "../../../configs/chains";
-/**
- * Withdraws unallocated rewards to a recipient.
- * Requires DEFAULT_ADMIN_ROLE.
- *
- * @param chainId - The chain/network to use.
- * @param recipient - Address to receive the withdrawn rewards.
- * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
- */
-export declare const withdrawUnallocatedRewards: (chainId: ChainId, recipient: string, signer: Signer) => Promise<any>;

package/dist/types/contracts/governance/gauge/setDistributorApproval.d.ts

@@ -1,11 +0,0 @@
-import { Signer } from "ethers";
-import { ChainId } from "../../../configs/chains";
-/**
- * Sets the approval flag for a distributor on the gauge (requires GAUGE_ADMIN).
- * @param chainId - The chain/network to use.
- * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
- * @param distributor - Address of the distributor.
- * @param isApproved - Whether the distributor should be approved.
- * @param signer - An ethers.js Signer instance (required).
- */
-export declare const setDistributorApproval: (chainId: ChainId, gaugeAddressOrId: string, distributor: string, isApproved: boolean, signer: Signer) => Promise<any>;

package/dist/types/contracts/governance/proposals/getProposalData.d.ts

@@ -1,18 +0,0 @@
-import { Provider } from "ethers";
-import { ChainId } from "../../../configs/chains";
-export interface ProposalData {
-    targets: string[];
-    values: string[];
-    calldatas: string[];
-    description: string;
-}
-/**
- * Gets proposal transaction data.
- * Returns arrays of targets, values, and calldata.
- *
- * @param chainId - The chain/network to use.
- * @param proposalId - The ID of the proposal.
- * @param provider - Optional ethers.js Provider instance.
- * @returns Proposal data including targets, values, calldatas, and description.
- */
-export declare const getProposalData: (chainId: ChainId, proposalId: number | bigint, provider?: Provider) => Promise<ProposalData>;

package/dist/types/contracts/tokens/veRAAC/getEffectiveLockEnd.d.ts

@@ -1,11 +0,0 @@
-import { Provider } from "ethers";
-import { ChainId } from "../../../configs/chains";
-/**
- * Gets the weighted average lock end time for a user.
- *
- * @param chainId - The chain/network to use.
- * @param address - The address to query.
- * @param provider - Optional ethers.js Provider instance.
- * @returns The effective lock end timestamp.
- */
-export declare const getEffectiveLockEnd: (chainId: ChainId, address: string, provider?: Provider) => Promise<number>;