@fileverse-dev/formulajs 4.4.41 → 4.4.42-yield-a

package/lib/cjs/index.cjs

@@ -18011,7 +18011,7 @@ function toTimestamp(dateStr) {
 
 async function EOA() {
   try {
-    const [addresses, category, chains, startTime, endTime, page = 1, offset = 10, columnName = null] =
+    const [addresses, category, chains, startTime, endTime, page = 1, offset = 10, columnName] =
       argsToArray(arguments);
     validateParams(eoaParamsSchema, { addresses, category, chains, startTime, endTime, page, offset, columnName });
 
@@ -18352,7 +18352,7 @@ const coingeckoParamsSchema = discriminatedUnionType('category', [
 
 async function COINGECKO() {
   try {
-    const [category, param1, param2, columnName = null] = argsToArray(arguments);
+    const [category, param1, param2, columnName] = argsToArray(arguments);
     validateParams(coingeckoParamsSchema, { category, param1, param2, columnName });
 
     const apiKey = window.localStorage.getItem(SERVICES_API_KEY.Coingecko);
@@ -18446,7 +18446,7 @@ const CATEGORY_URLS = {
 
 async function DEFILLAMA() {
   try {
-    const [category, columnName = null] = argsToArray(arguments);
+    const [category, columnName] = argsToArray(arguments);
     validateParams(defillamaParamsSchema, { category, columnName });
     const url = CATEGORY_URLS[category];
     if (!url) throw new ValidationError(`Invalid category: ${category}`)
@@ -18470,6 +18470,7 @@ async function DEFILLAMA() {
     const filterColumnName = columnName?.split(',').map(s => s.trim());
 
     return (Array.isArray(json) ? json : [json]).map(item => {
+       if (!filterColumnName) return item
       const out = {};
       for (const [k, v] of Object.entries(item)) {
         if ((columnName && filterColumnName.includes(k)) && (v === null || typeof v !== 'object')) out[k] = v;
@@ -18512,7 +18513,7 @@ const etherscanParamsSchema = discriminatedUnionType('type', [gasSchema, txnSche
 
 async function ETHERSCAN() {
   try {
-    const [type, chain, address, startDate, endDate, page = 1, limit = 10, columnName = null] =
+    const [type, chain, address, startDate, endDate, page = 1, limit = 10, columnName] =
       argsToArray(arguments);
 
 
@@ -19487,17 +19488,18 @@ async function WALLET() {
 // WALLET("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "ethereum", "balance").then(console.log)
 
 const yieldParamsSchema = objectType({
-  category: enumType(['all', 'stablecoins'])
+  category: enumType(['all', 'stablecoins']),
+  columnName: stringType().optional(),
 });
 
 async function YIELD () {
 
     try {
-            const [category] = argsToArray(arguments);
+            const [category, columnName] = argsToArray(arguments);
         
-            validateParams(yieldParamsSchema, { category });
+            validateParams(yieldParamsSchema, { category, columnName });
         
-            const response = await DEFILLAMA('yields');
+            const response = await DEFILLAMA('yields', columnName);
         
             if(response.functionName){
                 response.functionName = 'YIELD';

package/lib/esm/crypto-constants.mjs

@@ -244,7 +244,16 @@ var EOA_metadata = {
       require: "o",
       type: "string"
     }
-  ]
+  ],
+  examples: [{
+    title: "EOA",
+    argumentString: '"vitalik.eth", "txns", "ethereum", "01/01/2023", "01/05/2024", 1, 2',
+    description: "returns the transaction history for the address vitalik.eth on the Ethereum blockchain between January 1, 2023 and January 5, 2024, returning page 1 with 2 transactions per page."
+  }, {
+    title: "EOA",
+    argumentString: '"vitalik.eth", "balance", "gnosis"',
+    description: "returns the balance for the address vitalik.eth on the Gnosis blockchain."
+  }]
 };
 
 // src/crypto/uniswap/metadata.js
@@ -285,6 +294,18 @@ var UNISWAP_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "UNISWAP",
+      argumentString: '"v3", "tokens", "eth"',
+      description: "returns data for the ETH token from Uniswap V3."
+    },
+    {
+      title: "UNISWAP",
+      argumentString: '"v3-raw", "markets", "0x8ad599c3a0ff1de082011efddc58f1908eb6e6d8"',
+      description: "returns data for the Uniswap V3 market with the specified contract address."
+    }
   ]
 };
 
@@ -327,6 +348,18 @@ If "derivatives": exchange name (e.g., "binance_futures", "hyperliquid", "weex-f
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "COINGECKO",
+      argumentString: '"stablecoins", "yield-bearing-stablecoins", "1h,24h,7d"',
+      description: "returns the yield-bearing stablecoins with percentage changes over 1 hour, 24 hours, and 7 days."
+    },
+    {
+      title: "COINGECKO",
+      argumentString: '"derivatives", "binance_futures"',
+      description: "returns the derivatives data from the Binance Futures exchange."
+    }
   ]
 };
 
@@ -338,7 +371,7 @@ var DEFILLAMA_metadata = {
   BRAND_SECONDARY_COLOR: "#855dcd",
   n: "DEFILLAMA",
   t: 20,
-  d: "Fetches content from Defillama.",
+  d: "returns content from Defillama.",
   a: "Retrieves data from Defillama.",
   p: [
     {
@@ -355,7 +388,16 @@ var DEFILLAMA_metadata = {
       require: "o",
       type: "string"
     }
-  ]
+  ],
+  examples: [{
+    title: "DEFILLAMA",
+    argumentString: '"protocols"',
+    description: "returns a list of DeFi protocols from Defillama."
+  }, {
+    title: "DEFILLAMA",
+    argumentString: '"dex"',
+    description: "returns decentralized exchange (DEX) data from Defillama."
+  }]
 };
 
 // src/crypto/base/metadata.js
@@ -418,6 +460,18 @@ var BASE_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "BASE",
+      argumentString: '"token-txns", "0x7FD624f3f97A7dd36195E8379F28dB6147C270ff", "01/01/2024", "07/07/2024", 1, 2',
+      description: "returns list ofERC-20 token transfer history for the specified address on the Base network between January 1, 2024 and July 7, 2024, returning page 1 with 2 results per page."
+    },
+    {
+      title: "BASE",
+      argumentString: '"gas"',
+      description: "returns gas price metrics for the Base network."
+    }
   ]
 };
 
@@ -474,7 +528,16 @@ var GNOSIS_metadata = {
       require: "o",
       type: "number"
     }
-  ]
+  ],
+  examples: [{
+    title: "GNOSIS",
+    argumentString: '"nft-txns", "0x90830Ed558f12D826370DC52E9D87947A7F18De9", "01/01/2024", "14/06/2025", 1, 50',
+    description: "returns NFT transaction history for the address 0x90830Ed558f12D826370DC52E9D87947A7F18De9 on the Gnosis Chain between January 1, 2024 and June 14, 2025, returning page 1 with 50 transactions per page."
+  }, {
+    title: "GNOSIS",
+    argumentString: '"gas"',
+    description: "returns current gas price metrics for the Gnosis Chain."
+  }]
 };
 
 // src/crypto/etherscan/metadata.js
@@ -530,6 +593,18 @@ var ETHERSCAN_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "ETHERSCAN",
+      argumentString: '"all-txns", "ethereum", "vitalik.eth"',
+      description: "returns the complete transaction history for the address vitalik.eth on the Ethereum blockchain."
+    },
+    {
+      title: "ETHERSCAN",
+      argumentString: '"token-txns", "gnosis", "vitalik.eth", "01/01/2024", "01/05/2024"',
+      description: "returns the token transaction history for the address vitalik.eth on the Gnosis blockchain between January 1, 2024 and January 5, 2024."
+    }
   ]
 };
 
@@ -556,7 +631,16 @@ var PNL_metadata = {
       repeat: "n",
       type: "range"
     }
-  ]
+  ],
+  examples: [{
+    title: "PNL",
+    argumentString: "A1:A10, B1:B10",
+    description: "returns the total profit or loss by subtracting the costs in range A1:A10 from the revenues in range B1:B10."
+  }, {
+    title: "PNL",
+    argumentString: '"{100, 200, 150}", "{250, 300, 200}"',
+    description: "returns the total profit or loss by subtracting the costs {100, 200, 150} from the revenues {250, 300, 200}."
+  }]
 };
 
 // src/crypto/safe/metadata.js
@@ -602,7 +686,16 @@ var SAFE_metadata = {
       require: "o",
       repeat: "n"
     }
-  ]
+  ],
+  examples: [{
+    title: "SAFE",
+    argumentString: '"0xe9A6378d8FD4983C2999DB0735f258397E8C2253", "txns", "gnosis", 10, 0',
+    description: "returns the last 10 transactions for the specified Safe address on the Gnosis chain."
+  }, {
+    title: "SAFE",
+    argumentString: '"0x1234567890abcdef1234567890abcdef12345678", "txns", "ethereum"',
+    description: "returns the last 100 transactions for the specified Safe address on the Ethereum chain."
+  }]
 };
 
 // src/crypto/blockscout/metadata.js
