ar.io SDK Changelog

Overview

Welcome to the documentation page for the ar.io SDK release notes. Here, you will find detailed information about each version of the ar.io SDK, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the ar.io SDK. For those interested in exploring the source code, each release's code is readily accessible at our GitHub repository: ar.io SDK change logs (opens new window). Stay updated with the continuous improvements and advancements in the ar.io SDK by referring to this page for all release-related information.

1.0.5 (opens new window) (2024-05-02)

Bug Fixes

• cjs: provide path alias for warp in cjs export (7f9bf9a (opens new window))
• logger: replace winston with bunyan (0488f75 (opens new window))
• util: add FQDN regex that matches ArNS contract (e6d7396 (opens new window))
• utils: manally conver from b64 to b64url to avoid web polyfill issues (766035c (opens new window))
• utils: use base64 for fromB64url util (42302ef (opens new window))
• warp-contract: correctly throw error in write interaction (c2368dd (opens new window))

1.0.4 (opens new window) (2024-04-30)

Bug Fixes

• ario: update joinNetwork to accept observerWallet param (6a32dd1 (opens new window))

1.0.3 (opens new window) (2024-04-26)

Bug Fixes

• signer: set owner before signing data (0b558f5 (opens new window))

1.0.2 (opens new window) (2024-04-25)

Bug Fixes

• arweave: default to the arweave node import to avoid issues with browser environments (fc8c26e (opens new window))
• cacheurl: use default cache url in warpcontract (a676a3c (opens new window))
• init: cleanup init overload methods and tests (fa328d2 (opens new window))
• lint: address lint issue in ArIOWriteable (4a3ee89 (opens new window))
• tsconfig: modify some tsconfig settings to get isolated configs for web/cjs/esm (46b7acc (opens new window))
• typeguards: make type guards accept unknowns (7f285bb (opens new window))
• types: use generic types and modify the requirements for init functions (9350f78 (opens new window))
• utils: add writeInteraction types and update base64url logic (4f5476b (opens new window))

1.0.1 (opens new window) (2024-04-23)

Bug Fixes

• docs: improve README docs interface documentation for ArIO clients (b0da48c (opens new window))

1.0.0 (2024-04-23)

Bug Fixes

