@huma-finance/sdk 0.0.6-alpha.0

package/dist/utils/chain.d.ts

@@ -0,0 +1,14 @@
+import { JsonRpcProvider, JsonRpcSigner } from '@ethersproject/providers';
+import { ethers } from 'ethers';
+/**
+ * Get the chain ID from a signer or provider object.
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The signer or provider object to get the chain ID from.
+ * @returns {number} - The chain ID.
+ */
+export declare function getChainIdFromJsonSignerOrProvider(signerOrProvider: JsonRpcProvider | JsonRpcSigner): number;
+/**
+ * Get the chain ID from a signer or provider object.
+ * @param {ethers.provider.Provider | ethers.Signer} signerOrProvider - The signer or provider object to get the chain ID from.
+ * @returns {number} - The chain ID.
+ */
+export declare function getChainIdFromSignerOrProvider(signerOrProvider: ethers.providers.Provider | ethers.Signer): Promise<number | undefined>;

package/dist/utils/chain.js

@@ -0,0 +1,29 @@
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { ethers } from 'ethers';
+/**
+ * Get the chain ID from a signer or provider object.
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The signer or provider object to get the chain ID from.
+ * @returns {number} - The chain ID.
+ */
+export function getChainIdFromJsonSignerOrProvider(signerOrProvider) {
+    return signerOrProvider instanceof JsonRpcProvider
+        ? signerOrProvider.network.chainId
+        : signerOrProvider.provider.network.chainId;
+}
+/**
+ * Get the chain ID from a signer or provider object.
+ * @param {ethers.provider.Provider | ethers.Signer} signerOrProvider - The signer or provider object to get the chain ID from.
+ * @returns {number} - The chain ID.
+ */
+export async function getChainIdFromSignerOrProvider(signerOrProvider) {
+    var _a;
+    let network;
+    if (signerOrProvider instanceof ethers.providers.Provider) {
+        network = await signerOrProvider.getNetwork();
+    }
+    else {
+        network = await ((_a = signerOrProvider === null || signerOrProvider === void 0 ? void 0 : signerOrProvider.provider) === null || _a === void 0 ? void 0 : _a.getNetwork());
+    }
+    return network === null || network === void 0 ? void 0 : network.chainId;
+}
+//# sourceMappingURL=chain.js.map

package/dist/utils/chain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.js","sourceRoot":"","sources":["../../src/utils/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAiB,MAAM,0BAA0B,CAAA;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,gBAAiD;IAEjD,OAAO,gBAAgB,YAAY,eAAe;QAChD,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO;QAClC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAA;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,gBAA2D;;IAE3D,IAAI,OAAO,CAAA;IACX,IAAI,gBAAgB,YAAY,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;QACzD,OAAO,GAAG,MAAM,gBAAgB,CAAC,UAAU,EAAE,CAAA;KAC9C;SAAM;QACL,OAAO,GAAG,MAAM,CAAA,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,0CAAE,UAAU,EAAE,CAAA,CAAA;KACzD;IAED,OAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAA;AACzB,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './chain';
+export * from './web3';
+export * from './poolInfo';

package/dist/utils/index.js

@@ -0,0 +1,4 @@
+export * from './chain';
+export * from './web3';
+export * from './poolInfo';
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA"}

package/dist/utils/poolInfo.d.ts

@@ -0,0 +1,9 @@
+import { POOL_NAME, POOL_TYPE, PoolInfoType } from '@00labs/huma-shared';
+/**
+ * Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The Web3 provider or signer.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {PoolInfoType|undefined} - The pool info or undefined if the chain ID is not supported.
+ */
+export declare const getPoolInfo: (chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE) => PoolInfoType | undefined;

package/dist/utils/poolInfo.js

@@ -0,0 +1,10 @@
+import { PoolContractMap, } from '@00labs/huma-shared';
+/**
+ * Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The Web3 provider or signer.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {PoolInfoType|undefined} - The pool info or undefined if the chain ID is not supported.
+ */
+export const getPoolInfo = (chainId, poolName, poolType) => { var _a, _b; return (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]; };
+//# sourceMappingURL=poolInfo.js.map