@@ -666,7 +759,16 @@ var BLOCKSCOUT_metadata = {
       repeat: "n",
       type: "rangenumber"
     }
-  ]
+  ],
+  examples: [{
+    title: "BLOCKSCOUT",
+    argumentString: '"vitalik.eth", "txns", "ethereum", "01/01/2023", "01/05/2024", 1, 2',
+    description: "returns transaction history for the address vitalik.eth on the Ethereum blockchain between January 1, 2023 and January 5, 2024, returning page 1 with 2 transactions per page."
+  }, {
+    title: "BLOCKSCOUT",
+    argumentString: '"vitalik.eth", "balance", "gnosis"',
+    description: "returns the balance for the address vitalik.eth on the Gnosis blockchain."
+  }]
 };
 
 // src/crypto/aave/metadata.js
@@ -707,6 +809,18 @@ var AAVE_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "AAVE",
+      argumentString: '"v2", "tokens", "USDT"',
+      description: "returns list data for the USDT token from Aave V2."
+    },
+    {
+      title: "AAVE",
+      argumentString: '"v2-raw", "markets", "AAVE"',
+      description: "returns list data for the AAVE token from Aave V2."
+    }
   ]
 };
 
@@ -750,6 +864,18 @@ var LENS_metadata = {
       require: "o",
       type: "number"
     }
