chore: Dependency update

.eslintrc.js

@@ -1261,6 +1261,9 @@ module.exports = {
         "unicorn/prefer-modern-dom-apis": [
             "error"
         ],
+        "unicorn/prefer-module": [
+            "off"
+        ],
         "unicorn/prefer-negative-index": [
             "error"
         ],

.github/workflows/codeql-analysis.yml

@@ -3,7 +3,8 @@ name: "CodeQL"
 on:
   push:
     branches:
-      - feature/chrysalis-pt2
+      - main
+      - develop
     paths:
       - 'src/**'
       - '.github/codeql/**'

.github/workflows/chrysalis-pt2.yml → .github/workflows/main.yml

@@ -1,16 +1,16 @@
-name: Client Build Chrysalis Pt 2
+name: Library Build Main/Develop
 
 on:
   push:
-    branches: [chrysalis]
+    branches: [main]
     paths:
       - "src/**"
-      - ".github/workflows/chrysalis-pt2.yml"
+      - ".github/workflows/main.yml"
   pull_request:
-    branches: [chrysalis]
+    branches: [develop]
     paths:
       - "src/**"
-      - ".github/workflows/chrysalis-pt2.yml"
+      - ".github/workflows/develop.yml"
 
 
 jobs:

README.md

@@ -3,7 +3,7 @@
 <p align="center">
   <a href="https://discord.iota.org/" style="text-decoration:none;"><img src="https://img.shields.io/badge/Discord-9cf.svg?logo=discord" alt="Discord"></a>
     <a href="https://iota.stackexchange.com/" style="text-decoration:none;"><img src="https://img.shields.io/badge/StackExchange-9cf.svg?logo=stackexchange" alt="StackExchange"></a>
-    <a href="https://github.com/iotaledger/iota.js/blob/master/LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/github/license/iotaledger/iota.js.svg" alt="Apache-2.0 license"></a>
+    <a href="https://github.com/iotaledger/iota.js/blob/main/LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/github/license/iotaledger/iota.js.svg" alt="Apache-2.0 license"></a>
 </p>
       
 <p align="center">
@@ -24,7 +24,7 @@
 
 > This library is functionally complete, but it is recommended to use [iota.rs](https://github.com/iotaledger/iota.rs). The rust library will be more heavily maintained and is much more performant.
 
-Client library for IOTA Chrysalis network, implemeted in TypeScript to strongly type the objects sent and received from the API.
+Client library for IOTA network, implemeted in TypeScript to strongly type the objects sent and received from the API.
 
 Also includes High Level operations and MQTT support.
 
@@ -33,7 +33,7 @@ Runs in both NodeJS and Browser environments.
 ## Prerequisites
 
 ```shell
-npm install iotaledger/iota.js#chrysalis
+npm install @iota/iota.js
 ```
 
 ## Example
@@ -42,7 +42,7 @@ npm install iotaledger/iota.js#chrysalis
 const { SingleNodeClient } = require("@iota/iota.js");
 
 async function run() {
-    const client = new SingleNodeClient("http://localhost:14265");
+    const client = new SingleNodeClient("https://chrysalis-nodes.iota.org");
 
     const info = await client.info();
     console.log("Node Info");
@@ -127,12 +127,12 @@ You can see the model definitions for all the objects in the [typings](./typings
 
 ## Proof of Work
 
-A very simple local proof of work provider [./localPowProvider](./src/pow/localPowProvider.ts) is implemented but not used by default.
+A very simple local proof of work provider [./localPowProvider](./src/pow/localPowProvider.ts) is implemented but not used by default, it is recommended to use remote PoW with this library.
 The example is included for reference purposes, but should not be used as it is very slow.
 You can experiment using it or any other PoW implementation by passing it in the options parameter of the SingleNodeClient constructor.
 
 ```js
-const client = new SingleNodeClient("http://localhost:14265", { powProvider: new LocalPowProvider() });
+const client = new SingleNodeClient("https://chrysalis-nodes.iota.org", { powProvider: new LocalPowProvider() });
 ```
 
 ## Additional Examples
@@ -155,4 +155,4 @@ See our [contributing guidelines](.github/CONTRIBUTING.md) for more information.
 
 ## Joining the discussion
 
-If you want to get involved in the community, need help with getting set up, have any issues or just want to discuss IOTA, Distributed Registry Technology (DRT), and IoT with other people, feel free to join our [Discord](https://discord.iota.org/).
+If you want to get involved in the community, need help with getting set up, have any issues or just want to discuss IOTA, feel free to join our [Discord](https://discord.iota.org/).

docs/README.md

@@ -1,118 +1,120 @@
-@iota/iota.js
+**[@iota/iota.js](README.md)**
+
+> Globals
 
 # @iota/iota.js
 
-## Table of contents
+## Index
 
 ### Modules
 
-- [addressTypes/ed25519Address](modules/addresstypes_ed25519address.md)
-- [binary/address](modules/binary_address.md)
-- [binary/common](modules/binary_common.md)
-- [binary/funds](modules/binary_funds.md)
-- [binary/input](modules/binary_input.md)
-- [binary/message](modules/binary_message.md)
-- [binary/output](modules/binary_output.md)
-- [binary/payload](modules/binary_payload.md)
-- [binary/signature](modules/binary_signature.md)
-- [binary/transaction](modules/binary_transaction.md)
-- [binary/unlockBlock](modules/binary_unlockblock.md)
-- [clients/clientError](modules/clients_clienterror.md)
-- [clients/mqttClient](modules/clients_mqttclient.md)
-- [clients/singleNodeClient](modules/clients_singlenodeclient.md)
-- [clients/singleNodeClientOptions](modules/clients_singlenodeclientoptions.md)
-- [crypto/bech32](modules/crypto_bech32.md)
-- [crypto/bip32Path](modules/crypto_bip32path.md)
-- [crypto/bip39](modules/crypto_bip39.md)
-- [crypto/blake2b](modules/crypto_blake2b.md)
-- [crypto/curl](modules/crypto_curl.md)
-- [crypto/ed25519](modules/crypto_ed25519.md)
-- [crypto/edwards25519/bigIntCommon](modules/crypto_edwards25519_bigintcommon.md)
-- [crypto/edwards25519/cachedGroupElement](modules/crypto_edwards25519_cachedgroupelement.md)
-- [crypto/edwards25519/completedGroupElement](modules/crypto_edwards25519_completedgroupelement.md)
-- [crypto/edwards25519/const](modules/crypto_edwards25519_const.md)
-- [crypto/edwards25519/extendedGroupElement](modules/crypto_edwards25519_extendedgroupelement.md)
-- [crypto/edwards25519/fieldElement](modules/crypto_edwards25519_fieldelement.md)
-- [crypto/edwards25519/preComputedGroupElement](modules/crypto_edwards25519_precomputedgroupelement.md)
-- [crypto/edwards25519/projectiveGroupElement](modules/crypto_edwards25519_projectivegroupelement.md)
-- [crypto/edwards25519/scalar](modules/crypto_edwards25519_scalar.md)
-- [crypto/hmacSha256](modules/crypto_hmacsha256.md)
-- [crypto/hmacSha512](modules/crypto_hmacsha512.md)
-- [crypto/pbkdf2](modules/crypto_pbkdf2.md)
-- [crypto/sha256](modules/crypto_sha256.md)
-- [crypto/sha512](modules/crypto_sha512.md)
-- [crypto/slip0010](modules/crypto_slip0010.md)
-- [crypto/wordlists/english](modules/crypto_wordlists_english.md)
-- [crypto/zip215](modules/crypto_zip215.md)
-- [encoding/b1t6](modules/encoding_b1t6.md)
-- [highLevel/addresses](modules/highlevel_addresses.md)
-- [highLevel/getBalance](modules/highlevel_getbalance.md)
-- [highLevel/getUnspentAddress](modules/highlevel_getunspentaddress.md)
-- [highLevel/getUnspentAddresses](modules/highlevel_getunspentaddresses.md)
-- [highLevel/promote](modules/highlevel_promote.md)
-- [highLevel/reattach](modules/highlevel_reattach.md)
-- [highLevel/retrieveData](modules/highlevel_retrievedata.md)
-- [highLevel/retry](modules/highlevel_retry.md)
-- [highLevel/send](modules/highlevel_send.md)
-- [highLevel/sendAdvanced](modules/highlevel_sendadvanced.md)
-- [highLevel/sendData](modules/highlevel_senddata.md)
-- [models/IAddress](modules/models_iaddress.md)
-- [models/IBip44GeneratorState](modules/models_ibip44generatorstate.md)
-- [models/IClient](modules/models_iclient.md)
-- [models/IEd25519Address](modules/models_ied25519address.md)
-- [models/IEd25519Signature](modules/models_ied25519signature.md)
-- [models/IGossipHeartbeat](modules/models_igossipheartbeat.md)
-- [models/IGossipMetrics](modules/models_igossipmetrics.md)
-- [models/IIndexationPayload](modules/models_iindexationpayload.md)
-- [models/IKeyPair](modules/models_ikeypair.md)
-- [models/IMessage](modules/models_imessage.md)
-- [models/IMessageMetadata](modules/models_imessagemetadata.md)
-- [models/IMigratedFunds](modules/models_imigratedfunds.md)
-- [models/IMilestonePayload](modules/models_imilestonepayload.md)
-- [models/IMqttClient](modules/models_imqttclient.md)
-- [models/IMqttStatus](modules/models_imqttstatus.md)
-- [models/INodeInfo](modules/models_inodeinfo.md)
-- [models/IPeer](modules/models_ipeer.md)
-- [models/IPowProvider](modules/models_ipowprovider.md)
-- [models/IReceiptPayload](modules/models_ireceiptpayload.md)
-- [models/IReferenceUnlockBlock](modules/models_ireferenceunlockblock.md)
-- [models/ISeed](modules/models_iseed.md)
-- [models/ISigLockedDustAllowanceOutput](modules/models_isiglockeddustallowanceoutput.md)
-- [models/ISigLockedSingleOutput](modules/models_isiglockedsingleoutput.md)
-- [models/ISignatureUnlockBlock](modules/models_isignatureunlockblock.md)
-- [models/ITransactionEssence](modules/models_itransactionessence.md)
-- [models/ITransactionPayload](modules/models_itransactionpayload.md)
-- [models/ITreasury](modules/models_itreasury.md)
-- [models/ITreasuryInput](modules/models_itreasuryinput.md)
-- [models/ITreasuryOutput](modules/models_itreasuryoutput.md)
-- [models/ITreasuryTransactionPayload](modules/models_itreasurytransactionpayload.md)
-- [models/ITypeBase](modules/models_itypebase.md)
-- [models/IUTXOInput](modules/models_iutxoinput.md)
-- [models/api/IAddressOutputsResponse](modules/models_api_iaddressoutputsresponse.md)
-- [models/api/IAddressResponse](modules/models_api_iaddressresponse.md)
-- [models/api/IChildrenResponse](modules/models_api_ichildrenresponse.md)
-- [models/api/IMessageIdResponse](modules/models_api_imessageidresponse.md)
-- [models/api/IMessagesResponse](modules/models_api_imessagesresponse.md)
-- [models/api/IMilestoneResponse](modules/models_api_imilestoneresponse.md)
-- [models/api/IMilestoneUtxoChangesResponse](modules/models_api_imilestoneutxochangesresponse.md)
-- [models/api/IMqttMilestoneResponse](modules/models_api_imqttmilestoneresponse.md)
-- [models/api/IOutputResponse](modules/models_api_ioutputresponse.md)
-- [models/api/IReceiptsResponse](modules/models_api_ireceiptsresponse.md)
-- [models/api/IResponse](modules/models_api_iresponse.md)
-- [models/api/ITipsResponse](modules/models_api_itipsresponse.md)
-- [models/conflictReason](modules/models_conflictreason.md)
-- [models/ledgerInclusionState](modules/models_ledgerinclusionstate.md)
-- [models/units](modules/models_units.md)
-- [pow/localPowProvider](modules/pow_localpowprovider.md)
-- [resources/conflictReasonStrings](modules/resources_conflictreasonstrings.md)
-- [seedTypes/ed25519Seed](modules/seedtypes_ed25519seed.md)
-- [utils/arrayHelper](modules/utils_arrayhelper.md)
-- [utils/bech32Helper](modules/utils_bech32helper.md)
-- [utils/bigIntHelper](modules/utils_biginthelper.md)
-- [utils/converter](modules/utils_converter.md)
-- [utils/logging](modules/utils_logging.md)
-- [utils/powHelper](modules/utils_powhelper.md)
-- [utils/randomHelper](modules/utils_randomhelper.md)
-- [utils/readStream](modules/utils_readstream.md)
-- [utils/unitsHelper](modules/utils_unitshelper.md)
-- [utils/writeStream](modules/utils_writestream.md)
+* ["addressTypes/ed25519Address"](modules/_addresstypes_ed25519address_.md)
+* ["binary/address"](modules/_binary_address_.md)
+* ["binary/common"](modules/_binary_common_.md)
+* ["binary/funds"](modules/_binary_funds_.md)
+* ["binary/input"](modules/_binary_input_.md)
+* ["binary/message"](modules/_binary_message_.md)
+* ["binary/output"](modules/_binary_output_.md)
+* ["binary/payload"](modules/_binary_payload_.md)
+* ["binary/signature"](modules/_binary_signature_.md)
+* ["binary/transaction"](modules/_binary_transaction_.md)
+* ["binary/unlockBlock"](modules/_binary_unlockblock_.md)
+* ["clients/clientError"](modules/_clients_clienterror_.md)
+* ["clients/mqttClient"](modules/_clients_mqttclient_.md)
+* ["clients/singleNodeClient"](modules/_clients_singlenodeclient_.md)
+* ["clients/singleNodeClientOptions"](modules/_clients_singlenodeclientoptions_.md)
+* ["crypto/bech32"](modules/_crypto_bech32_.md)
+* ["crypto/bip32Path"](modules/_crypto_bip32path_.md)
+* ["crypto/bip39"](modules/_crypto_bip39_.md)
+* ["crypto/blake2b"](modules/_crypto_blake2b_.md)
+* ["crypto/curl"](modules/_crypto_curl_.md)
+* ["crypto/ed25519"](modules/_crypto_ed25519_.md)
+* ["crypto/edwards25519/bigIntCommon"](modules/_crypto_edwards25519_bigintcommon_.md)
+* ["crypto/edwards25519/cachedGroupElement"](modules/_crypto_edwards25519_cachedgroupelement_.md)
+* ["crypto/edwards25519/completedGroupElement"](modules/_crypto_edwards25519_completedgroupelement_.md)
+* ["crypto/edwards25519/const"](modules/_crypto_edwards25519_const_.md)
+* ["crypto/edwards25519/extendedGroupElement"](modules/_crypto_edwards25519_extendedgroupelement_.md)
+* ["crypto/edwards25519/fieldElement"](modules/_crypto_edwards25519_fieldelement_.md)
+* ["crypto/edwards25519/preComputedGroupElement"](modules/_crypto_edwards25519_precomputedgroupelement_.md)
+* ["crypto/edwards25519/projectiveGroupElement"](modules/_crypto_edwards25519_projectivegroupelement_.md)
+* ["crypto/edwards25519/scalar"](modules/_crypto_edwards25519_scalar_.md)
+* ["crypto/hmacSha256"](modules/_crypto_hmacsha256_.md)
+* ["crypto/hmacSha512"](modules/_crypto_hmacsha512_.md)
+* ["crypto/pbkdf2"](modules/_crypto_pbkdf2_.md)
+* ["crypto/sha256"](modules/_crypto_sha256_.md)
+* ["crypto/sha512"](modules/_crypto_sha512_.md)
+* ["crypto/slip0010"](modules/_crypto_slip0010_.md)
+* ["crypto/wordlists/english"](modules/_crypto_wordlists_english_.md)
+* ["crypto/zip215"](modules/_crypto_zip215_.md)
+* ["encoding/b1t6"](modules/_encoding_b1t6_.md)
+* ["highLevel/addresses"](modules/_highlevel_addresses_.md)
+* ["highLevel/getBalance"](modules/_highlevel_getbalance_.md)
+* ["highLevel/getUnspentAddress"](modules/_highlevel_getunspentaddress_.md)
+* ["highLevel/getUnspentAddresses"](modules/_highlevel_getunspentaddresses_.md)
+* ["highLevel/promote"](modules/_highlevel_promote_.md)
+* ["highLevel/reattach"](modules/_highlevel_reattach_.md)
+* ["highLevel/retrieveData"](modules/_highlevel_retrievedata_.md)
+* ["highLevel/retry"](modules/_highlevel_retry_.md)
+* ["highLevel/send"](modules/_highlevel_send_.md)
+* ["highLevel/sendAdvanced"](modules/_highlevel_sendadvanced_.md)
+* ["highLevel/sendData"](modules/_highlevel_senddata_.md)
+* ["models/IAddress"](modules/_models_iaddress_.md)
+* ["models/IBip44GeneratorState"](modules/_models_ibip44generatorstate_.md)
+* ["models/IClient"](modules/_models_iclient_.md)
+* ["models/IEd25519Address"](modules/_models_ied25519address_.md)
+* ["models/IEd25519Signature"](modules/_models_ied25519signature_.md)
+* ["models/IGossipHeartbeat"](modules/_models_igossipheartbeat_.md)
+* ["models/IGossipMetrics"](modules/_models_igossipmetrics_.md)
+* ["models/IIndexationPayload"](modules/_models_iindexationpayload_.md)
+* ["models/IKeyPair"](modules/_models_ikeypair_.md)
+* ["models/IMessage"](modules/_models_imessage_.md)
+* ["models/IMessageMetadata"](modules/_models_imessagemetadata_.md)
+* ["models/IMigratedFunds"](modules/_models_imigratedfunds_.md)
+* ["models/IMilestonePayload"](modules/_models_imilestonepayload_.md)
+* ["models/IMqttClient"](modules/_models_imqttclient_.md)
+* ["models/IMqttStatus"](modules/_models_imqttstatus_.md)
+* ["models/INodeInfo"](modules/_models_inodeinfo_.md)
+* ["models/IPeer"](modules/_models_ipeer_.md)
+* ["models/IPowProvider"](modules/_models_ipowprovider_.md)
+* ["models/IReceiptPayload"](modules/_models_ireceiptpayload_.md)
+* ["models/IReferenceUnlockBlock"](modules/_models_ireferenceunlockblock_.md)
+* ["models/ISeed"](modules/_models_iseed_.md)
+* ["models/ISigLockedDustAllowanceOutput"](modules/_models_isiglockeddustallowanceoutput_.md)
+* ["models/ISigLockedSingleOutput"](modules/_models_isiglockedsingleoutput_.md)
+* ["models/ISignatureUnlockBlock"](modules/_models_isignatureunlockblock_.md)
+* ["models/ITransactionEssence"](modules/_models_itransactionessence_.md)
+* ["models/ITransactionPayload"](modules/_models_itransactionpayload_.md)
+* ["models/ITreasury"](modules/_models_itreasury_.md)
+* ["models/ITreasuryInput"](modules/_models_itreasuryinput_.md)
+* ["models/ITreasuryOutput"](modules/_models_itreasuryoutput_.md)
+* ["models/ITreasuryTransactionPayload"](modules/_models_itreasurytransactionpayload_.md)
+* ["models/ITypeBase"](modules/_models_itypebase_.md)
+* ["models/IUTXOInput"](modules/_models_iutxoinput_.md)
+* ["models/api/IAddressOutputsResponse"](modules/_models_api_iaddressoutputsresponse_.md)
+* ["models/api/IAddressResponse"](modules/_models_api_iaddressresponse_.md)
+* ["models/api/IChildrenResponse"](modules/_models_api_ichildrenresponse_.md)
+* ["models/api/IMessageIdResponse"](modules/_models_api_imessageidresponse_.md)
+* ["models/api/IMessagesResponse"](modules/_models_api_imessagesresponse_.md)
+* ["models/api/IMilestoneResponse"](modules/_models_api_imilestoneresponse_.md)
+* ["models/api/IMilestoneUtxoChangesResponse"](modules/_models_api_imilestoneutxochangesresponse_.md)
+* ["models/api/IMqttMilestoneResponse"](modules/_models_api_imqttmilestoneresponse_.md)
+* ["models/api/IOutputResponse"](modules/_models_api_ioutputresponse_.md)
+* ["models/api/IReceiptsResponse"](modules/_models_api_ireceiptsresponse_.md)
+* ["models/api/IResponse"](modules/_models_api_iresponse_.md)
+* ["models/api/ITipsResponse"](modules/_models_api_itipsresponse_.md)
+* ["models/conflictReason"](modules/_models_conflictreason_.md)
+* ["models/ledgerInclusionState"](modules/_models_ledgerinclusionstate_.md)
+* ["models/units"](modules/_models_units_.md)
+* ["pow/localPowProvider"](modules/_pow_localpowprovider_.md)
+* ["resources/conflictReasonStrings"](modules/_resources_conflictreasonstrings_.md)
+* ["seedTypes/ed25519Seed"](modules/_seedtypes_ed25519seed_.md)
+* ["utils/arrayHelper"](modules/_utils_arrayhelper_.md)
+* ["utils/bech32Helper"](modules/_utils_bech32helper_.md)
+* ["utils/bigIntHelper"](modules/_utils_biginthelper_.md)
+* ["utils/converter"](modules/_utils_converter_.md)
+* ["utils/logging"](modules/_utils_logging_.md)
+* ["utils/powHelper"](modules/_utils_powhelper_.md)
+* ["utils/randomHelper"](modules/_utils_randomhelper_.md)
+* ["utils/readStream"](modules/_utils_readstream_.md)
+* ["utils/unitsHelper"](modules/_utils_unitshelper_.md)
+* ["utils/writeStream"](modules/_utils_writestream_.md)