@huma-finance/sdk 0.0.30 → 0.0.32

package/API.md

@@ -11,8 +11,8 @@
 <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>
-<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="#ReceivableService">ReceivableService</a> : <code>object</code></dt>
+<dd><p>An object that contains functions to interact with Huma's receivables.</p></dd>
 </dl>
 
 ## Functions
@@ -166,15 +166,164 @@ in Huma's pools that can be drawn down by the borrower.</p>
 **Kind**: global namespace  
 
 * [ReceivableService](#ReceivableService) : <code>object</code>
+    * [.getTokenIdByARWeaveId(signer, arweaveId)](#ReceivableService.getTokenIdByARWeaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&gt;</code>
+    * [.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts])](#ReceivableService.declareReceivablePaymentByReferenceId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts])](#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>
+    * [.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType)](#ReceivableService.loadReceivablesOfOwnerWithMetadata) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code>
+    * [.getTokenIdByARWeaveId(signer, arweaveId)](#ReceivableService.getTokenIdByARWeaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&gt;</code>
     * [.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts])](#ReceivableService.declareReceivablePaymentByReferenceId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
     * [.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts])](#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>
+    * [.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType)](#ReceivableService.loadReceivablesOfOwnerWithMetadata) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code>
+
+<a name="ReceivableService.getTokenIdByARWeaveId"></a>
+
+### ReceivableService.getTokenIdByARWeaveId(signer, arweaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&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;(string\|null\|undefined)&gt;</code> - <ul>
+<li>Either the token Id or null if no token was found.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to lookup metadata uploads for</p> |
+| arweaveId | <code>string</code> | <p>The internal ARWeave identifier to lookup a token by</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByReferenceId"></a>
+
+### ReceivableService.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByTokenId"></a>
+
+### ReceivableService.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</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>Record.&lt;string, any&gt;</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="ReceivableService.loadReceivablesOfOwnerWithMetadata"></a>
+
+### ReceivableService.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&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;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code> - <ul>
+<li>An array of receivables owned by the owner for the pool.</li>
+</ul>  
+
+| Param | Type | 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> |
+| owner | <code>string</code> | <p>The receivable token owner to query from.</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> |
+
+<a name="ReceivableService.getTokenIdByARWeaveId"></a>
+
+### ReceivableService.getTokenIdByARWeaveId(signer, arweaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&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;(string\|null\|undefined)&gt;</code> - <ul>
+<li>Either the token Id or null if no token was found.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to lookup metadata uploads for</p> |
+| arweaveId | <code>string</code> | <p>The internal ARWeave identifier to lookup a token by</p> |
 
 <a name="ReceivableService.declareReceivablePaymentByReferenceId"></a>
 
 ### ReceivableService.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts]) ⇒ <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>
+<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>
@@ -191,7 +340,7 @@ in Huma's pools that can be drawn down by the borrower.</p>
 <a name="ReceivableService.declareReceivablePaymentByTokenId"></a>
 
 ### ReceivableService.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
-<p>Declares a payment on a RealWorldReceivable given a tokenID of the receivable.</p>
+<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>
@@ -207,7 +356,7 @@ in Huma's pools that can be drawn down by the borrower.</p>
 | 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> |
+| 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> |
 | [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
 
@@ -252,19 +401,36 @@ in Huma's pools that can be drawn down by the borrower.</p>
 | --- | --- | --- | --- |
 | 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> |
+| 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> |
+| metadata | <code>Record.&lt;string, any&gt;</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="ReceivableService.loadReceivablesOfOwnerWithMetadata"></a>
+
+### ReceivableService.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&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;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code> - <ul>
+<li>An array of receivables owned by the owner for the pool.</li>
+</ul>  
+
+| Param | Type | 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> |
+| owner | <code>string</code> | <p>The receivable token owner to query from.</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> |
+
 <a name="SubgraphService"></a>
 
 ## SubgraphService : <code>object</code>
@@ -320,12 +486,279 @@ in Huma's pools that can be drawn down by the borrower.</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="ARWeaveService"></a>
+<a name="ReceivableService"></a>
 
-## ARWeaveService : <code>object</code>
-<p>An object that contains functions to interact with Huma-related data stored on ARWeave</p>
+## 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>
+    * [.getTokenIdByARWeaveId(signer, arweaveId)](#ReceivableService.getTokenIdByARWeaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&gt;</code>
+    * [.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts])](#ReceivableService.declareReceivablePaymentByReferenceId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts])](#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>
+    * [.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType)](#ReceivableService.loadReceivablesOfOwnerWithMetadata) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code>
+    * [.getTokenIdByARWeaveId(signer, arweaveId)](#ReceivableService.getTokenIdByARWeaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&gt;</code>
+    * [.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts])](#ReceivableService.declareReceivablePaymentByReferenceId) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+    * [.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts])](#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>
+    * [.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType)](#ReceivableService.loadReceivablesOfOwnerWithMetadata) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code>
+
+<a name="ReceivableService.getTokenIdByARWeaveId"></a>
+
+### ReceivableService.getTokenIdByARWeaveId(signer, arweaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&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;(string\|null\|undefined)&gt;</code> - <ul>
+<li>Either the token Id or null if no token was found.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to lookup metadata uploads for</p> |
+| arweaveId | <code>string</code> | <p>The internal ARWeave identifier to lookup a token by</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByReferenceId"></a>
+
+### ReceivableService.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByTokenId"></a>
+
+### ReceivableService.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</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>Record.&lt;string, any&gt;</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="ReceivableService.loadReceivablesOfOwnerWithMetadata"></a>
+
+### ReceivableService.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&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;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code> - <ul>
+<li>An array of receivables owned by the owner for the pool.</li>
+</ul>  
+
+| Param | Type | 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> |
+| owner | <code>string</code> | <p>The receivable token owner to query from.</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> |
+
+<a name="ReceivableService.getTokenIdByARWeaveId"></a>
+
+### ReceivableService.getTokenIdByARWeaveId(signer, arweaveId) ⇒ <code>Promise.&lt;(string\|null\|undefined)&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;(string\|null\|undefined)&gt;</code> - <ul>
+<li>Either the token Id or null if no token was found.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to lookup metadata uploads for</p> |
+| arweaveId | <code>string</code> | <p>The internal ARWeave identifier to lookup a token by</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByReferenceId"></a>
+
+### ReceivableService.declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="ReceivableService.declareReceivablePaymentByTokenId"></a>
+
+### ReceivableService.declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, [gasOpts]) ⇒ <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> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</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>Record.&lt;string, any&gt;</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="ReceivableService.loadReceivablesOfOwnerWithMetadata"></a>
+
+### ReceivableService.loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType) ⇒ <code>Promise.&lt;Array.&lt;RealWorldReceivableInfo&gt;&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;Array.&lt;RealWorldReceivableInfo&gt;&gt;</code> - <ul>
+<li>An array of receivables owned by the owner for the pool.</li>
+</ul>  
+
+| Param | Type | 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> |
+| owner | <code>string</code> | <p>The receivable token owner to query from.</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> |
+
 <a name="defaultWrapper"></a>
 
 ## defaultWrapper()

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

@@ -59,13 +59,13 @@ declare function prefundBundlr(config: BundlrConfig, signer: string, amount: num
  * @param {Web3Provider | string} signerOrPrivateKey - Wallet object used for interacting with the Bundlr instance.
  *         If calling from a browser, this should be a `Web3Provider` instance. If calling from a Node.js
  *         environment, this should be a private key string.
- * @param {JSON} data - The data to store in the Bundlr instance.
+ * @param {Record<string, unknown>} data - The data to store in the Bundlr instance.
  * @param {Array<{ name: string, value: string }>} tags - Array of tag objects with `name` and `value` properties.
  * @param {boolean} [lazyFund=true] - Optional flag to fund the Bundlr instance lazily. If set to `false`, the
  *        Bundlr node should already be funded or else uploads will fail.
  * @returns {Promise<UploadResponse>} Promise resolving with the upload response.
  */
-declare function storeData(config: BundlrConfig, signerOrPrivateKey: Web3Provider | string, data: JSON, tags: {
+declare function storeData(config: BundlrConfig, signerOrPrivateKey: Web3Provider | string, data: Record<string, unknown>, tags: {
     name: string;
     value: string;
 }[], lazyFund?: boolean): Promise<UploadResponse>;
@@ -81,6 +81,16 @@ declare function storeData(config: BundlrConfig, signerOrPrivateKey: Web3Provide
  * @returns {Promise<any>} Promise resolving with the queried data.
  */
 declare function queryForMetadata(chainId: number, sender: string, referenceId: string): Promise<string | null>;
+/**
+ * Helper method to fetch data from an ARWeave URL.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {string} url - The ARWeave metadata URL to query.
+ * @returns {Promise<JSON>} Promise resolving with the queried data.
+ */
+declare function fetchMetadataFromUrl(url: string): Promise<JSON | null>;
 /**
  * An object that contains functions to interact with Huma-related data stored on ARWeave
  * @namespace ARWeaveService
@@ -91,5 +101,6 @@ export declare const ARWeaveService: {
     prefundBundlr: typeof prefundBundlr;
     getBundlrNetworkConfig: typeof getBundlrNetworkConfig;
     getBundlrInstance: typeof getBundlrInstance;
+    fetchMetadataFromUrl: typeof fetchMetadataFromUrl;
 };
 export {};

package/dist/cjs/services/ARWeaveService.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ARWeaveService = exports.getBundlrNetworkConfig = void 0;
 const tslib_1 = require("tslib");
 const client_1 = tslib_1.__importDefault(require("@bundlr-network/client"));
+const axios_1 = tslib_1.__importDefault(require("axios"));
 const graphql_request_1 = tslib_1.__importStar(require("graphql-request"));
 /**
  * Get the configuration for Bundlr network given a chain ID
@@ -94,7 +95,7 @@ signer, amount) {
  * @param {Web3Provider | string} signerOrPrivateKey - Wallet object used for interacting with the Bundlr instance.
  *         If calling from a browser, this should be a `Web3Provider` instance. If calling from a Node.js
  *         environment, this should be a private key string.
- * @param {JSON} data - The data to store in the Bundlr instance.
+ * @param {Record<string, unknown>} data - The data to store in the Bundlr instance.
  * @param {Array<{ name: string, value: string }>} tags - Array of tag objects with `name` and `value` properties.
  * @param {boolean} [lazyFund=true] - Optional flag to fund the Bundlr instance lazily. If set to `false`, the
  *        Bundlr node should already be funded or else uploads will fail.
@@ -156,6 +157,25 @@ async function queryForMetadata(chainId, sender, referenceId) {
     });
     return (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.transactions) === null || _a === void 0 ? void 0 : _a.edges) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.node) === null || _d === void 0 ? void 0 : _d.id;
 }
+/**
+ * Helper method to fetch data from an ARWeave URL.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {string} url - The ARWeave metadata URL to query.
+ * @returns {Promise<JSON>} Promise resolving with the queried data.
+ */
+async function fetchMetadataFromUrl(url) {
+    try {
+        const response = await axios_1.default.get(url);
+        return response.data;
+    }
+    catch (error) {
+        console.error('Error fetching data:', error);
+        return null;
+    }
+}
 /**
  * An object that contains functions to interact with Huma-related data stored on ARWeave
  * @namespace ARWeaveService
@@ -166,5 +186,6 @@ exports.ARWeaveService = {
     prefundBundlr,
     getBundlrNetworkConfig,
     getBundlrInstance,
+    fetchMetadataFromUrl,
 };
 //# sourceMappingURL=ARWeaveService.js.map