+  ],
+  examples: [
+    {
+      title: "LENS",
+      argumentString: '"posts", "toka,miroyato"',
+      description: "returns posts made by the users with the usernames toka and miroyato on Lens."
+    },
+    {
+      title: "LENS",
+      argumentString: '"replies", "0x123abc456def789ghi012jkl345mno678pqr901stu234vwx567yz890abc123d"',
+      description: "returns replies to the post with the specified hash on Lens."
+    }
   ]
 };
 
@@ -793,6 +919,18 @@ var FARCASTER_metadata = {
       require: "o",
       type: "number"
     }
+  ],
+  examples: [
+    {
+      title: "FARCASTER",
+      argumentString: '"posts", "miroyato"',
+      description: "returns posts made by the user with the username miroyato."
+    },
+    {
+      title: "FARCASTER",
+      argumentString: '"replies", "0x123abc456def789ghi012jkl345mno678pqr901stu234vwx567yz890abc123d"',
+      description: "returns replies to the post with the specified hash."
+    }
   ]
 };
 
@@ -842,6 +980,18 @@ var FIREFLY_metadata = {
       require: "o",
       type: "number"
     }
+  ],
+  examples: [
+    {
+      title: "FIREFLY",
+      argumentString: '"farcaster", "posts", "miroyato"',
+      description: "returns posts made by the user with the username miroyato on Farcaster."
+    },
+    {
+      title: "FIREFLY",
+      argumentString: '"lens", "posts", "toka"',
+      description: "returns posts made by the user with the username toka on Lens."
+    }
   ]
 };
 
@@ -863,36 +1013,50 @@ var Neynar_metadata = {
       require: "m",
       type: "number"
     }
-  ]
+  ],
+  examples: [{
+    title: "NEYNAR",
+    argumentString: '"miroyato"',
+    description: "returns followers for the Farcaster user with the username miroyato."
+  }, {
+    title: "NEYNAR",
+    argumentString: '"alice"',
+    description: "returns followers for the Farcaster user with the username alice."
+  }]
 };
 
 // src/crypto/smart-contract/metadata.js
 var SMARTCONTRACT_metadata = {
   n: "SMARTCONTRACT",
   t: 20,
-  d: "Query smart contracts in cells.",
-  r: "Call a read-only function on a given smart contract",
+  d: "Query smart contract in cells. Returning a list of available functions and arguments that you can use to get data.",
+  r: "Query smart contract in cells. Returning a list of available functions and arguments that you can use to get data.",
   p: [
     {
-      name: "contractName",
-      detail: "Name of the contract you want to pull data from",
-      example: '"USDC"',
+      name: "contract_address",
+      detail: "Address of the contract you want to query",
+      example: '"0x9C58BAcC331c9aa871AFD802DB6379a98e80CEdb"',
       require: "m",
       type: "string"
     },
     {
-      name: "functionName",
-      detail: "Name of the function you want to call from the give contract",
-      example: '"balanceOf"',
+      name: "chain",
+      detail: 'Blockchain network(s) to query. Supported values: "ethereum", "gnosis", "base". Accepts comma-separated values.',
+      example: '"GNOSIS"',
       require: "m",
       type: "string"
+    }
+  ],
+  examples: [
+    {
+      title: "SMARTCONTRACT",
+      argumentString: '"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", "ETHEREUM"',
+      description: "returns the list of functions and their arguments for Circle USDC contract on Ethereum."
     },
     {
-      name: "...functionArgs",
-      detail: "Optional arguments to pass to the contract function.",
-      example: '"0x50Aa3435E310d5a2d15a989Bc353ce7f5682E1d4"',
-      require: "o",
-      type: "any"
+      title: "SMARTCONTRACT",
+      argumentString: '"0xdac17f958d2ee523a2206206994597c13d831ec7", "ETHEREUM"',
+      description: "returns the list of functions and their arguments for Tether USD (USDT) contract on Ethereum."
     }
   ]
 };
