@huma-finance/sdk 0.0.11 → 0.0.12

package/API.md

@@ -0,0 +1,432 @@
+## Objects
+
+<dl>
+<dt><a href="#usePoolContract">usePoolContract</a> ⇒ <code>T</code></dt>
+<dd><p>A react hook that returns a contract instance of a specific pool using an ethers provider or signer</p></dd>
+<dt><a href="#ARWeaveService">ARWeaveService</a> : <code>object</code></dt>
+<dd><p>An object that contains functions to interact with Huma-related data stored on ARWeave</p></dd>
+<dt><a href="#EAService">EAService</a> : <code>object</code></dt>
+<dd><p>An object that contains functions to interact with Huma's EAVerse service.</p></dd>
+<dt><a href="#ReceivableService">ReceivableService</a> : <code>object</code></dt>
+<dd><p>An object that contains functions to interact with Huma's receivables.</p></dd>
+<dt><a href="#SubgraphService">SubgraphService</a> : <code>object</code></dt>
+<dd><p>An object that contains functions to interact with Huma's Subgraph storage.</p></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#getERC20TransferableReceivableContract">getERC20TransferableReceivableContract(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>Returns an ethers contract instance for the ERC20TransferableReceivable contract
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#getPoolContract">getPoolContract(signerOrProvider, chainId, poolName, poolType)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>Returns an ethers contract instance for a Huma pool contract</p></dd>
+<dt><a href="#getRealWorldReceivableContract">getRealWorldReceivableContract(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>Returns an ethers contract instance for the RealWorldReceivable contract
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#useContract">useContract(address, ABI, signerOrProvider)</a> ⇒ <code>T</code> | <code>null</code></dt>
+<dd><p>Custom hook for creating an ethers instance of a smart contract.</p></dd>
+<dt><a href="#useERC20TransferableReceivableContract">useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#useRealWorldReceivableContract">useRealWorldReceivableContract(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>A react hook that returns an ethers contract instance for the RealWorldReceivable contract
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#getChainIdFromJsonSignerOrProvider">getChainIdFromJsonSignerOrProvider(signerOrProvider)</a> ⇒ <code>number</code></dt>
+<dd><p>Get the chain ID from a signer or provider object.</p></dd>
+<dt><a href="#getChainIdFromSignerOrProvider">getChainIdFromSignerOrProvider(signerOrProvider)</a> ⇒ <code>number</code></dt>
+<dd><p>Get the chain ID from a signer or provider object.</p></dd>
+<dt><a href="#getPoolInfo">getPoolInfo(signerOrProvider, poolName, poolType)</a> ⇒ <code>PoolInfoType</code> | <code>undefined</code></dt>
+<dd><p>Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given</p></dd>
+</dl>
+
+## Typedefs
+
+<dl>
+<dt><a href="#ApprovalResult">ApprovalResult</a> : <code>Object</code></dt>
+<dd><p>Object representing the response to the underwriting approval request.</p></dd>
+<dt><a href="#EAPayload">EAPayload</a> : <code>Object</code></dt>
+<dd><p>Object representing an invoice payload for underwriting approval.</p></dd>
+<dt><a href="#CreditEventPayload">CreditEventPayload</a> : <code>Object</code></dt>
+<dd><p>Represents the payload of a credit event.</p></dd>
+</dl>
+
+<a name="usePoolContract"></a>
+
+## usePoolContract ⇒ <code>T</code>
+<p>A react hook that returns a contract instance of a specific pool using an ethers provider or signer</p>
+
+**Kind**: global namespace  
+**Returns**: <code>T</code> - <p>A contract instance of the specific pool.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>An ethers signer or provider instance.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+
+
+* [usePoolContract](#usePoolContract) ⇒ <code>T</code>
+    * [.useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType)](#usePoolContract.useCreditRecordDetails) ⇒ <code>Array.&lt;(CreditRecordDetails\|undefined), function(): void&gt;</code>
+    * [.CreditRecordDetails](#usePoolContract.CreditRecordDetails) : <code>Object</code>
+
+<a name="usePoolContract.useCreditRecordDetails"></a>
+
+### usePoolContract.useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) ⇒ <code>Array.&lt;(CreditRecordDetails\|undefined), function(): void&gt;</code>
+<p>A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.</p>
+
+**Kind**: static method of [<code>usePoolContract</code>](#usePoolContract)  
+**Returns**: <code>Array.&lt;(CreditRecordDetails\|undefined), function(): void&gt;</code> - <p>An array containing the credit record details and a function to refresh the data.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userAddress | <code>string</code> | <p>The address of the user to get the credit record details for.</p> |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The signer or provider object to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool to get the credit record details for.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+
+<a name="usePoolContract.CreditRecordDetails"></a>
+
+### usePoolContract.CreditRecordDetails : <code>Object</code>
+<p>CreditRecordDetails type object representing the details of a credit line.</p>
+
+**Kind**: static typedef of [<code>usePoolContract</code>](#usePoolContract)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| aprInBps | <code>number</code> | <p>The APR (annual percentage rate) in basis points.</p> |
+| correction | <code>BigNumber</code> | <p>adjustment of interest over or under-counted because of drawdown or principal payment in the middle of a billing period</p> |
+| creditLimit | <code>BigNumber</code> | <p>The credit limit in the pools base currency.</p> |
+| defaultAmount | <code>BigNumber</code> | <p>The amount of the default, if any.</p> |
+| dueDate | <code>BigNumber</code> | <p>The due date of the next payment.</p> |
+| feesAndInterestDue | <code>BigNumber</code> | <p>The fees and interest due.</p> |
+| intervalInDays | <code>number</code> | <p>The interval in days between payment periods.</p> |
+| missedPeriods | <code>number</code> | <p>The number of missed periods.</p> |
+| remainingPeriods | <code>number</code> | <p>The number of remaining periods before this credit line is considered paid off.</p> |
+| state | <code>number</code> | <p>The state of the factorization. Please see the CreditState in huma-contracts for more details.</p> |
+| totalDue | <code>BigNumber</code> | <p>The total due amount of this credit line.</p> |
+| unbilledPrincipal | <code>BigNumber</code> | <p>The unbilled principal of the next payment.</p> |
+
+<a name="ARWeaveService"></a>
+
+## ARWeaveService : <code>object</code>
+<p>An object that contains functions to interact with Huma-related data stored on ARWeave</p>
+
+**Kind**: global namespace  
+<a name="EAService"></a>
+
+## EAService : <code>object</code>
+<p>An object that contains functions to interact with Huma's EAVerse service.</p>
+
+**Kind**: global namespace  
+<a name="ReceivableService"></a>
+
+## ReceivableService : <code>object</code>
+<p>An object that contains functions to interact with Huma's receivables.</p>
+
+**Kind**: global namespace  
+
+* [ReceivableService](#ReceivableService) : <code>object</code>
+    * [.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount)](#ReceivableService.declareReceivablePaymentByReferenceId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount)](#ReceivableService.declareReceivablePaymentByTokenId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts)](#ReceivableService.createReceivable) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.createReceivableWithMetadata(signerOrProvider, privateKey, chainId, recipient, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, [lazyFund], [gasOpts])](#ReceivableService.createReceivableWithMetadata) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+
+<a name="ReceivableService.declareReceivablePaymentByReferenceId"></a>
+
+### ReceivableService.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.</p>
+
+**Kind**: static method of [<code>ReceivableService</code>](#ReceivableService)  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction receipt.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction. Note only the receivable owner can pay the receivable.</p> |
+| referenceId | <code>string</code> | <p>An internal identifier value added as a tag on ARWeave</p> |
+| paymentAmount | <code>number</code> | <p>The amount to declare paid to the receivable.</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByTokenId"></a>
+
+### ReceivableService.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Declares a payment on a RealWorldReceivable given a tokenID of the receivable.</p>
+
+**Kind**: static method of [<code>ReceivableService</code>](#ReceivableService)  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction receipt.</li>
+</ul>  
+**Throws**:
+
+- <code>Error</code> <ul>
+<li>Throws an error if the RealWorldReceivable contract is not available on the network.</li>
+</ul>
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction. Note only the receivable owner can pay the receivable.</p> |
+| receivableTokenId | <code>BigNumberish</code> | <p>The ID of the receivable token to pay.</p> |
+| paymentAmount | <code>number</code> | <p>The amount to pay the receivable.</p> |
+
+<a name="ReceivableService.createReceivable"></a>
+
+### ReceivableService.createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Creates a new RealWorldReceivable token on the given chain of the signer</p>
+
+**Kind**: static method of [<code>ReceivableService</code>](#ReceivableService)  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction response.</li>
+</ul>  
+**Throws**:
+
+- <code>Error</code> <ul>
+<li>Throws an error if the RealWorldReceivable contract is not available on the network.</li>
+</ul>
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| currencyCode | <code>number</code> | <p>The ISO 4217 currency code that the receivable is denominated in</p> |
+| receivableAmount | <code>number</code> | <p>The amount of the receivable token to mint.</p> |
+| maturityDate | <code>number</code> | <p>The maturity date of the receivable token, in UNIX timestamp format.</p> |
+| uri | <code>string</code> | <p>The URI of the receivable token metadata.</p> |
+| gasOpts | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="ReceivableService.createReceivableWithMetadata"></a>
+
+### ReceivableService.createReceivableWithMetadata(signerOrProvider, privateKey, chainId, recipient, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, [lazyFund], [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Creates a RealWorldReceivable token with metadata uploaded onto ARWeave</p>
+
+**Kind**: static method of [<code>ReceivableService</code>](#ReceivableService)  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>The transaction receipt.</li>
+</ul>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| signerOrProvider | <code>Web3Provider</code> \| <code>ethers.Signer</code> |  | <p>If calling this function from a browser, this function expects a Web3Provider. If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included from server calls.</p> |
+| privateKey | <code>string</code> \| <code>null</code> |  | <p>Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.</p> |
+| chainId | <code>number</code> |  | <p>The chain ID to mint the receivable token on and pay ARWeave funds from.</p> |
+| recipient | <code>string</code> |  | <p>The receivable token recipient.</p> |
+| poolName | <code>POOL\_NAME</code> |  | <p>The pool name. Used to lookup the pool address to pay to.</p> |
+| poolType | <code>POOL\_TYPE</code> |  | <p>The pool type. Used to lookup the pool address to pay to.</p> |
+| currencyCode | <code>number</code> |  | <p>The ISO 4217 currency code that the receivable is denominated in</p> |
+| receivableAmount | <code>number</code> |  | <p>The receivable amount.</p> |
+| maturityDate | <code>number</code> |  | <p>The maturity date of the receivable, in UNIX timestamp format.</p> |
+| metadata | <code>JSON</code> |  | <p>The metadata in JSON format. This will be uploaded onto ARWeave</p> |
+| referenceId | <code>number</code> |  | <p>An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.</p> |
+| extraTags | <code>Array.&lt;{name: string, value: string}&gt;</code> |  | <p>Any extraTags you'd like to tag your metadata with. Note that metadata on ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.</p> |
+| [lazyFund] | <code>boolean</code> | <code>true</code> | <p>Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.</p> |
+| [gasOpts] | <code>Overrides</code> |  | <p>Optional gas overrides for the transaction.</p> |
+
+<a name="SubgraphService"></a>
+
+## SubgraphService : <code>object</code>
+<p>An object that contains functions to interact with Huma's Subgraph storage.</p>
+
+**Kind**: global namespace  
+
+* [SubgraphService](#SubgraphService) : <code>object</code>
+    * [.getSubgraphUrlForChainId(chainId)](#SubgraphService.getSubgraphUrlForChainId) ⇒ <code>string</code>
+    * [.getCreditEventsForUser(userAddress, chainId, poolName, poolType, event)](#SubgraphService.getCreditEventsForUser) ⇒ <code>Promise.&lt;Array.&lt;CreditEventPayload&gt;&gt;</code>
+    * [.getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolType)](#SubgraphService.getLastFactorizedAmountFromPool) ⇒ <code>Promise.&lt;number&gt;</code>
+
+<a name="SubgraphService.getSubgraphUrlForChainId"></a>
+
+### SubgraphService.getSubgraphUrlForChainId(chainId) ⇒ <code>string</code>
+<p>Returns the subgraph URL for a given chain ID.</p>
+
+**Kind**: static method of [<code>SubgraphService</code>](#SubgraphService)  
+**Returns**: <code>string</code> - <p>The subgraph URL for the given chain ID.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chainId | <code>number</code> | <p>The ID of the chain.</p> |
+
+<a name="SubgraphService.getCreditEventsForUser"></a>
+
+### SubgraphService.getCreditEventsForUser(userAddress, chainId, poolName, poolType, event) ⇒ <code>Promise.&lt;Array.&lt;CreditEventPayload&gt;&gt;</code>
+<p>Returns the credit events for a given user.</p>
+
+**Kind**: static method of [<code>SubgraphService</code>](#SubgraphService)  
+**Returns**: <code>Promise.&lt;Array.&lt;CreditEventPayload&gt;&gt;</code> - <p>The credit events for the given user.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userAddress | <code>string</code> | <p>The address of the user.</p> |
+| chainId | <code>number</code> | <p>The ID of the chain.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| event | <code>Array.&lt;string&gt;</code> | <p>The event types to filter by.</p> |
+
+<a name="SubgraphService.getLastFactorizedAmountFromPool"></a>
+
+### SubgraphService.getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolType) ⇒ <code>Promise.&lt;number&gt;</code>
+<p>Returns the last factorized amount for a given user and pool.</p>
+
+**Kind**: static method of [<code>SubgraphService</code>](#SubgraphService)  
+**Returns**: <code>Promise.&lt;number&gt;</code> - <p>The last factorized amount for the given user and pool.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userAddress | <code>string</code> | <p>The address of the user.</p> |
+| chainId | <code>number</code> | <p>The ID of the chain.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+
+<a name="getERC20TransferableReceivableContract"></a>
+
+## getERC20TransferableReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
+<p>Returns an ethers contract instance for the ERC20TransferableReceivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+
+<a name="getPoolContract"></a>
+
+## getPoolContract(signerOrProvider, chainId, poolName, poolType) ⇒ <code>Contract</code> \| <code>null</code>
+<p>Returns an ethers contract instance for a Huma pool contract</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the Pool contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool contract to get.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool contract to get.</p> |
+
+<a name="getRealWorldReceivableContract"></a>
+
+## getRealWorldReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
+<p>Returns an ethers contract instance for the RealWorldReceivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the RealWorldReceivable contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+
+<a name="useContract"></a>
+
+## useContract(address, ABI, signerOrProvider) ⇒ <code>T</code> \| <code>null</code>
+<p>Custom hook for creating an ethers instance of a smart contract.</p>
+
+**Kind**: global function  
+**Returns**: <code>T</code> \| <code>null</code> - <p>An instance of the smart contract, or null if an error occurs.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| address | <code>string</code> \| <code>null</code> \| <code>undefined</code> | <p>The address of the smart contract instance.</p> |
+| ABI | <code>any</code> | <p>The ABI of the smart contract.</p> |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The signer or provider used to sign transactions or retrieve blockchain data. Note that this signerOrProvider must be connected to the same network as the smart contract in question.</p> |
+
+<a name="useERC20TransferableReceivableContract"></a>
+
+## useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) ⇒ <code>Contract</code> \| <code>null</code>
+<p>A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool to get the contract for.</p> |
+
+<a name="useRealWorldReceivableContract"></a>
+
+## useRealWorldReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
+<p>A react hook that returns an ethers contract instance for the RealWorldReceivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the RealWorldReceivable contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+
+<a name="getChainIdFromJsonSignerOrProvider"></a>
+
+## getChainIdFromJsonSignerOrProvider(signerOrProvider) ⇒ <code>number</code>
+<p>Get the chain ID from a signer or provider object.</p>
+
+**Kind**: global function  
+**Returns**: <code>number</code> - <ul>
+<li>The chain ID.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>JsonRpcProvider</code> \| <code>JsonRpcSigner</code> | <p>The signer or provider object to get the chain ID from.</p> |
+
+<a name="getChainIdFromSignerOrProvider"></a>
+
+## getChainIdFromSignerOrProvider(signerOrProvider) ⇒ <code>number</code>
+<p>Get the chain ID from a signer or provider object.</p>
+
+**Kind**: global function  
+**Returns**: <code>number</code> - <ul>
+<li>The chain ID.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.provider.Provider</code> \| <code>ethers.Signer</code> | <p>The signer or provider object to get the chain ID from.</p> |
+
+<a name="getPoolInfo"></a>
+
+## getPoolInfo(signerOrProvider, poolName, poolType) ⇒ <code>PoolInfoType</code> \| <code>undefined</code>
+<p>Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given</p>
+
+**Kind**: global function  
+**Returns**: <code>PoolInfoType</code> \| <code>undefined</code> - <ul>
+<li>The pool info or undefined if the chain ID is not supported.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>JsonRpcProvider</code> \| <code>JsonRpcSigner</code> | <p>The Web3 provider or signer.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+
+<a name="ApprovalResult"></a>
+
+## ApprovalResult : <code>Object</code>
+<p>Object representing the response to the underwriting approval request.</p>
+
+**Kind**: global typedef  
+<a name="EAPayload"></a>
+
+## EAPayload : <code>Object</code>
+<p>Object representing an invoice payload for underwriting approval.</p>
+
+**Kind**: global typedef  
+<a name="CreditEventPayload"></a>
+
+## CreditEventPayload : <code>Object</code>
+<p>Represents the payload of a credit event.</p>
+
+**Kind**: global typedef  

package/README.md

@@ -20,12 +20,16 @@ For extensive documentation on the different functions offered please refer to t
 - Hooks
   - React hooks for fetching ethers.js Contract instances of Huma contracts
 - Helpers
-  - Helper functions for fetching ethers.js Contract instances of Huma contracts
+  - `ERC20TransferableReceivableContractHelper` fetches ERC20TransferableReceivable contract instances, which Huma uses for its Request Network integration
+  - `RealWorldReceivableContractHelper` fetches RealWorldReceivable contract instances, which Huma uses to power pool loan tapes
+  - `PoolContractHelper` helper function for interacting with Huma's pool contracts, including drawdown and payback
 
 ## Examples
 
-To see how the Huma SDK can be used, feel free to use our interactive example in the huma-widgets package.
+To see how the Huma SDK can be used, feel free to use our interactive example in the `huma-widgets` package.
 
-1. Open up the huma-widgets package in your terminal
-2. Run yarn cosmos
-3. Open up localhost:8000 in your browser and navigate to the SDKTesting fixture
+1. Open up the `huma-widgets` package in your terminal
+2. Run `yarn cosmos`
+3. Open up localhost:8000 in your browser and navigate to the SDKTesting fixture
+
+If you're looking for nodeJS script integrations, go to our `packages/examples` folder and view the examples scripts provided there.

package/dist/cjs/graphql/generatedTypes.d.ts

@@ -0,0 +1,40 @@
+import { GraphQLClient } from 'graphql-request';
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Exact<T extends {
+    [key: string]: unknown;
+}> = {
+    [K in keyof T]: T[K];
+};
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]?: Maybe<T[SubKey]>;
+};
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]: Maybe<T[SubKey]>;
+};
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+    ID: string;
+    String: string;
+    Boolean: boolean;
+    Int: number;
+    Float: number;
+};
+export type Receivable = {
+    __typename?: 'Receivable';
+    creationDate?: Maybe<Scalars['String']>;
+    currencyCode?: Maybe<Scalars['String']>;
+    id?: Maybe<Scalars['String']>;
+    lastUpdate?: Maybe<Scalars['String']>;
+    maturityDate?: Maybe<Scalars['String']>;
+    owner?: Maybe<Scalars['String']>;
+    paidAmount?: Maybe<Scalars['String']>;
+    pool?: Maybe<Scalars['String']>;
+    receivableAmount?: Maybe<Scalars['String']>;
+    status?: Maybe<Scalars['String']>;
+    tokenId?: Maybe<Scalars['String']>;
+    uri?: Maybe<Scalars['String']>;
+};
+export type SdkFunctionWrapper = <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string) => Promise<T>;
+export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper): {};
+export type Sdk = ReturnType<typeof getSdk>;

package/dist/cjs/graphql/generatedTypes.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSdk = void 0;
+const defaultWrapper = (action, _operationName, _operationType) => action();
+function getSdk(client, withWrapper = defaultWrapper) {
+    return {};
+}
+exports.getSdk = getSdk;
+//# sourceMappingURL=generatedTypes.js.map

package/dist/cjs/graphql/generatedTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generatedTypes.js","sourceRoot":"","sources":["../../../src/graphql/generatedTypes.ts"],"names":[],"mappings":";;;AA8CA,MAAM,cAAc,GAAuB,CACzC,MAAM,EACN,cAAc,EACd,cAAc,EACd,EAAE,CAAC,MAAM,EAAE,CAAA;AAEb,SAAgB,MAAM,CACpB,MAAqB,EACrB,cAAkC,cAAc;IAEhD,OAAO,EAAE,CAAA;AACX,CAAC;AALD,wBAKC"}

package/dist/cjs/graphql/index.d.ts

@@ -0,0 +1 @@
+export * from './generatedTypes';

package/dist/cjs/graphql/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./generatedTypes"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/graphql/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/graphql/index.ts"],"names":[],"mappings":";;;AAAA,2DAAgC"}

package/dist/cjs/helpers/PoolContractHelper.d.ts

@@ -1,5 +1,6 @@
-import { Contract, ethers } from 'ethers';
+import { BigNumberish, Contract, ethers } from 'ethers';
 import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+import { TransactionResponse } from '@ethersproject/providers';
 /**
  * Returns an ethers contract instance for a Huma pool contract
  *
@@ -10,3 +11,5 @@ import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
  * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
  */
 export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Contract | null;
+export declare function drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish): Promise<TransactionResponse>;
+export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish): Promise<TransactionResponse>;

package/dist/cjs/helpers/PoolContractHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPoolContract = void 0;
+exports.makePaymentToPool = exports.drawdownFromPool = exports.getPoolContract = void 0;
 const utils_1 = require("../utils");
 /**
  * Returns an ethers contract instance for a Huma pool contract
@@ -18,4 +18,22 @@ function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
     return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
 }
 exports.getPoolContract = getPoolContract;
+function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount) {
+    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    // TODO: Generate typechain for pool contract
+    return poolContract.drawdown(drawdownAmount);
+}
+exports.drawdownFromPool = drawdownFromPool;
+async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount) {
+    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    // TODO: Generate typechain for pool contract
+    return poolContract.makePayment(await signer.getAddress(), paymentAmount);
+}
+exports.makePaymentToPool = makePaymentToPool;
 //# sourceMappingURL=PoolContractHelper.js.map

package/dist/cjs/helpers/PoolContractHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAGA,oCAAmD;AAEnD;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAIA,oCAAmD;AAEnD;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC;AAED,SAAgB,gBAAgB,CAC9B,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B;IAE5B,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AAC9C,CAAC;AAfD,4CAeC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B;IAE3B,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAA;AAC3E,CAAC;AAfD,8CAeC"}

package/dist/cjs/services/ARWeaveService.d.ts

@@ -1,7 +1,5 @@
 import { FundResponse, UploadResponse } from '@bundlr-network/client/build/common/types';
 import { Web3Provider } from '@ethersproject/providers';
-import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
-import { BigNumber } from 'ethers';
 /**
  * The configuration for Bundlr network instances
  *
@@ -38,18 +36,6 @@ export declare function getBundlrNetworkConfig(chainId: number): BundlrConfig;
  * @returns {Promise<FundResponse>} - The fund response.
  */
 declare function prefundBundlr(config: BundlrConfig, signer: any, amount: number): Promise<FundResponse>;
-/**
- * Get the running balance on Bundlr network, in atomic units (the smallest unit of a given currency)
- *
- * @async
- * @function
- * @memberof ArweaveService
- * @param {BundlrConfig} config - The configuration for the Bundlr network.
- * @param {any} signer - The wallet to send funds from. This can be either a web3 signer or a private key string.
- * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config.
- * @returns {Promise<FundResponse>} - The fund response.
- */
-declare function getBundlrBalance(config: BundlrConfig, signer: any): Promise<BigNumber>;
 /**
  * Store data on ARWeave using the Bundlr Network.
  *
@@ -77,19 +63,16 @@ declare function storeData(config: BundlrConfig, signerOrPrivateKey: Web3Provide
  * @function
  * @memberof ArweaveService
  * @param {number} chainId - The chain ID.
- * @param {POOL_NAME} poolName - The pool name tag to query.
- * @param {POOL_TYPE} poolType - The pool type tag to query.
  * @param {string} sender - The sender tag to query.
  * @param {string} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
  * @returns {Promise<any>} Promise resolving with the queried data.
  */
-declare function queryForMetadata(chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, sender: string, referenceId: string): Promise<string | null>;
+declare function queryForMetadata(chainId: number, sender: string, referenceId: string): Promise<string | null>;
 /**
  * An object that contains functions to interact with Huma-related data stored on ARWeave
  * @namespace ARWeaveService
  */
 export declare const ARWeaveService: {
-    getBundlrBalance: typeof getBundlrBalance;
     queryForMetadata: typeof queryForMetadata;
     storeData: typeof storeData;
     prefundBundlr: typeof prefundBundlr;