• actions: bump node setup action (4eb49cd (opens new window))
• actions: freeze lockfile (dba7313 (opens new window))
• contractadd cache config in ario constructor (1f3c0ba (opens new window))
• ant: add ant contract to exports (a2ff57b (opens new window))
• ant: add signer to ant test (4581b8d (opens new window))
• ant: default evaluation options for ant apis that do not take an… (#25 (opens new window)) (0c8b55d (opens new window))
• ant: default evaluation options for ant apis that do not take another parameter (7c59033 (opens new window))
• ant: default evaluation options for apis that do not require them (72b57d5 (opens new window))
• ant: fix API for getRecords (c714aa3 (opens new window))
• apis: remove epoch from distributions and observations (7b2d279 (opens new window))
• arbundle version: pin version (35ffab6 (opens new window))
• arbundles: update arbundles import (f02d83f (opens new window))
• ario: add cache config in ario constructor (#11 (opens new window)) (ecb279d (opens new window))
• ario: formatting (c61570a (opens new window))
• ario: make state provider nullable and default to remote arns-service provider (fa1cb72 (opens new window))
• ario: re-add contract default config (2296cc3 (opens new window))
• ario: remove unused cache property (7f2d02e (opens new window))
• build: add setImmediate polyfill for web only (ad36776 (opens new window))
• build: remove redundant exported type (134319b (opens new window))
• cache: remove cache folder (2ac9427 (opens new window))
• cacheURL: update ario cache url setting pattern to use custom url appropriately (c76e67d (opens new window))
• cache: validate arweave id before setting it (5ba1175 (opens new window))
• casing: revert to lower case casing (b5da0ab (opens new window))
• comments: make class logger private, remove comments (7483246 (opens new window))
• connect: add init static function on ario class to create interaction classes (765f39c (opens new window))
• contract configuration: return cache url as well (b4a7bc3 (opens new window))
• contract functions: correct contract function names (ad9bc56 (opens new window))
• contracts: add configuration view method and update types (4fae4a2 (opens new window))
• contracts: remove write method and type from remote contract (740d8b8 (opens new window))
• contracttxid: make contractTxID require in remote state cache instance (dc82d21 (opens new window))
• contracttxid: make contractTxID required in remote state cache instance (#10 (opens new window)) (bf651bb (opens new window))
• ctrl flow: remove else from control flow (4b3c4c2 (opens new window))
• deps: pin arweave (d39391c (opens new window))
• deps: remove axios-retry, will implement later (0218e95 (opens new window))
• deps: remove extra crypto-browserify (9b42898 (opens new window))
• deps: remove warp-contracts-deploy from deps (9d4f9fa (opens new window))
• docs: remove docs folder (47e8403 (opens new window))
• drywrite: throw on bad drywrite and continue if successful (5052c0a (opens new window))
• eslintignore: remove old file names (415c163 (opens new window))
• eslint: remove eslint comments and use this signer (32530eb (opens new window))
• esm: add polyfills for crypto (dd8fbfe (opens new window))
• esm: add polyfills for crypto (#27 (opens new window)) (553822c (opens new window))
• example web: update ario instatiation (77c6842 (opens new window))
• example: escape quotes in packagejson for example package json (fb47de0 (opens new window))
• example: simplify example and remove unused method on remote cache (81637f8 (opens new window))
• examples: update comments and fix package.json (db7140b (opens new window))
• examples: update examples to use devnet (cc037ac (opens new window))
• examples: update examples with records methods, and balance methods (a2d2a02 (opens new window))
• exports: add arweavesigner and arconnectsigner to exports, clean up docs (c7860ed (opens new window))
• exports: update exports in indices (f794437 (opens new window))
• exports: update package exports to have index in src folder (2cce9e3 (opens new window))
• files: clean git cache of duplicate casing (e9eaa2d (opens new window))
• filters: punt filters (1c23cb3 (opens new window))
• fixture: add type to arns state fixture (5bcac32 (opens new window))
• formating: format (3f30f77 (opens new window))
• gar write: fix types and flow on gar write (f5e7774 (opens new window))
• gateway: update gateway settings to support autostake (82c6840 (opens new window))
• generics: use named generic (4b647f0 (opens new window))
• gitignore: remove cache from gitignore (2867abc (opens new window))
• git: test fix with file casing issue (c3611ee (opens new window))
• headers: use source-version for header (2b26d88 (opens new window))
• http: add headers sdk headers to http config (94810ed (opens new window))
• husky: add commit hooks (885ce68 (opens new window))
• imports: update to use indexed imports from warp (1242568 (opens new window))
• indentation: fix indentation in examples (a266731 (opens new window))
• interface: removed filters and added base records types (849834d (opens new window))
• interface: rename interface to ContractCache (2a0a765 (opens new window))
• jest: remove extra config (014fbde (opens new window))
• lint: disable no-any warning certain types (de5f108 (opens new window))
• lint: formatting (21224e2 (opens new window))
• logger, errors, http: Updated to axios and axios-retry, added winston logger, more extensive custom error objects (b944f4d (opens new window))
• logger: remove unused logger property (9501d1d (opens new window))
• logs: removing debug logs (f025171 (opens new window))
• mixin: filter private methods in mixin util (beb8610 (opens new window))
• naming: change epoch to epochStartHeight (908971c (opens new window))
• naming: rename getRecord[s] to getArNSRecord[s] (bd3d4bc (opens new window))
• overloads: only accept warp contract as a contract config for ariowritable (e3c97e9 (opens new window))
• polyfills: rollback polyfill on logger (0cdb2f0 (opens new window))
• postinstall: remove husky postinstall script (c74a135 (opens new window))
• readme: add grammar and example recs (ecc07f7 (opens new window))
• readme: condense quick start (b35e5bd (opens new window))
• readme: refactor api list to header tags (817d99b (opens new window))
• readme: update ant header (77235ce (opens new window))
• readme: update ANT usage description (70c8520 (opens new window))
• readme: update joinNetwork docs (9fcf440 (opens new window))
• readme: update quick start (a60d96a (opens new window))
• readme: update readme with default provider example (68a5a16 (opens new window))
• readme: update readme with examples (d9ee23e (opens new window))
• record records: update key to use result instead of record (90314db (opens new window))
• records: remove contractTxId filter remove lodash shrink readme (50669e1 (opens new window))
• records: use state endpoint to fetch records (2f02c53 (opens new window))
• recs: modify the interfaces for contracts and implement with warp and remote service (#13 (opens new window)) (56ebb08 (opens new window))
• release: remove release assets entirely (9d5a1b3 (opens new window))
• release: update github release config to publish packages to github (5534d9d (opens new window))
• remote: getState not properly setting evalTo in http requests (55745c1 (opens new window))
• safety: update type safety checks (32eebbc (opens new window))
• setimmediate: make set immediate a build dependency as it is required by the node winston (9292eaa (opens new window))
• signer: check that contract is connected before trying to write (d352e9c (opens new window))
• signer: check that contract is connected before trying to write (#29 (opens new window)) (536a116 (opens new window))
• signer: fix signer in WarpContracts - update tests (ea9448f (opens new window))
• signer: fix signer in WarpContracts - update tests (#32 (opens new window)) (16d69d8 (opens new window))
• signer: remove jwk use, ignore web example for now (bc7e577 (opens new window))
• signer: remove signer, will do in other pr (d02276d (opens new window))
• signer: remove use of JWK, simplify constructor (#22 (opens new window)) (d2ef573 (opens new window))
• signer: update ANT to have signer (c7f8eee (opens new window))
• structure: update cache provider folder to be named caches (844c1aa (opens new window))
• structure: use snake case for file and folder names (37f27d3 (opens new window))
• test warp-contract: use beforeAll to read env vars (95cc019 (opens new window))
• tests: add test cases as a const (8458185 (opens new window))
• tests: add test for custom arIO client config (0e6142b (opens new window))
• tests: change control flow pattern to .catch instead of trycatch (883de51 (opens new window))
• tests: dont make blockHeight or sortKey undefined but rather evalTo (f76a201 (opens new window))
• tests: instantiate new ant to connect in tests (9869415 (opens new window))
• tests: remove dryWrite from writeInteraction, update tests (bc1becc (opens new window))
• tests: remove fixture and use live service for tests (30d3e8c (opens new window))
• tests: test 404 response (590dea6 (opens new window))
• tests: update ario test (4208bd0 (opens new window))
• tests: update client instantiation test to check read vs write clients (059653c (opens new window))
• tests: update docker compose params (a71befd (opens new window))
• tests: update gateways test (1fcb3e6 (opens new window))
• tests: update stubs in tests (e4bbc6e (opens new window))
• tests: update test to match jest syntax (553bdbb (opens new window))
• tests: update tests for named prop expectation (4ea04a7 (opens new window))
• tests: update tests to use younger contract, add evalParams config (ae890c8 (opens new window))
• tests: update tests with constants and update types (1bdcfeb (opens new window))
• tests: update tests with new name (2cd1b5c (opens new window))
• tests: update with new names on methods (619c193 (opens new window))
• tests: use angela for testing (10f30fe (opens new window))
• tests: use http not https in tests (fddba1e (opens new window))
• tests: use process vars as priority url (faab4f3 (opens new window))
• test: update test to use ArweaveTransactionID class (f6c4f8b (opens new window))
• tsconfig, names: reverted tsconfig to nodenext resolution, changed naming convention on provider, removed extraeneous error classes, rolled back axios-retry to match our tsconfig settings (d412d44 (opens new window))
• tyeps: set types to objects rather than top level params for easier readability (edfd77b (opens new window))
• type: rename all type implementations (5959045 (opens new window))
• types and tests: update evalTo to allow undefined sortKey and block and test that (a59f05c (opens new window))
• types: add @ to records (53601c1 (opens new window))
• types: make props nullable on certain read apis (f8ff552 (opens new window))
• types: remove any type (5c80242 (opens new window))
• types: remove any types (d8d910b (opens new window))
• types: remove ArweaveTransactionID type for now (3adf53b (opens new window))
• types: remove unnecesssary empty defaults (7d14edb (opens new window))
• types: rename signer to ContractSigner (87d6c90 (opens new window))
• types: require atleast one param to update gateway settings (857ebdc (opens new window))
• types: update interaction type to only use read for now (2c02e90 (opens new window))
• types: update tests, readme, and types (e9985dd (opens new window))
• types: use partial write type (fa6a638 (opens new window))
• types: use string instead of any (014a262 (opens new window))
• validate id: make validator a private method (dce4a94 (opens new window))
• validity util: isBlockheight check more strict (2b28675 (opens new window))
• warp contract: added test for getting state after connecting with warp (060ee2c (opens new window))
• warp-contract: provide logger - update isTransaction flow ctrl - use typed props (5f6e0a1 (opens new window))
• warp-contracts: bump warp to 1.4.38 - fixed warp exports (af4a20b (opens new window))
• winston: move the winston polyfill - this will prevent any esm based web projects from getting polyfill issues (c8b7998 (opens new window))
• write: add dry run - sync state - abortSignal - update interface (970bdef (opens new window))
• write: update utils - change error flow - update arweave constructor props (0a81c92 (opens new window))
• write: update write methods on warp (9c0540b (opens new window))
• yarn: update lockfile (fd5e0ee (opens new window))

Features

• ant: add ANT read interface (c941c96 (opens new window))
• ant: create ant contract class for interacting with ant contracts (6eb7ef5 (opens new window))
• ants: add readable-writable framework to the ant client and implement write methods (3019f53 (opens new window))
• ario contract: add distributions and observation apis (21e38d1 (opens new window))
• arioContract: update ArIO interface and ArIOContract interface (5d87e2e (opens new window))
• auctions: add auctions apis (faf08c5 (opens new window))
• contract: add distribution, observations apis, update readme and examples (0208317 (opens new window))
• contract: create new contract classes that impelement both warp and remote cache for ant contract and ar-io contracts (855da2d (opens new window))
• first issue: setup examples, readme, and initial gateways provider (5a9e232 (opens new window))
• gar methods: add gar write methods to the ario client (e01b08b (opens new window))
• inital providers: scaffold initial providers (4949514 (opens new window))
• io transfer: add transfer api to ario writable client (0d37623 (opens new window))
• observerations: add saveObservations write interaction (8dd977c (opens new window))
• observers: add API for fetching prescribed observers (a18e130 (opens new window))
• observers: add API for fetching prescribed observers (#17 (opens new window)) (17ce6de (opens new window))
• PE-5742: add records api to arns remote cache (#8 (opens new window)) (c46cd39 (opens new window))
• PE-5751: add blockheight and sortkey eval filters (#12 (opens new window)) (832a1ad (opens new window))
• PE-5758: add signer to ario class (#20 (opens new window)) (1b82077 (opens new window))
• PE-5759: observations and distributions apis (#16 (opens new window)) (dded361 (opens new window))
• PE-5773: add auctions read apis (#18 (opens new window)) (e0c6fca (opens new window))
• PE-5800: add epoch apis (48ee4ba (opens new window))
• PE-5800: epoch apis (#15 (opens new window)) (70563b1 (opens new window))
• PE-5825: ANT read interface (#19 (opens new window)) (6a0c477 (opens new window))
• records: add records api to arns remote cache (1b7f54f (opens new window))
• signer: add arweave signer to ario class (7e08097 (opens new window))
• write: add write interface and base implementation on warp-contract (6dfc969 (opens new window))