@@ -921,7 +1085,16 @@ var TALLY_metadata = {
       require: "m",
       type: "string"
     }
-  ]
+  ],
+  examples: [{
+    title: "TALLY",
+    argumentString: '"organization", "arbitrum"',
+    description: "returns details about the Arbitrum organization from Tally."
+  }, {
+    title: "TALLY",
+    argumentString: '"proposals", "aave"',
+    description: "returns proposals for the Aave organization from Tally."
+  }]
 };
 
 // src/crypto/dune-sim/metadata.js
@@ -970,6 +1143,18 @@ var DUNESIM_metadata = {
       require: "o",
       type: "number"
     }
+  ],
+  examples: [
+    {
+      title: "DUNE",
+      argumentString: '"price", "base", 1, "0xd9aaec86b65d86f6a7b5b1b0c42ffa531710b6ca", 5',
+      description: "returns the price of the specified token on the Base chain with a 1-hour historical offset, limiting results to 5 entries."
+    },
+    {
+      title: "DUNE",
+      argumentString: '"activity", "vitalik.eth", "eth", 10',
+      description: "returns the latest 10 wallet activities for the address vitalik.eth on the Ethereum chain."
+    }
   ]
 };
 
@@ -1001,6 +1186,18 @@ var PRICE_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "PRICE",
+      argumentString: '"0xd9aaec86b65d86f6a7b5b1b0c42ffa531710b6ca", "base", "1,24"',
+      description: "returns the price of the specified token on the Base chain with 1-hour and 24-hour historical offsets."
+    },
+    {
+      title: "PRICE",
+      argumentString: '"ETH,BTC", "1,24,168"',
+      description: "returns the prices of ETH and BTC with 1-hour, 24-hour, and 168-hour (7-day) historical offsets."
+    }
   ]
 };
 
@@ -1039,6 +1236,18 @@ var WALLET_metadata = {
       require: "o",
       type: "string"
     }
+  ],
+  examples: [
+    {
+      title: "WALLET",
+      argumentString: '"0x7FD624f3f97A7dd36195E8379F28dB6147C270ff", "ethereum", "txns", "17520"',
+      description: "returns transactions for the specified wallet address on the Ethereum chain within the last 17520 hours (approximately 2 years)."
+    },
+    {
+      title: "WALLET",
+      argumentString: '"vitalik.eth", "base", "balance"',
+      description: "returns the latest balance for the address vitalik.eth on the Base chain."
+    }
   ]
 };
 
@@ -1055,8 +1264,24 @@ var YIELD_metadata = {
       example: `"stablecoins"`,
       require: "m",
       type: "string"
+    },
+    {
+      name: "columnsName",
+      detail: "Filter columns by name in output. Comma separated list.",
+      example: `"id,address"`,
+      require: "o",
+      type: "string"
     }
-  ]
+  ],
+  examples: [{
+    title: "YIELD",
+    argumentString: '"stablecoins"',
+    description: "returns yield data for stablecoins."
+  }, {
+    title: "YIELD",
+    argumentString: '"all"',
+    description: "returns yield data for all categories."
+  }]
 };
 
 // src/crypto/circles/metadata.js
@@ -1093,7 +1318,16 @@ var CIRCLES_metadata = {
       require: "o",
       type: "string"
     }
-  ]
+  ],
+  examples: [{
+    title: "CIRCLES",
+    argumentString: '"trust", "0xe9A6378d8FD4983C2999DB0735f258397E8C2253"',
+    description: "returns the trust relationships for the specified Circles address."
+  }, {
+    title: "CIRCLES",
+    argumentString: '"transactions", "0xe9A6378d8FD4983C2999DB0735f258397E8C2253", 5',
+    description: "returns the last 5 transactions for the specified Circles address."
+  }]
 };
 
 // src/crypto/crypto-metadata.js

package/lib/esm/index.mjs

