@iota/graphql-transport 0.0.0-dev-20251015065834

package/CHANGELOG.md

@@ -0,0 +1,248 @@
+# @iota/graphql-transport
+
+## 0.0.0-dev-20251015065834
+
+### Minor Changes
+
+-   a0b225d: Support the new node method `isTransactionIndexedOnNode`
+-   4c68076: Sync with Node changes.
+-   92dd15e: Add a new `waitMode` in `waitForTransaction`
+
+### Patch Changes
+
+-   c12d044: Internal simplification of the codegen
+-   58997cb: map Option correctly in moveDataToRpcContent
+-   Updated dependencies [c12d044]
+-   Updated dependencies [a0b225d]
+-   Updated dependencies [4c68076]
+-   Updated dependencies [92dd15e]
+    -   @iota/iota-sdk@0.0.0-dev-20251015065834
+
+## 0.9.2
+
+### Patch Changes
+
+-   Updated dependencies [3244c29]
+    -   @iota/iota-sdk@1.6.1
+
+## 0.9.1
+
+### Patch Changes
+
+-   Updated dependencies [c5543f0]
+-   Updated dependencies [bd17ba9]
+-   Updated dependencies [0accdb0]
+    -   @iota/iota-sdk@1.6.0
+
+## 0.9.0
+
+### Minor Changes
+
+-   61b0944: Added support for WrappedOrDeletedObject in TransactionBlockFilter
+-   464c15a: Sync the APIs with the "Domain" -> "Name" rename of IotaNames
+
+### Patch Changes
+
+-   Updated dependencies [40576ed]
+-   Updated dependencies [61b0944]
+-   Updated dependencies [966f83c]
+-   Updated dependencies [f008db3]
+-   Updated dependencies [733df30]
+-   Updated dependencies [13ca264]
+-   Updated dependencies [5bbafa8]
+-   Updated dependencies [28ce666]
+-   Updated dependencies [c855f8c]
+-   Updated dependencies [f008db3]
+-   Updated dependencies [464c15a]
+    -   @iota/iota-sdk@1.5.0
+    -   @iota/bcs@1.2.0
+
+## 0.8.0
+
+### Minor Changes
+
+-   ecea738: Improved logic around `fallbackMethods` in graphql-transport Introduced
+    `unsupportedMethods` in graphql-transport Improved IotaClient compatibility with
+    graphql-transport
+
+### Patch Changes
+
+-   ecea738: Added missing GraphQL query option fields.
+-   59342b2: Renamed all instances of 'domain' to 'name' for IOTA-Names.
+-   Updated dependencies [f04033d]
+-   Updated dependencies [f04033d]
+-   Updated dependencies [59342b2]
+-   Updated dependencies [f04033d]
+-   Updated dependencies [f04033d]
+-   Updated dependencies [ecea738]
+    -   @iota/iota-sdk@1.4.0
+    -   @iota/bcs@1.1.0
+
+## 0.7.0
+
+### Minor Changes
+
+-   c837b79: Removed support for iota-bridge
+
+### Patch Changes
+
+-   Updated dependencies [6051799]
+-   Updated dependencies [5db9797]
+-   Updated dependencies [c4c6d9a]
+-   Updated dependencies [c837b79]
+    -   @iota/iota-sdk@1.3.0
+
+## 0.6.0
+
+### Minor Changes
+
+-   53d5058: Added iota names rpc methods to IotaClient and also GraphQL queries.
+
+### Patch Changes
+
+-   Updated dependencies [53d5058]
+    -   @iota/iota-sdk@1.2.0
+
+## 0.5.2
+
+### Patch Changes
+
+-   Updated dependencies [acc502a]
+-   Updated dependencies [1128809]
+    -   @iota/iota-sdk@1.1.0
+
+## 0.5.1
+
+### Patch Changes
+
+-   Updated dependencies [26cf13b]
+    -   @iota/iota-sdk@1.0.1
+
+## 0.5.0
+
+### Minor Changes
+
+-   864fd32: Rename `getLatestIotaSystemState` to `getLatestIotaSystemStateV1` and add a new
+    backwards-compatible and future-proof `getLatestIotaSystemState` method that dynamically calls
+    ``getLatestIotaSystemStateV1`or`getLatestIotaSystemStateV2` based on the protocol version of the
+    node.
+
+### Patch Changes
+
+-   f5d40a4: Added type mapping for consensus_gc_depth field of ProtocolConfig
+-   Updated dependencies [f4d75c7]
+-   Updated dependencies [daa968f]
+-   Updated dependencies [864fd32]
+    -   @iota/iota-sdk@1.0.0
+    -   @iota/bcs@1.0.0
+
+## 0.4.0
+
+### Minor Changes
+
+-   bdb736e: Update clients after RPC updates to base64
+
+### Patch Changes
+
+-   1ad39f9: Update dependencies
+-   Updated dependencies [42898f1]
+-   Updated dependencies [1ad39f9]
+-   Updated dependencies [bdb736e]
+-   Updated dependencies [65a0900]
+    -   @iota/iota-sdk@0.7.0
+
+## 0.3.0
+
+### Minor Changes
+
+-   1a4505b: Update clients to support committee selection protocol changes
+-   e629a39: Aligns the Typescript SDK for the "fixed gas price" protocol changes:
+
+    -   Add typing support for IotaChangeEpochV2 (computationCharge, computationChargeBurned).
+    -   Add Typescript SDK client support for versioned IotaSystemStateSummary.
+
+### Patch Changes
+
+-   Updated dependencies [1a4505b]
+-   Updated dependencies [e629a39]
+-   Updated dependencies [2717145]
+-   Updated dependencies [3fe0747]
+-   Updated dependencies [e213517]
+    -   @iota/iota-sdk@0.6.0
+
+## 0.2.4
+
+### Patch Changes
+
+-   Updated dependencies [6e00091]
+    -   @iota/iota-sdk@0.5.0
+
+## 0.2.3
+
+### Patch Changes
+
+-   Updated dependencies [5214d28]
+    -   @iota/iota-sdk@0.4.1
+
+## 0.2.2
+
+### Patch Changes
+
+-   Updated dependencies [9864dcb]
+    -   @iota/iota-sdk@0.4.0
+
+## 0.2.1
+
+### Patch Changes
+
+-   220fa7a: First public release.
+-   Updated dependencies [220fa7a]
+    -   @iota/bcs@0.2.1
+    -   @iota/iota-sdk@0.3.1
+
+## 0.2.0
+
+### Minor Changes
+
+-   6eabd18: Changes for compatibility with the node, simplification of exposed APIs and general
+    improvements.
+
+### Patch Changes
+
+-   Updated dependencies [6eabd18]
+    -   @iota/bcs@0.2.0
+    -   @iota/iota-sdk@0.3.0
+
+## 0.1.2
+
+### Patch Changes
+
+-   d423314: Sync API changes:
+
+    -   restore extended api metrics endpoints
+    -   remove nameservice endpoints
+
+-   b91a3d5: Update auto-generated files to latest IotaGenesisTransaction event updates
+-   Updated dependencies [d423314]
+-   Updated dependencies [b91a3d5]
+-   Updated dependencies [a3c1937]
+    -   @iota/iota-sdk@0.2.0
+
+## 0.1.1
+
+### Patch Changes
+
+-   Updated dependencies [4a4ba5a]
+    -   @iota/iota-sdk@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+-   249a7d0: First release
+
+### Patch Changes
+
+-   Updated dependencies [249a7d0]
+    -   @iota/bcs@0.1.0
+    -   @iota/iota-sdk@0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# `@iota/graphql-transport`
+
+`@iota/graphql-transport` is part of the **IOTA Rebased SDK**, designed specifically for interacting with the IOTA Rebased protocol.
+
+This package provides a `IotaTransport` that enables `IotaClient` to make requests using the RPC 2.0
+(GraphQL) API instead of the JSON RPC API.
+
+## Install
+
+```bash
+npm install --save @iota/graphql-transport
+```
+
+## Setup
+
+```ts
+import { IotaClientGraphQLTransport } from '@iota/graphql-transport';
+import { getFullnodeUrl, IotaClient } from '@iota/iota-sdk/client';
+
+const client = new IotaClient({
+    transport: new IotaClientGraphQLTransport({
+        url: 'https://iota-testnet.iota.org/graphql',
+        // When specified, the transport will fallback to JSON RPC for unsupported method and parameters
+        fallbackFullNodeUrl: getFullnodeUrl('testnet'),
+    }),
+});
+```
+
+## Limitations
+
+### Unsupported methods
+
+The following methods are currently unsupported in IotaClientGraphQLTransport, and will either
+error, or fallback to the JSON RPC API if a `fallbackFullNodeUrl` is provided:
+
+- `subscribeTransaction`
+- `subscribeEvents`
+- `call`
+- `getNetworkMetrics`
+- `getMoveCallMetrics`
+- `getAddressMetrics`
+- `getEpochs`
+- `dryRunTransactionBlock`
+- `devInspectTransactionBlock`
+- `executeTransactionBlock`
+- `getParticipationMetrics`
+- `getCirculatingSupply`
+
+### Unsupported parameters
+
+Some supported methods in `IotaClientGraphQLTransport` do not support the full set of parameters
+available in the JSON RPC API.
+
+If an unsupported parameter is used, the request will error, or fallback to JSON RPC API if a
+`fallbackFullNodeUrl` is provided.
+
+- `getOwnedObjects`:
+  - missing the `MatchAll`, `MatchAny`, `MatchNone`, and `Version` filters
+- `queryEvents`:
+  - missing the `MoveEventField`, `Module`, `TimeRange`, `All`, `Any`, `And`, and `Or` filters
+
+### Unsupported fields
+
+- `queryTransactionBlocks`, `getTransactionBlock`, and `multiGetTransactionBlocks`
+  - missing `messageVersion`, `eventsDigest`, `sharedObjects`, `unwrapped`, `wrapped`, and
+    `unwrappedThenDeleted` in effects
+  - missing `id` for `events`
+- `getStakes` and `getStakesByIds`
+  - missing `validatorAddress`
+- `getLatestIotaSystemState` and `getLatestIotaSystemStateV2`
+  - missing `stakingPoolMappingsId`, `inactivePoolsId`, `pendingActiveValidatorsId`,
+    `validatorCandidatesId`
+  - missing `reportRecords` on validators
+- `getCurrentEpoch`
+  - missing `reportRecords` on validators
+- `queryEvents`
+  - missing `id` for `events`
+- `getCheckpoint` and `getCheckpoints`
+  - missing `checkpointCommitments`
+- `getCurrentEpoch`
+  - missing `epochTotalTransactions`
+- `getDynamicFields`
+  - missing `objectId`, `digest` and `version` available for `DynamicObject` but not
+    `DynamicField`
+
+### Performance
+
+Some may require multiple requests to properly resolve:
+
+- `getDynamicFieldObject` requires 2 requests
+- `queryTransactionBlocks`, `getTransactionBlock`, and `multiGetTransactionBlocks`
+  - may require additional requests to load all `objectChanges`, `balanceChanges`,
+    `dependencies` and `events`
+- `getNormalizedMoveModule` and `getNormalizedMoveModulesByPage`
+  - may require additional requests to load all `friends`, `functions`, and `structs`
+- `getCheckpoint` and `getCheckpoints`,
+  - may require additional requests to load all `transactionBlocks` and `validators`
+- `getLatestIotaSystemState`,`getLatestIotaSystemStateV2`, `getCurrentEpoch`, `getValidatorsApy` and `getCommitteeInfo`:
+  - may require additional requests to load all `validators`
+
+### Pagination
+
+Page sizes and limits for paginated methods are based on the defaults and limits of the GraphQL API,
+so page sizes and limits may be different than those returned by the JSON RPC API