@gibs/common 1.7.1 → 1.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibs/common",
-  "version": "1.7.1",
+  "version": "1.7.3",
   "main": "index.js",
   "access": "public",
   "type": "module",

package/src/client.ts

@@ -1,5 +1,6 @@
 import { type Chain, type PublicClient, createPublicClient, fallback, http, webSocket } from "viem"
 
+/** The default batch config for the client */
 export const defaultBatchConfig = {
   batch: {
     wait: 10,
@@ -7,15 +8,28 @@ export const defaultBatchConfig = {
   },
 }
 
+/**
+ * Returns the chain key for the given chain id and urls
+ * @param chainId - the chain id
+ * @param urls - the urls
+ * @returns the chain key
+ */
 export const chainKey = (chainId: number, urls: string[]) => {
   return `${chainId},${urls.join(',')}`.toLowerCase()
 }
 
+/** The client cache for the given chain id */
 export const clientCache = new Map<number, {
   key: string
   client: PublicClient
 }>()
 
+/**
+ * Returns the client for the given chain and urls
+ * @param chain - the chain
+ * @param urls - the urls
+ * @returns the client
+ */
 export const clientFromChain = ({
   chain,
   urls,

package/src/erc20.ts

@@ -11,12 +11,14 @@ import _ from 'lodash'
 import type { Erc20Metadata } from './types.js'
 import { multicallRead } from './multicall.js'
 
+/** The erc20 metadata calls */
 export const erc20MetadataCalls = [
   { functionName: 'name' },
   { functionName: 'symbol' },
   { functionName: 'decimals' },
 ]
 
+/** The multicall for the erc20 metadata */
 export const multicallErc20 = _.memoize(
   async ({ client, target, chain }: { client: PublicClient; target: Hex; chain: Chain }) => {
     const options = {

package/src/index.ts

@@ -3,3 +3,4 @@ export * from './serialize.js'
 export * from './cache.js'
 export * from './multicall.js'
 export * from './erc20.js'
+export * from './client.js'

package/src/multicall.ts

@@ -11,6 +11,7 @@ import {
 import _ from 'lodash'
 import type { Call } from './types.js'
 
+/** The multicall for the given chain, client, abi, calls, and target */
 export const multicallRead = async <T>({
   chain,
   client,

package/src/serialize.ts

@@ -4,6 +4,7 @@ type SerializedBigInt = {
   __type__: typeof BIGINT_TYPE
   value: string
 }
+/** The json any stringify for the given key and value */
 export const jsonAnyStringify = (key: string, value: unknown) => {
   if (typeof value === BIGINT_TYPE) {
     return {
@@ -14,12 +15,14 @@ export const jsonAnyStringify = (key: string, value: unknown) => {
   return value
 }
 
+/** The is serialized big int for the given value */
 export const isSerializedBigInt = (value: unknown): value is SerializedBigInt => {
   return (
     !!value && typeof value === 'object' && (value as SerializedBigInt).__type__ === BIGINT_TYPE
   )
 }
 
+/** The json any parse for the given key and value */
 export const jsonAnyParse = (_key: string, value: unknown) => {
   if (isSerializedBigInt(value)) {
     return BigInt(value.value)

package/src/types.ts

@@ -1,5 +1,6 @@
 import type { Abi, Hex } from "viem"
 
+/** The inputs for a multicall read */
 export type Call = {
   allowFailure?: boolean
   functionName: string
@@ -7,5 +8,6 @@ export type Call = {
   abi?: Abi
   args?: (bigint | Hex | Hex[] | bigint[] | string | string[])[]
 }
-export type Erc20Metadata = [string, string, number]
 
+/** The erc20 metadata */
+export type Erc20Metadata = [string, string, number]