CHANGELOG.md

2.4.0 (2024-11-12)

Bug Fixes

• ant: add reassignName to ant implementation (9e705a9)
• auctions: fix submitAuctionApi to accept type and years (6780a80)
• auctions: update auction APIs and types (5fd2ccc)
• auctions: update read APIs to fetch auctions, use vite example display active auction (32001c2)
• auctions: update types and add intervalMs (bc21200)
• corrected AoVaultData field to be startTimestamp (b9888bf)
• delegates: fixes type (ae7be5c)
• emitter: do non strict checks on state in arns emitter (6566a3c)
• emitter: provide strictness in constuctor (060df05)
• exports: add exports to barrel file (fec094e)
• exports: dont export http stuff) (d6369aa)
• io: consolidate instantGatewayWithdrawal and instantGatewayWithdrawal to just instantWithdrawal, update `cancelWithdrawal (ea9f3eb)
• io: include address in delegate type for gateway (46ef1a7)
• lint: add lint fix and missing bracket (72446aa)
• PE-7080: add apis for fetching paginated delegates (e3d4af2)
• schema: add strict mode to ANT with default to false (4864abf)
• schemas: add passthrough on schema checks for ants (9cb2776)
• schemas: add zod schemas and tests (feba587)
• schema: specify HandlerNames instead of Handlers (44cc472)
• schemas: update ant schema and tests (f3284ed)
• schema: update handlers schema (6ec52e4)
• strict: allow for passing in strict mode on apis (e147220)
• tag: small tweak to instant tag (663de6f)
• test: correct params for get record (f999c49)
• tests: add esm tests and remove redundant cjs tests (95244ea)
• tests: add js path on imports (db1520a)
• tests: simplify strict check on test (62c9140)
• types: add back delegates for AoGateway (d337a74)
• types: update types to match contract (cb7d2b4)
• types: use generic on PageParms for sortBy, update delegate types (7a1abc4)
• util: create schema parsing util to pretty format errors (367537a)
• validations: add zod schema validations on ant returns (163c2f1)
• withdrawls: update API for cancelling withdrawls to allow delegate and operator withdrawls (5cb680a)

Features

• ant: adds set-keywords and set-description methods for ants) (3b260a2)
• ant: support releasing of name of ANTs (16363e8)
• arns: add upgradeRecord API (9c1726d)
• auctions: add auctions api to IO classes (974897b)
• delegates: add instant delegate withdrawal for a fee (4b4cb8f)
• getVault: init IO method PE-7081 (0e3cde2)
• paginated vaults: init SDK paginated vaults PE-7081 (6d079f9)
• paginated vaults: use flat array over nested vaults PE-7081 (e17cfb7)

2.3.2 (2024-10-16)

Bug Fixes

• io: add getDemandFactor api (feab461)
• io: update getTokenSupply to type that returns full breakdown of tokens (e790055)
• types: add totalEligibleGateways to AoEpochDistributionData type (9a35d39)
• types: update gateways to include services (a3fe5b4)

2.3.1 (2024-10-09)

Bug Fixes

• use AoEpochObservationData type to match what is coming back from contract (684abf3)

2.3.0 (2024-10-08)

Bug Fixes

• ao: check messages is not empty to avoid .length error when evaluating outputs of dryrun (a7b4953)
• logs: enable logging in spawn and evolve utils (08ce71a)
• luaID: update lua id to latest for ant source code (9c13dd3)
• main: merge main back to alpha, release hotfixes on alpha (9299427)
• types: add source code tx id to ant state type (8949f04)
• types: fix types on ant (3bdb3a6)
• types: remove restricted type (b1fac75)
• types: update type and tests (877b03f)
• types: update types (883ffb3)

Features

• delegates: add cancel delegate withdrawal method (a3827dc)
• io: add api for querying get registration fees handler to AoIORead class (7b3909f)

2.2.5 (2024-09-26)

Bug Fixes

• ant: allow sending tags on ant write interactions (99c24f8)

2.2.4 (2024-09-26)

Bug Fixes

• types: update getInfo types on IO (7a0d20d)

2.2.3 (2024-09-25)

Bug Fixes

• types: update type and tests (877b03f)

2.2.2 (2024-09-23)

Bug Fixes

• deps: update arbundles to @dha-team/arbundles (c41e4e4)

2.2.1 (2024-09-16)

Bug Fixes

• types: correct totalEpochCount for gateway stats (f82fed8)

2.2.0 (2024-08-30)

Bug Fixes

• logger: permit logger as argument for typeguard util and default it (45df626)
• register: update spawn ant to register at end of spawn (4320c80)
• signer: add typeguard util for aoSigner (0d7f210)
• signing: add aosigner to contract signer (3b0495a)
• tests: dont send messages to ao in e2e tests (e7108da)
• tests: reconfigure test structure (1872a26)
• tests: use test-wallet fixture in tests instead of generating anew each time (27a5dc2)
• typeguard: return true or false in typeguard and log the error (4b851c5)
• types: update types for epoch distributions (5aedf50)
• util: use ANTRegistry class for registering ant on spawn instead of aoconnect (350112d)

Features

• ant id: update lua ant id to latest (968c30e)
• util: add AoAntState typeguard util (c6f457f)

2.1.0 (2024-08-07)

Bug Fixes

• actions: ignore engines in action (7f6f87d)
• ant lua id: update to version Flwio4Lr08g6s6uim6lEJNnVGD9ylvz0_aafvpiL8FI (8cbd564)
• ant: remove data from ant object, none of our ant methods require data attributes (0f267c1)
• ao: update AoProcess to only support string | undefined (584aee1)
• arns: update event emitter to provide more events and logs while loading arns records (8775896)
• constants: do not set env var for ant registry (9e61cc7)
• deps: move arconnect to dev deps (34f07d2)
• emiter: use a set to filter out duplicate (7887af9)
• emitter: add page size param for emitter to increase amount of records per page to 50k (b6f2157)
• errors: use any type on error (f14ed5a)
• events: use arns name space for events (1d67dfe)
• evolve: call eval twice to ensure evolve txid is set (a6261e5)
• evolve: dont double eval (a2a9121)
• evolve: fixed evolve somehow (b06503b)
• example: dont spawn in example (d1d5147)
• example: remove unused arweave instance (d0035c0)
• format: fix linting issues in format (b72dc1f)
• gateway stats: update gateway stat types (a59b166)
• io: add api that returns the total token supply (261c85c)
• io: no longer add data to save observations (c017b52)
• lint: fix lint errors and warnings (e532f4e)
• lua id: set new lua id in constants (e4c3aaf)
• naming: name AoSigner property aoSigner (4604524)
• records: update arns emitter to use ant registry (e55a67b)
• signer: describe signing function as signer vs aoSigner in case of signer type changes (3b23f80)
• signer: move createAoSigner to be a util (7f7a0e6)
• signer: pass in signing function instead of signer class (cba16e3)
• signer: use AoSigner type as return type (8e95edd)
• spawn: update spawn to use ant registry id in the tags (28dae7f)
• tests: check the return of ACL on ant tests more granularly (350bab1)
• tests: update e2e tests to only read from ant registry (a61e0bf)
• tests: update web test to use ANT registry in app (38ca913)
• tests: use const for unchanging test vars (9f965e1)
• test: update browser test with data test id and render checks (93741cb)
• test: use a known wallet adddress in tests (9dac280)
• todo: remove completed todo comment (c868522)
• types: add gateway weights to AoGateway (e725198)
• types: check info on evolve util first (a44cca1)
• types: remove deprecated types (c674876)
• types: update AoGateway to include weights (5368668)
• types: update type name to what contract returns (99edbad)
• use custom event names to avoid overlap (5b919ac)
• utils: revert new util (c959c81)
• utils: update util to use ant registry (b2223d4)

Features

• ant registry: add ant registry class (2056674)
• evolve: add evolve util (47bfe20)
• signing: add window arweave wallet to available signing options (7596aec)

2.0.2 (2024-07-12)

Bug Fixes

• types: update gateway settings type to only support observerAddress (13e073b)

2.0.1 (2024-07-11)

Bug Fixes

• logger: fixes the console logger to respect the log level provided by web clients (99d7993)

2.0.0 (2024-07-11)

Bug Fixes

• arweave: use default arweave in IO (21d25b9)
• deps: replace bunyan or console depending on the client environment (9d940aa)
• log: allow log level configuration for clients (9cb0981)
• log: replace bunyan with winston to ensure browser compatibility (80b38e0)

Features

• io: add paginated gateway support for larger state objects (e.g. balances, records, and gateways) (b23efa8)
• util: add utility for fetching all records (8df2aac)
• io: add leaveNetwork API (54222ce)

BREAKING CHANGES

• deps: removes all smartweave implementations using warp-sdk. The result is an only AO compatible ANT and IO network contracts. Some utilities are preserved due to their usefulness.
• imports: modifies web named exports to provide esm and cjs exports instead of minified bundle. The web bundle was causing issues in bundled projects, and polyfills are no longer provided by default. Refer to the README for specifications on how to use the SDK for a web project.

1.2.2 (2024-07-11)

Bug Fixes

• api: ensure timestamps are always in milliseconds (93b162f)

1.2.1 (2024-07-04)

Bug Fixes

• io: default the IO process to use testnet (61bca5c)

1.2.0 (2024-07-03)

Features

• ant: add balance APIs to ant interface (ec67440)
• ant: add utility for fetch ant modules owned by wallet (01f7ec9)
• ants: support ANT apis in SDK (b187aeb)
• ao: add spawn ant util (d02566e)
• ao: experiment with initial implementation of ao contract (6118cea)
• io: add getInfo method to io class (4ef25ec)
• io: implement io/ao classes that integrate with IO/AO process and network protocol (aab8967)

1.1.1 (2024-06-06)

Bug Fixes

• api: default evaluation options on getArNSReservedNames api (0a1f22e)

1.1.0 (2024-06-03)

Bug Fixes

• api: make evaluation options optional on the interface (9e5a1c0)
• api: remove unused variable for epochBlockHeight (98c5ebc)
• arweave: default to arweave.net (84c9653)
• axios: add back axios-retry (9aae4de)
• errors: throw AbortError on signal aborted (63bd395)
• getContracts: only implement util for now (6b29c2f)
• gql query: do not abstract the data protocol query (f0b8f77)
• imports: import type from base route warp-contracts (bf99a85)
• init: allow signer to be undefined and if so return readable (b6a05e2)
• init: fix type for init to allow undefined signer (0a64ea9)
• init: remove unnecessary destructuring (81af1af)
• remove epochBlockHeight from interface (b646f08)
• types: remove DataItem from WriteInteractionResult (eadb1a1)
• types: use gql node interface for dataProtocolTransaction (79cebd9)
• warp: ensure contract init on read interactions (bc3d1b8)

Features

• getContracts: add get contracts on network specific providers like WarpContract (603d36e)
• gql util: add smartweave gql utils (5ea3aab)
• write: add tags support to write interactions on warp-contract and saveObservations (46eb4c9)

1.0.8 (2024-05-29)

Bug Fixes

• api: add getPriceForInteration api to ario contract (3b8083c)
• bundle: minify web bundle (9266676)
• api: use function map for method name (439ec1f)
• reserved: add reserved arns name get methods (ad203ef)
• signer: check if method is property of signer before using (c52783c)
• signer: modify signer to assume the signer type based on public key being undefined (b775c96)
• test: add dockerfile for running tests in certain node environments (86cf2ad)

1.0.7 (2024-05-23)

Bug Fixes

• contract: add extendLease and increaseUndernameSupport apis (1b13b5e)
• types: fix the AtLeastOne type (ffd0869)
• deps: force arweavve to 1.15.1 (2448598)
• contract: make params required - properties and note (89db674)
• types: update tests and use overwrite type to allow mIOtoken for certain paramaters (badcece)
• api: change to increaseUndernameLimit (9b72c1e)
• docs: update ario apis (4af0862)
• tests: update extend test util to include a test domain (e959b7c)
• token: add mIO and IO token classes to exports (f47f7d5)
• types: add delegated gateway type (c877496)
• types: export the token types (dfc83ae)
• types: remove visible types (6ab1fc3)
• types: update Gateway delegates type to use the new GatewayDelegate (ac7e924)
• warp: bump warp version (db7344d)

1.0.6 (2024-05-07)

Bug Fixes

• warp: bump warp to fix AbortError issue on warp imports for web (c9a5613)

1.0.5 (2024-05-02)

Bug Fixes

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

1.0.4 (2024-04-30)

Bug Fixes

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

1.0.3 (2024-04-26)

Bug Fixes

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

1.0.2 (2024-04-25)

Bug Fixes

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

1.0.1 (2024-04-23)

Bug Fixes

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

1.0.0 (2024-04-23)

Bug Fixes

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

Features

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