@@ -18009,7 +18009,7 @@ function toTimestamp(dateStr) {
 
 async function EOA() {
   try {
-    const [addresses, category, chains, startTime, endTime, page = 1, offset = 10, columnName = null] =
+    const [addresses, category, chains, startTime, endTime, page = 1, offset = 10, columnName] =
       argsToArray(arguments);
     validateParams(eoaParamsSchema, { addresses, category, chains, startTime, endTime, page, offset, columnName });
 
@@ -18350,7 +18350,7 @@ const coingeckoParamsSchema = discriminatedUnionType('category', [
 
 async function COINGECKO() {
   try {
-    const [category, param1, param2, columnName = null] = argsToArray(arguments);
+    const [category, param1, param2, columnName] = argsToArray(arguments);
     validateParams(coingeckoParamsSchema, { category, param1, param2, columnName });
 
     const apiKey = window.localStorage.getItem(SERVICES_API_KEY.Coingecko);
@@ -18444,7 +18444,7 @@ const CATEGORY_URLS = {
 
 async function DEFILLAMA() {
   try {
-    const [category, columnName = null] = argsToArray(arguments);
+    const [category, columnName] = argsToArray(arguments);
     validateParams(defillamaParamsSchema, { category, columnName });
     const url = CATEGORY_URLS[category];
     if (!url) throw new ValidationError(`Invalid category: ${category}`)
@@ -18468,6 +18468,7 @@ async function DEFILLAMA() {
     const filterColumnName = columnName?.split(',').map(s => s.trim());
 
     return (Array.isArray(json) ? json : [json]).map(item => {
+       if (!filterColumnName) return item
       const out = {};
       for (const [k, v] of Object.entries(item)) {
         if ((columnName && filterColumnName.includes(k)) && (v === null || typeof v !== 'object')) out[k] = v;
@@ -18510,7 +18511,7 @@ const etherscanParamsSchema = discriminatedUnionType('type', [gasSchema, txnSche
 
 async function ETHERSCAN() {
   try {
-    const [type, chain, address, startDate, endDate, page = 1, limit = 10, columnName = null] =
+    const [type, chain, address, startDate, endDate, page = 1, limit = 10, columnName] =
       argsToArray(arguments);
 
 
@@ -19485,17 +19486,18 @@ async function WALLET() {
 // WALLET("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "ethereum", "balance").then(console.log)
 
 const yieldParamsSchema = objectType({
-  category: enumType(['all', 'stablecoins'])
+  category: enumType(['all', 'stablecoins']),
+  columnName: stringType().optional(),
 });
 
 async function YIELD () {
 
     try {
-            const [category] = argsToArray(arguments);
+            const [category, columnName] = argsToArray(arguments);
         
-            validateParams(yieldParamsSchema, { category });
+            validateParams(yieldParamsSchema, { category, columnName });
         
-            const response = await DEFILLAMA('yields');
+            const response = await DEFILLAMA('yields', columnName);
         
             if(response.functionName){
                 response.functionName = 'YIELD';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fileverse-dev/formulajs",
-  "version": "4.4.41",
+  "version": "4.4.42-yield-a",
   "description": "JavaScript implementation of most Microsoft Excel formula functions",
   "author": "Formulajs",
   "publishConfig": {

package/types/cjs/index.d.cts

@@ -1187,7 +1187,7 @@ declare function DEC2OCT(number: any, places: any): any;
  * @returns
  */
 declare function DECIMAL(text: any, radix: any, ...args: any[]): any;
-declare function DEFILLAMA(...args: any[]): Promise<{
+declare function DEFILLAMA(...args: any[]): Promise<any[] | {
     message: string;
     functionName: any;
     type: string;
@@ -1205,7 +1205,7 @@ declare function DEFILLAMA(...args: any[]): Promise<{
     type: string;
     reason: any;
     apiKeyName?: undefined;
-} | {}[]>;
+}>;
 /**
  * Converts radians to degrees.
  *

package/types/esm/index.d.mts

@@ -1126,7 +1126,7 @@ export function DEC2OCT(number: any, places: any): any;
  * @returns
  */
 export function DECIMAL(text: any, radix: any, ...args: any[]): any;
-export function DEFILLAMA(...args: any[]): Promise<{
+export function DEFILLAMA(...args: any[]): Promise<any[] | {
     message: string;
     functionName: any;
     type: string;
@@ -1144,7 +1144,7 @@ export function DEFILLAMA(...args: any[]): Promise<{
     type: string;
     reason: any;
     apiKeyName?: undefined;
-} | {}[]>;
+}>;
 /**
  * Converts radians to degrees.
  *