@huma-finance/sdk 0.0.11 → 0.0.13

package/dist/utils/chain.d.ts

@@ -1,14 +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>;
+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

@@ -1,29 +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;
-}
+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/index.d.ts

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

package/dist/utils/index.js

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

package/dist/utils/poolInfo.d.ts

@@ -1,9 +1,9 @@
-import { POOL_NAME, POOL_TYPE, PoolInfoType } from '@huma-finance/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;
+import { POOL_NAME, POOL_TYPE, PoolInfoType } from '@huma-finance/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

@@ -1,10 +1,10 @@
-import { PoolContractMap, } from '@huma-finance/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]; };
+import { PoolContractMap, } from '@huma-finance/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/web3.d.ts

@@ -1,4 +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;
+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

@@ -1,24 +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);
-}
+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/getting-started.md

@@ -0,0 +1,191 @@
+# Getting Started
+
+In this guide we'll take a look at using Huma's SDK to mint and pay a receivable, call functions on our pool, and more.
+
+## Installation
+
+Huma's SDK can be installed using npm or yarn.
+
+```
+npm install @huma-finance/sdk
+yarn add @huma-finance/sdk
+```
+
+You'll also want to install Huma's shared utilities
+
+```
+npm install @huma-finance/shared
+yarn add @huma-finance/shared
+```
+
+## Mint a Pool Receivable
+
+Create a new file `index.js` and import services from `@huma-finance/sdk` and `@huma-finance/shared`
+
+```
+import { ReceivableService, PaymentMethod } from '@huma-finance/sdk'
+import { POOL_NAME, POOL_TYPE } from "@huma-finance/shared";
+```
+
+Set up your ethers Provider and import your private key
+
+```
+const TEST_PRIVATE_KEY = "YOUR_PRIVATE_KEY";
+const provider = new ethers.providers.JsonRpcProvider(
+    `https://goerli.infura.io/v3/${INFURA_API_KEY}`,
+    {
+        name: "Goerli",
+        chainId: 5,
+    }
+);
+```
+
+Call on the `mintReceivable` method with an ethers Wallet instance
+
+> Note: Receivables support multiple payment methods. Declarative receivables
+> don't actually transfer ERC20 tokens, they just update their balance on-chain.
+> Payable receivables will actually call pool methods to transfer ERC20 tokens. 
+
+```
+const wallet = new Wallet(TEST_PRIVATE_KEY, provider);
+const tx = await ReceivableService.mintReceivable(
+    wallet,
+    POOL_NAME.HumaCreditLine,
+    POOL_TYPE.CreditLine,
+    1000, // receivableAmount
+    1684517656, // maturityDate
+    PaymentMethod.Declarative, // paymentMethod
+    ""
+);
+const data = await tx.wait();
+console.log(`Success. Tx hash: ${data.transactionHash}`);
+```
+
+Running this in the console, we should see the following result
+
+```
+$ node index.js
+{}
+Success. Tx hash: 0xb789af3611bc01b6a90f002327500421abf575660be1bbb30013d52518260e41
+```
+
+Congrats! You've successfully minted your own receivable token, which are used to borrow from Huma's pools.
+
+If you're stuck or want to view a complete solution, check out our `examples` directory (here)[https://github.com/00labs/huma-dapp/blob/develop/packages/examples/src/]
+
+## Call functions from Huma's pool
+
+We can use the Huma SDK to easily obtain ethers Contract instances of any Huma pool.
+
+```
+import { getPoolContract } from "@huma-finance/sdk";
+import { POOL_NAME, POOL_TYPE } from "@huma-finance/shared";
+```
+
+With a ethers provider, pass in some config options for which pool contract you'd like to fetch.
+
+```
+const poolContract = getPoolContract(
+    wallet,
+    5, // Goerli chain ID
+    POOL_NAME.HumaCreditLine,
+    POOL_TYPE.CreditLine
+);
+```
+
+Now you can call any functions you want on the pool as if it were any other ethers Contract. Let's try fetching credit record details of our current account:
+
+```
+const data = await poolContract.creditRecordMapping(wallet.address);
+console.log(data);
+```
+
+Running this in the console, you should see something like this
+
+```
+$ node index.js
+[
+  BigNumber { _hex: '0x00', _isBigNumber: true },
+  BigNumber { _hex: '0x00', _isBigNumber: true },
+  BigNumber { _hex: '0x00', _isBigNumber: true },
+  BigNumber { _hex: '0x00', _isBigNumber: true },
+  BigNumber { _hex: '0x00', _isBigNumber: true },
+  0,
+  0,
+  0,
+  unbilledPrincipal: BigNumber { _hex: '0x00', _isBigNumber: true },
+  dueDate: BigNumber { _hex: '0x00', _isBigNumber: true },
+  correction: BigNumber { _hex: '0x00', _isBigNumber: true },
+  totalDue: BigNumber { _hex: '0x00', _isBigNumber: true },
+  feesAndInterestDue: BigNumber { _hex: '0x00', _isBigNumber: true },
+  missedPeriods: 0,
+  remainingPeriods: 0,
+  state: 0
+]
+Done in 4.90s.
+```
+
+# Other SDK examples 
+
+## Declare a receivable as paid
+
+Once we've minted a receivable, we can use the `ReceivableService` to pay it off using multiple types of payment methods.
+
+```
+const wallet = new Wallet(TEST_PRIVATE_KEY, provider);
+
+const data = await ReceivableService.payReceivableByTokenId(
+    wallet,
+    8, // receivableTokenId
+    10, // paymentAmount
+    PaymentMethod.Declarative // paymentMethod
+);
+console.log(`Success. Tx hash: ${data.transactionHash}`);
+```
+
+## Mint a receivable with metadata automatically uploaded to ARWeave
+
+Huma supports both lazy funding and pre-funding the ARWeave network to pay for metadata uploads. 
+
+```
+// Prefund...
+await prefundBundlr(getBundlrNetworkConfig(5), signer, 1_000_000)
+
+// Or pay as you go! (Note: it's recommended you still prefund with a small 
+// amount of currency to avoid slippage)
+const data = await ReceivableService.mintReceivableWithMetadata(
+    signer,
+    TEST_PRIVATE_KEY,
+    chainId,
+    poolName,
+    poolType,
+    receivableAmount,
+    maturityDate,
+    paymentMethod,
+    JSON.parse(metadata),
+    internalID,
+    [],
+)
+setMintResult(`Success, Tx Hash: ${data.transactionHash}`)
+console.log(data)
+```
+
+## Query for receivables uploaded to ARWeave
+
+Once metadata is uploaded to ARWeave, you can query them by referenceId tags, which you can specify during upload.
+
+```
+const data = await ARWeaveService.queryForMetadata(
+    chainId,
+    poolName,
+    poolType,
+    address,
+    '12', // referenceId
+)
+setQueryResult(data)
+console.log(data)
+```
+
+## Next steps
+
+If you want to learn more about the different functions and helpers available in the Huma SDK, please check out our [API documentation](API.md).

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@huma-finance/sdk",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "types": "./dist/index.d.ts",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
   "files": [
-    "dist"
+    "dist",
+    "getting-started.md",
+    "API.md"
   ],
   "scripts": {
     "start": "tsc -w",
+    "graphql": "graphql-codegen",
     "generateDocs": "jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json > API.md",
     "build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
-    "lint-staged": "lint-staged"
+    "lint-staged": "lint-staged",
+    "prettier": "prettier --write \"src/**/*.{js,ts,tsx,graphql}\""
   },
   "dependencies": {
     "@bundlr-network/client": "^0.10.5",
@@ -20,10 +24,10 @@
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.6.0",
-    "@huma-finance/shared": "^0.0.11",
+    "@huma-finance/shared": "^0.0.13",
     "arweave": "^1.13.5",
     "ethers": "^5.7.2",
-    "graphql-request": "^6.0.0",
+    "graphql-request": "5.1.0",
     "react": "^18.2.0",
     "tslib": "^2.5.0",
     "typescript": "^4.8.4"
@@ -57,6 +61,9 @@
     "@babel/core": "^7.21.4",
     "@babel/preset-env": "^7.21.4",
     "@babel/preset-typescript": "^7.21.4",
+    "@graphql-codegen/cli": "^3.3.1",
+    "@graphql-codegen/typescript": "^3.0.4",
+    "@graphql-codegen/typescript-graphql-request": "^4.5.9",
     "@typechain/ethers-v5": "^10.1.0",
     "@typescript-eslint/eslint-plugin": "^5.41.0",
     "@typescript-eslint/parser": "^5.41.0",
@@ -83,5 +90,5 @@
   "optionalDependencies": {
     "encoding": "^0.1.13"
   },
-  "gitHead": "12afb4430fa58ad8403bde9aadb52c7ddb1f048c"
+  "gitHead": "d4c4b86cde3f84209204f8f926de995bb07a1bd2"
 }