package/dist/utils/poolInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"poolInfo.js","sourceRoot":"","sources":["../../src/utils/poolInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,GAEhB,MAAM,qBAAqB,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACO,EAAE,eAAC,OAAA,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,CAAA,EAAA,CAAA"}

package/dist/utils/web3.d.ts

@@ -0,0 +1,4 @@
+import { Contract } from '@ethersproject/contracts';
+import { ethers } from 'ethers';
+export declare function isAddress(value: any): string | false;
+export declare function getContract(address: string, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): Contract;

package/dist/utils/web3.js

@@ -0,0 +1,24 @@
+import { Contract } from '@ethersproject/contracts';
+import { AddressZero } from '@ethersproject/constants';
+import { getAddress } from '@ethersproject/address';
+// returns the checksummed address if the address is valid, otherwise returns false
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function isAddress(value) {
+    try {
+        // Alphabetical letters must be made lowercase for getAddress to work.
+        // See documentation here: https://docs.ethers.io/v5/api/utils/address/
+        return getAddress(value.toLowerCase());
+    }
+    catch (_a) {
+        return false;
+    }
+}
+export function getContract(address, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+ABI, signerOrProvider) {
+    if (!isAddress(address) || address === AddressZero) {
+        throw Error(`Invalid 'address' parameter '${address}'.`);
+    }
+    return new Contract(address, ABI, signerOrProvider);
+}
+//# sourceMappingURL=web3.js.map

package/dist/utils/web3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web3.js","sourceRoot":"","sources":["../../src/utils/web3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAGnD,mFAAmF;AACnF,8DAA8D;AAC9D,MAAM,UAAU,SAAS,CAAC,KAAU;IAClC,IAAI;QACF,sEAAsE;QACtE,uEAAuE;QACvE,OAAO,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;KACvC;IAAC,WAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,OAAe;AACf,8DAA8D;AAC9D,GAAQ,EACR,gBAA2D;IAE3D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,WAAW,EAAE;QAClD,MAAM,KAAK,CAAC,gCAAgC,OAAO,IAAI,CAAC,CAAA;KACzD;IAED,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;AACrD,CAAC"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@huma-finance/sdk",
+  "version": "0.0.6-alpha.0",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "tsc -w",
+    "generateDocs": "jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json > API.md",
+    "build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
+    "lint-staged": "lint-staged"
+  },
+  "dependencies": {
+    "@bundlr-network/client": "^0.10.5",
+    "@ethersproject/address": "^5.7.0",
+    "@ethersproject/bignumber": "^5.6.0",
+    "@ethersproject/constants": "^5.7.0",
+    "@ethersproject/contracts": "^5.7.0",
+    "@ethersproject/providers": "^5.6.0",
+    "arweave": "^1.13.5",
+    "ethers": "^5.7.2",
+    "graphql-request": "^6.0.0",
+    "react": "^18.2.0",
+    "tslib": "^2.5.0",
+    "typescript": "^4.8.4"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "git add . && lint-staged && yarn generateDocs"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.{js,ts,tsx,graphql}": [
+      "eslint --fix --max-warnings=0",
+      "prettier --write",
+      "git add ."
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.21.0",
+    "@babel/core": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-typescript": "^7.21.4",
+    "@typechain/ethers-v5": "^10.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^27.1.3",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-babel": "^0.5.0",
+    "jsdoc-to-markdown": "^8.0.0",
+    "lint-staged": "^10.5.4",
+    "prettier": "^2.7.1"
+  },
+  "peerDependencies": {
+    "ethers": "^5.6.1",
+    "react": ">=16.8.0"
+  },
+  "optionalDependencies": {
+    "encoding": "^0.1.13"
+  },
+  "gitHead": "0b1feed2400122e9c08f33e803f941ac48013a65"
+}