@ar.io/sdk 2.2.1 → 2.2.2-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/LICENSE.md +201 -661
  2. package/README.md +32 -0
  3. package/bundles/web.bundle.min.js +143 -139
  4. package/lib/cjs/common/ant-registry.js +10 -11
  5. package/lib/cjs/common/ant.js +10 -11
  6. package/lib/cjs/common/arweave.js +10 -11
  7. package/lib/cjs/common/contracts/ao-process.js +10 -11
  8. package/lib/cjs/common/error.js +10 -11
  9. package/lib/cjs/common/index.js +10 -11
  10. package/lib/cjs/common/logger.js +10 -11
  11. package/lib/cjs/constants.js +10 -11
  12. package/lib/cjs/node/index.js +11 -12
  13. package/lib/cjs/token.js +10 -11
  14. package/lib/cjs/types.js +10 -11
  15. package/lib/cjs/utils/ao.js +11 -12
  16. package/lib/cjs/utils/base64.js +10 -11
  17. package/lib/cjs/utils/http-client.js +10 -11
  18. package/lib/cjs/utils/index.js +10 -11
  19. package/lib/cjs/utils/json.js +10 -11
  20. package/lib/cjs/utils/processes.js +10 -11
  21. package/lib/cjs/version.js +11 -12
  22. package/lib/cjs/web/index.js +11 -12
  23. package/lib/esm/common/ant-registry.js +10 -11
  24. package/lib/esm/common/ant.js +10 -11
  25. package/lib/esm/common/arweave.js +10 -11
  26. package/lib/esm/common/contracts/ao-process.js +10 -11
  27. package/lib/esm/common/error.js +10 -11
  28. package/lib/esm/common/index.js +10 -11
  29. package/lib/esm/common/logger.js +10 -11
  30. package/lib/esm/constants.js +10 -11
  31. package/lib/esm/node/index.js +11 -12
  32. package/lib/esm/token.js +10 -11
  33. package/lib/esm/types.js +10 -11
  34. package/lib/esm/utils/ao.js +11 -12
  35. package/lib/esm/utils/base64.js +10 -11
  36. package/lib/esm/utils/http-client.js +10 -11
  37. package/lib/esm/utils/index.js +10 -11
  38. package/lib/esm/utils/json.js +10 -11
  39. package/lib/esm/utils/processes.js +10 -11
  40. package/lib/esm/version.js +11 -12
  41. package/lib/esm/web/index.js +11 -12
  42. package/lib/types/common/ant.d.ts +10 -11
  43. package/lib/types/common/arweave.d.ts +10 -11
  44. package/lib/types/common/error.d.ts +10 -11
  45. package/lib/types/common/index.d.ts +10 -11
  46. package/lib/types/common/io.d.ts +10 -11
  47. package/lib/types/common.d.ts +11 -12
  48. package/lib/types/constants.d.ts +10 -11
  49. package/lib/types/io.d.ts +10 -11
  50. package/lib/types/node/index.d.ts +11 -12
  51. package/lib/types/types.d.ts +10 -11
  52. package/lib/types/utils/arweave.d.ts +10 -11
  53. package/lib/types/utils/http-client.d.ts +10 -11
  54. package/lib/types/utils/index.d.ts +10 -11
  55. package/lib/types/utils/json.d.ts +10 -11
  56. package/lib/types/utils/processes.d.ts +10 -11
  57. package/lib/types/version.d.ts +11 -12
  58. package/lib/types/web/index.d.ts +11 -12
  59. package/package.json +3 -3
package/README.md CHANGED
@@ -70,6 +70,11 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
70
70
  - [Logging](#logging)
71
71
  - [Configuration](#configuration-2)
72
72
  - [Pagination](#pagination)
73
+ - [Resources](#resources)
74
+ - [Bundling](#bundling)
75
+ - [Gateways](#gateways)
76
+ - [Running a Gateway](#running-a-gateway)
77
+ - [AO](#ao)
73
78
  - [Developers](#developers)
74
79
  - [Requirements](#requirements)
75
80
  - [Setup & Build](#setup--build)
@@ -1338,6 +1343,29 @@ while (hasMore) {
1338
1343
  }
1339
1344
  ```
1340
1345
 
1346
+ ## Resources
1347
+
1348
+ ### Bundling
1349
+
1350
+ For [ANS-104] bundling compatible with ar.io gateways, we recommend using [turbo-sdk](https://github.com/ardriveapp/turbo-sdk). Turbo SDK provides efficient and reliable methods for creating and uploading data bundles to the Arweave network, which are fully compatible with ar.io gateways. Turbo supports fiat and crypto bundling and uploading with a focus on ease of use and reliability.
1351
+
1352
+ ### Gateways
1353
+
1354
+ ### Running a Gateway
1355
+
1356
+ To run your own ar.io gateway, you can refer to the following resources:
1357
+
1358
+ - [ar-io-node repository]: This repository contains the source code and instructions for setting up and running an ar.io gateway node.
1359
+ - [ar.io Gateway Documentation]: This comprehensive guide provides detailed information on gateway setup, configuration, and management.
1360
+
1361
+ Running your own gateway allows you to participate in the ar.io network, serve Arweave data, and potentially earn rewards. Make sure to follow the official documentation for the most up-to-date and accurate information on gateway operation.
1362
+
1363
+ ### AO
1364
+
1365
+ This library integrates with [AO], a decentralized compute platform built on Arweave. We utilize [AO Connect] to interact with AO processes and messages. This integration allows for seamless communication with the AO network, enabling developers to leverage decentralized computation and storage capabilities in their applications.
1366
+
1367
+ For more information on how to use AO and AO Connect within this library, please refer to our documentation and examples.
1368
+
1341
1369
  ## Developers
1342
1370
 
1343
1371
  ### Requirements
@@ -1389,3 +1417,7 @@ For more information on how to contribute, please see [CONTRIBUTING.md].
1389
1417
  [IO testnet process]: https://www.ao.link/#/entity/agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA
1390
1418
  [IO Network spec]: https://github.com/ar-io/ar-io-network-process?tab=readme-ov-file#contract-spec
1391
1419
  [Winston]: https://www.npmjs.com/package/winston
1420
+ [AO]: https://github.com/permaweb/ao
1421
+ [ar-io-node repository]: https://github.com/ar-io/ar-io-node
1422
+ [ar.io Gateway Documentation]: https://docs.ar.io/gateways/ar-io-node/overview/
1423
+ [ANS-104]: https://github.com/ArweaveTeam/arweave-standards/blob/master/ans/ANS-104.md