diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..1dbe5488 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Import client '....' +2. Use API '....' +3. Request data '...' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots or stack traces to help explain your problem. + +**Environment (please complete the following information):** + +- Environment: [e.g. node, browser] +- SDK Version [e.g. v1.0.0] +- Node Version [e.g. 18.16.3] +- Browser [e.g. chrome, safari] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..33e0ca95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature Request Template +about: 'For feature requests. Please search for existing issues first. Also see CONTRIBUTING.' +--- + +**Please Describe The Problem To Be Solved** + +(Replace This Text: Please present a concise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope.) + +**(Optional): Suggest A Solution** +(Replace This Text: A concise description of your preferred solution. Things to address include: + +- Details of the technical implementation +- Tradeoffs made in design decisions +- Caveats and considerations for the future +- Dependencies on other work or upgrades + +If there are multiple solutions, please present each one separately. Save comparisons for the very end.) diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29b..c855a13a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,192 @@ +# 1.0.0 (2024-04-23) + + +### Bug Fixes + +* **actions:** bump node setup action ([4eb49cd](https://github.com/ar-io/ar-io-sdk/commit/4eb49cda331cfef516639435e73dde2e90f2e05c)) +* **actions:** freeze lockfile ([dba7313](https://github.com/ar-io/ar-io-sdk/commit/dba7313f42c8cf0053f90327ad2c14ec5bd4d4d7)) +* add cache config in ario constructor ([1f3c0ba](https://github.com/ar-io/ar-io-sdk/commit/1f3c0baef2831d12d14d20e1ac16d9b0e8f0c978)) +* **ant:** add ant contract to exports ([a2ff57b](https://github.com/ar-io/ar-io-sdk/commit/a2ff57bc1b6f77dcf9f3ace1fd3b346069aec6b4)) +* **ant:** add signer to ant test ([4581b8d](https://github.com/ar-io/ar-io-sdk/commit/4581b8d461e57f4769befe5f650e5fe4e94bbc09)) +* **ant:** default evaluation options for ant apis that do not take an… ([#25](https://github.com/ar-io/ar-io-sdk/issues/25)) ([0c8b55d](https://github.com/ar-io/ar-io-sdk/commit/0c8b55ddbc5019f365af43389524af5bd733d0c9)) +* **ant:** default evaluation options for ant apis that do not take another parameter ([7c59033](https://github.com/ar-io/ar-io-sdk/commit/7c590334f6f99998839fecc78505e41931c80045)) +* **ant:** default evaluation options for apis that do not require them ([72b57d5](https://github.com/ar-io/ar-io-sdk/commit/72b57d5626cbcda0931fd5f0b88bf113fbb05066)) +* **ant:** fix API for getRecords ([c714aa3](https://github.com/ar-io/ar-io-sdk/commit/c714aa3563580c19427d55d6938893665ecc3ea2)) +* **apis:** remove epoch from distributions and observations ([7b2d279](https://github.com/ar-io/ar-io-sdk/commit/7b2d2799d534378183122ef986fc3bd75755558e)) +* **arbundle version:** pin version ([35ffab6](https://github.com/ar-io/ar-io-sdk/commit/35ffab6fbb9a2209391bb5f10120fb9a9c91b0aa)) +* **arbundles:** update arbundles import ([f02d83f](https://github.com/ar-io/ar-io-sdk/commit/f02d83f4766a92be930a7c51e23f1f63b5692224)) +* **ario:** add cache config in ario constructor ([#11](https://github.com/ar-io/ar-io-sdk/issues/11)) ([ecb279d](https://github.com/ar-io/ar-io-sdk/commit/ecb279d8a5d4381ecf29e8e3b94615ab7ae127aa)) +* **ario:** formatting ([c61570a](https://github.com/ar-io/ar-io-sdk/commit/c61570ac609566d294d6c42b97ba65b91ef81d9c)) +* **ario:** make state provider nullable and default to remote arns-service provider ([fa1cb72](https://github.com/ar-io/ar-io-sdk/commit/fa1cb728edc9ec072aa3c12595a3e5c93d84ca67)) +* **ario:** re-add contract default config ([2296cc3](https://github.com/ar-io/ar-io-sdk/commit/2296cc3e152c136e2df45481340a625a80a0be3f)) +* **ario:** remove unused cache property ([7f2d02e](https://github.com/ar-io/ar-io-sdk/commit/7f2d02eb3da96cea024ca2355668d5354dbeb767)) +* **build:** add setImmediate polyfill for web only ([ad36776](https://github.com/ar-io/ar-io-sdk/commit/ad36776795348a32941d2b4e833ed00da05a476f)) +* **build:** remove redundant exported type ([134319b](https://github.com/ar-io/ar-io-sdk/commit/134319b8707cd479dc91d6832bf078bdb5c5e886)) +* **cache:** remove cache folder ([2ac9427](https://github.com/ar-io/ar-io-sdk/commit/2ac942742017344e1d8c06883449453c88bfa155)) +* **cacheURL:** update ario cache url setting pattern to use custom url appropriately ([c76e67d](https://github.com/ar-io/ar-io-sdk/commit/c76e67dd8ecb7014cd441e7284df389e06ea5cc0)) +* **cache:** validate arweave id before setting it ([5ba1175](https://github.com/ar-io/ar-io-sdk/commit/5ba1175b63b28e86f2b08a0de657a25546f46688)) +* **casing:** revert to lower case casing ([b5da0ab](https://github.com/ar-io/ar-io-sdk/commit/b5da0ab78a965829951dbed7f4fcc5087b813271)) +* **comments:** make class logger private, remove comments ([7483246](https://github.com/ar-io/ar-io-sdk/commit/7483246113d5b3b424f8450ea1f1c5e0d036618b)) +* **connect:** add init static function on ario class to create interaction classes ([765f39c](https://github.com/ar-io/ar-io-sdk/commit/765f39c5816b35c41b43fdeddf765b9b50845b9a)) +* **contract configuration:** return cache url as well ([b4a7bc3](https://github.com/ar-io/ar-io-sdk/commit/b4a7bc3960be0532ec7cdedf5875128f11f60672)) +* **contract functions:** correct contract function names ([ad9bc56](https://github.com/ar-io/ar-io-sdk/commit/ad9bc5625b582d5714624c491904e68380f10ae3)) +* **contracts:** add configuration view method and update types ([4fae4a2](https://github.com/ar-io/ar-io-sdk/commit/4fae4a2688f96388d5b53d8fe292ff7942af0c57)) +* **contracts:** remove write method and type from remote contract ([740d8b8](https://github.com/ar-io/ar-io-sdk/commit/740d8b88a5486f90cd61d024f8fdd4e6b9a370a0)) +* **contracttxid:** make contractTxID require in remote state cache instance ([dc82d21](https://github.com/ar-io/ar-io-sdk/commit/dc82d217c66ad8deff4ea6c3a9d7304f6e65b4d9)) +* **contracttxid:** make contractTxID required in remote state cache instance ([#10](https://github.com/ar-io/ar-io-sdk/issues/10)) ([bf651bb](https://github.com/ar-io/ar-io-sdk/commit/bf651bb11006eaf5eea586ff1feb0bb2644db504)) +* **ctrl flow:** remove else from control flow ([4b3c4c2](https://github.com/ar-io/ar-io-sdk/commit/4b3c4c2058767b05199ac75c44c4684a66149bb9)) +* **deps:** pin arweave ([d39391c](https://github.com/ar-io/ar-io-sdk/commit/d39391c19dc7d1396b735cd87920a2dc224f94e4)) +* **deps:** remove axios-retry, will implement later ([0218e95](https://github.com/ar-io/ar-io-sdk/commit/0218e95fc2c2b1682010cf1841e3a2c717756c1d)) +* **deps:** remove extra crypto-browserify ([9b42898](https://github.com/ar-io/ar-io-sdk/commit/9b4289809eacba3cd870adddb2bd73def576d50a)) +* **deps:** remove warp-contracts-deploy from deps ([9d4f9fa](https://github.com/ar-io/ar-io-sdk/commit/9d4f9faa860789ced003dc3b6d36c4db99962b8e)) +* **docs:** remove docs folder ([47e8403](https://github.com/ar-io/ar-io-sdk/commit/47e84037357fd69f9af18b1e9b84286257b49331)) +* **drywrite:** throw on bad drywrite and continue if successful ([5052c0a](https://github.com/ar-io/ar-io-sdk/commit/5052c0a4deb06ac938d898d990e425dcc8ac6443)) +* **eslintignore:** remove old file names ([415c163](https://github.com/ar-io/ar-io-sdk/commit/415c1632fc1d363894d17d4a335c7a0bbf78f3d8)) +* **eslint:** remove eslint comments and use this signer ([32530eb](https://github.com/ar-io/ar-io-sdk/commit/32530eb777367b71bfba16bd97dcf6d6a75de791)) +* **esm:** add polyfills for crypto ([dd8fbfe](https://github.com/ar-io/ar-io-sdk/commit/dd8fbfe5b373ba95ec406c1642e81ef520cdeddb)) +* **esm:** add polyfills for crypto ([#27](https://github.com/ar-io/ar-io-sdk/issues/27)) ([553822c](https://github.com/ar-io/ar-io-sdk/commit/553822cab7ec8652efbc9545ef3c20c0312c38f0)) +* **example web:** update ario instatiation ([77c6842](https://github.com/ar-io/ar-io-sdk/commit/77c68429af5e5a50f4ed2e8bd2bf7fdc67b8a2a6)) +* **example:** escape quotes in packagejson for example package json ([fb47de0](https://github.com/ar-io/ar-io-sdk/commit/fb47de0336b33405d81992cfce8e9993d2531f8b)) +* **example:** simplify example and remove unused method on remote cache ([81637f8](https://github.com/ar-io/ar-io-sdk/commit/81637f89c2eab304d7ccf11d1eac9503aa3d7592)) +* **examples:** update comments and fix package.json ([db7140b](https://github.com/ar-io/ar-io-sdk/commit/db7140b815be1ea6fe1b270827fc4afb61707546)) +* **examples:** update examples to use devnet ([cc037ac](https://github.com/ar-io/ar-io-sdk/commit/cc037ac5a3df2e76375679b8b14723c3b5d51fe2)) +* **examples:** update examples with records methods, and balance methods ([a2d2a02](https://github.com/ar-io/ar-io-sdk/commit/a2d2a02befd64cff500932fe609b29d79ddf096c)) +* **exports:** add arweavesigner and arconnectsigner to exports, clean up docs ([c7860ed](https://github.com/ar-io/ar-io-sdk/commit/c7860ed40d19ac43c091b6afd52db0402537e7ee)) +* **exports:** update exports in indices ([f794437](https://github.com/ar-io/ar-io-sdk/commit/f79443732909fbc4c81d78957ca306bfb538caa3)) +* **exports:** update package exports to have index in src folder ([2cce9e3](https://github.com/ar-io/ar-io-sdk/commit/2cce9e31efb2fd0bf8734d930deda301838da8d9)) +* **files:** clean git cache of duplicate casing ([e9eaa2d](https://github.com/ar-io/ar-io-sdk/commit/e9eaa2d93122bad5008010c13710b5fa8bcd7533)) +* **filters:** punt filters ([1c23cb3](https://github.com/ar-io/ar-io-sdk/commit/1c23cb3cf2ce8adc594fd2ba699e5ac32f4ef7b6)) +* **fixture:** add type to arns state fixture ([5bcac32](https://github.com/ar-io/ar-io-sdk/commit/5bcac3211d78e08ead3e14da6e06aa41e9a65598)) +* **formating:** format ([3f30f77](https://github.com/ar-io/ar-io-sdk/commit/3f30f772a7571b9958f8a202128abd483da372b5)) +* **gar write:** fix types and flow on gar write ([f5e7774](https://github.com/ar-io/ar-io-sdk/commit/f5e77741107b82df24c293a1cde37a4a907e1f4c)) +* **gateway:** update gateway settings to support autostake ([82c6840](https://github.com/ar-io/ar-io-sdk/commit/82c68408fb562146053b9180dacc53fb490743ea)) +* **generics:** use named generic ([4b647f0](https://github.com/ar-io/ar-io-sdk/commit/4b647f076b6cd3f4676f0bf7dbf6a5c020214e63)) +* **gitignore:** remove cache from gitignore ([2867abc](https://github.com/ar-io/ar-io-sdk/commit/2867abcdba2fc4a4cece01c6ed3346065a54e2eb)) +* **git:** test fix with file casing issue ([c3611ee](https://github.com/ar-io/ar-io-sdk/commit/c3611ee8fe9ef75ef2d91aa8bade99fee221c69a)) +* **headers:** use source-version for header ([2b26d88](https://github.com/ar-io/ar-io-sdk/commit/2b26d888e176ed745fbc06fbe427993046d8cb18)) +* **http:** add headers sdk headers to http config ([94810ed](https://github.com/ar-io/ar-io-sdk/commit/94810edb03272daccfbf05fb5625ba4aa3ee06f4)) +* **husky:** add commit hooks ([885ce68](https://github.com/ar-io/ar-io-sdk/commit/885ce68c3b734ac95e1293078ce835333bc45d9f)) +* **imports:** update to use indexed imports from warp ([1242568](https://github.com/ar-io/ar-io-sdk/commit/124256835e0137fb1332e0e7a670ccfaad8ef228)) +* **indentation:** fix indentation in examples ([a266731](https://github.com/ar-io/ar-io-sdk/commit/a266731e14b480d04e3be1fa558de368f366682d)) +* **interface:** removed filters and added base records types ([849834d](https://github.com/ar-io/ar-io-sdk/commit/849834db2c88ffc362c54f9844f936a1c8ab23dc)) +* **interface:** rename interface to ContractCache ([2a0a765](https://github.com/ar-io/ar-io-sdk/commit/2a0a76546326d2a47f5cef1dde3c105f4deaad50)) +* **jest:** remove extra config ([014fbde](https://github.com/ar-io/ar-io-sdk/commit/014fbde09f4c533c957d6372345616c13df2a29d)) +* **lint:** disable no-any warning certain types ([de5f108](https://github.com/ar-io/ar-io-sdk/commit/de5f10874e6bf2deaca89d35ac11e1a11a64ad59)) +* **lint:** formatting ([21224e2](https://github.com/ar-io/ar-io-sdk/commit/21224e2f47605d1959853c99ddb1c8a3df6a0d7d)) +* **logger, errors, http:** Updated to axios and axios-retry, added winston logger, more extensive custom error objects ([b944f4d](https://github.com/ar-io/ar-io-sdk/commit/b944f4db494531a346ab025e28a8a6cd46f5d546)) +* **logger:** remove unused logger property ([9501d1d](https://github.com/ar-io/ar-io-sdk/commit/9501d1d3571980fb4e157c022e0ea0f8e60f9a0a)) +* **logs:** removing debug logs ([f025171](https://github.com/ar-io/ar-io-sdk/commit/f025171586e2f440ef92550ddf37c5254db86a44)) +* **mixin:** filter private methods in mixin util ([beb8610](https://github.com/ar-io/ar-io-sdk/commit/beb8610807038a7fc51baaa266db1435781c6e8c)) +* **naming:** change epoch to epochStartHeight ([908971c](https://github.com/ar-io/ar-io-sdk/commit/908971c273aaac20ab320e867ec1e790706a11f3)) +* **naming:** rename getRecord[s] to getArNSRecord[s] ([bd3d4bc](https://github.com/ar-io/ar-io-sdk/commit/bd3d4bc25a7528ba9f093a96cf0ed33439160d27)) +* **overloads:** only accept warp contract as a contract config for ariowritable ([e3c97e9](https://github.com/ar-io/ar-io-sdk/commit/e3c97e9eaddc98e704a2192bcae6dfdee42f7ae6)) +* **polyfills:** rollback polyfill on logger ([0cdb2f0](https://github.com/ar-io/ar-io-sdk/commit/0cdb2f0a1e23c111b57f788f51780f98f186ec7d)) +* **postinstall:** remove husky postinstall script ([c74a135](https://github.com/ar-io/ar-io-sdk/commit/c74a13591c75271352135f8c30055623cf536ed2)) +* **readme:** add grammar and example recs ([ecc07f7](https://github.com/ar-io/ar-io-sdk/commit/ecc07f7f5c89fd8fbe66d2b79db44a62285057d4)) +* **readme:** condense quick start ([b35e5bd](https://github.com/ar-io/ar-io-sdk/commit/b35e5bd94e950255a15c1bf0ffa1bf1aa47a3395)) +* **readme:** refactor api list to header tags ([817d99b](https://github.com/ar-io/ar-io-sdk/commit/817d99b05d45caf435fdfe26065a70407f0bce56)) +* **readme:** update ant header ([77235ce](https://github.com/ar-io/ar-io-sdk/commit/77235ce077ef4a12dfa6b403968b6ab148ebf196)) +* **readme:** update ANT usage description ([70c8520](https://github.com/ar-io/ar-io-sdk/commit/70c852087f75a17c494cc12719d1dc9f96da39f2)) +* **readme:** update joinNetwork docs ([9fcf440](https://github.com/ar-io/ar-io-sdk/commit/9fcf440d2ed2f71005f1e9bd3b0a7691aae90a63)) +* **readme:** update quick start ([a60d96a](https://github.com/ar-io/ar-io-sdk/commit/a60d96a821b5e77a68b7682c5e74e5dc01ca2f28)) +* **readme:** update readme with default provider example ([68a5a16](https://github.com/ar-io/ar-io-sdk/commit/68a5a1697ae0c4c6797ef355f887408d72030cf8)) +* **readme:** update readme with examples ([d9ee23e](https://github.com/ar-io/ar-io-sdk/commit/d9ee23eb99d9d845098324dba77497284942f35c)) +* **record records:** update key to use result instead of record ([90314db](https://github.com/ar-io/ar-io-sdk/commit/90314dbdb91806222a7e822951a89aaeea5596ed)) +* **records:** remove contractTxId filter remove lodash shrink readme ([50669e1](https://github.com/ar-io/ar-io-sdk/commit/50669e1e203d038dfcf3a0e30d7637122d4b4777)) +* **records:** use state endpoint to fetch records ([2f02c53](https://github.com/ar-io/ar-io-sdk/commit/2f02c53d990dffe526de96e762ddbcbf1b3a8770)) +* **recs:** modify the interfaces for contracts and implement with warp and remote service ([#13](https://github.com/ar-io/ar-io-sdk/issues/13)) ([56ebb08](https://github.com/ar-io/ar-io-sdk/commit/56ebb08616e4002a8037747dcd5e9e070dae6a0d)) +* **release:** remove release assets entirely ([9d5a1b3](https://github.com/ar-io/ar-io-sdk/commit/9d5a1b3b693134062754892674428936df122c9b)) +* **release:** update github release config to publish packages to github ([5534d9d](https://github.com/ar-io/ar-io-sdk/commit/5534d9d6c9b86b1642668705dc0cb6c301f03d9e)) +* **remote:** getState not properly setting evalTo in http requests ([55745c1](https://github.com/ar-io/ar-io-sdk/commit/55745c1881af9ea93a0545e1b04eaff210257802)) +* **safety:** update type safety checks ([32eebbc](https://github.com/ar-io/ar-io-sdk/commit/32eebbc21a4592384dd6fed3247f0e00292b6471)) +* **setimmediate:** make set immediate a build dependency as it is required by the node winston ([9292eaa](https://github.com/ar-io/ar-io-sdk/commit/9292eaab29c3c955d1c981d6d22fa6e11da55500)) +* **signer:** check that contract is connected before trying to write ([d352e9c](https://github.com/ar-io/ar-io-sdk/commit/d352e9c7ac1038caa238df21d1165345c64d61de)) +* **signer:** check that contract is connected before trying to write ([#29](https://github.com/ar-io/ar-io-sdk/issues/29)) ([536a116](https://github.com/ar-io/ar-io-sdk/commit/536a116c1cfecd1bfbe1ffc9d5fe87ab4006a81c)) +* **signer:** fix signer in WarpContracts - update tests ([ea9448f](https://github.com/ar-io/ar-io-sdk/commit/ea9448f3440c58811891fa37db2ceb7948b8d200)) +* **signer:** fix signer in WarpContracts - update tests ([#32](https://github.com/ar-io/ar-io-sdk/issues/32)) ([16d69d8](https://github.com/ar-io/ar-io-sdk/commit/16d69d8a996d0692b28c956d7ec7f38245ff2f6b)) +* **signer:** remove jwk use, ignore web example for now ([bc7e577](https://github.com/ar-io/ar-io-sdk/commit/bc7e577e0f7f42a91ae4bbca853addf7f178a1f8)) +* **signer:** remove signer, will do in other pr ([d02276d](https://github.com/ar-io/ar-io-sdk/commit/d02276dd9fa166d254eb76a45e2c6025f632c0ba)) +* **signer:** remove use of JWK, simplify constructor ([#22](https://github.com/ar-io/ar-io-sdk/issues/22)) ([d2ef573](https://github.com/ar-io/ar-io-sdk/commit/d2ef5732d1ef268d9fb1420c96f520b0fcb4bedd)) +* **signer:** update ANT to have signer ([c7f8eee](https://github.com/ar-io/ar-io-sdk/commit/c7f8eeec4c2141548d202f76934304a310b177b7)) +* **structure:** update cache provider folder to be named caches ([844c1aa](https://github.com/ar-io/ar-io-sdk/commit/844c1aab722316db14167f22a397858a2c9c6bbf)) +* **structure:** use snake case for file and folder names ([37f27d3](https://github.com/ar-io/ar-io-sdk/commit/37f27d3b6a526a37a88ccbf7480f4bc6dc06153f)) +* **test warp-contract:** use beforeAll to read env vars ([95cc019](https://github.com/ar-io/ar-io-sdk/commit/95cc0194ffd9b04a0e389557ad39e53cfa87c443)) +* **tests:** add test cases as a const ([8458185](https://github.com/ar-io/ar-io-sdk/commit/845818528fc5364971738fa549173f6f019065c0)) +* **tests:** add test for custom arIO client config ([0e6142b](https://github.com/ar-io/ar-io-sdk/commit/0e6142bedaffbf86e79840d830499d4e1aacbced)) +* **tests:** change control flow pattern to .catch instead of trycatch ([883de51](https://github.com/ar-io/ar-io-sdk/commit/883de51f85f32807a62f189b00ac485ecfdcfd69)) +* **tests:** dont make blockHeight or sortKey undefined but rather evalTo ([f76a201](https://github.com/ar-io/ar-io-sdk/commit/f76a201eb53069f611b17bfef01506143fdec080)) +* **tests:** instantiate new ant to connect in tests ([9869415](https://github.com/ar-io/ar-io-sdk/commit/98694156a55a5dfba2a96cb09b4f734c33ed0c64)) +* **tests:** remove dryWrite from writeInteraction, update tests ([bc1becc](https://github.com/ar-io/ar-io-sdk/commit/bc1becc1597b11c80d56b21d9a7137e170b69399)) +* **tests:** remove fixture and use live service for tests ([30d3e8c](https://github.com/ar-io/ar-io-sdk/commit/30d3e8cddc1f85f19467af19d191558575351e63)) +* **tests:** test 404 response ([590dea6](https://github.com/ar-io/ar-io-sdk/commit/590dea6c6285bd8c786c02dcdbdc85fba7364fc6)) +* **tests:** update ario test ([4208bd0](https://github.com/ar-io/ar-io-sdk/commit/4208bd023c9f1026a49a5bea3a06beb51a3494b7)) +* **tests:** update client instantiation test to check read vs write clients ([059653c](https://github.com/ar-io/ar-io-sdk/commit/059653c38ed78aa305a796bcf8a18a119c83d63c)) +* **tests:** update docker compose params ([a71befd](https://github.com/ar-io/ar-io-sdk/commit/a71befd8b06e18181f52ca78babe878196f3673f)) +* **tests:** update gateways test ([1fcb3e6](https://github.com/ar-io/ar-io-sdk/commit/1fcb3e6c52c47d5c2e9b7df32eff944ec511fec6)) +* **tests:** update stubs in tests ([e4bbc6e](https://github.com/ar-io/ar-io-sdk/commit/e4bbc6e691fec0f60c0ff84c4ead9620dcc28739)) +* **tests:** update test to match jest syntax ([553bdbb](https://github.com/ar-io/ar-io-sdk/commit/553bdbb2aaff0a26a0aeaa34c9ec614379d30dca)) +* **tests:** update tests for named prop expectation ([4ea04a7](https://github.com/ar-io/ar-io-sdk/commit/4ea04a735ec8c0a0c0cc8859d7bfa42bd6f9110e)) +* **tests:** update tests to use younger contract, add evalParams config ([ae890c8](https://github.com/ar-io/ar-io-sdk/commit/ae890c85f5fca785f88c60a751fb617b2389de61)) +* **tests:** update tests with constants and update types ([1bdcfeb](https://github.com/ar-io/ar-io-sdk/commit/1bdcfebae93123aa46f500ebbd9693d3e1e36ef6)) +* **tests:** update tests with new name ([2cd1b5c](https://github.com/ar-io/ar-io-sdk/commit/2cd1b5ce18ed63c2b787d70e7e502aade26315eb)) +* **tests:** update with new names on methods ([619c193](https://github.com/ar-io/ar-io-sdk/commit/619c193d210536a2e4ee1308805ce348298b42c8)) +* **tests:** use angela for testing ([10f30fe](https://github.com/ar-io/ar-io-sdk/commit/10f30fe0770cb2cfef4f0a2ce18a4c5e4fe5ce77)) +* **tests:** use http not https in tests ([fddba1e](https://github.com/ar-io/ar-io-sdk/commit/fddba1e34c9a195cb6a5cdcf3ec6f3dcbd41524c)) +* **tests:** use process vars as priority url ([faab4f3](https://github.com/ar-io/ar-io-sdk/commit/faab4f3ee7624828cb25a32b6ecfb655cd5c1fc5)) +* **test:** update test to use ArweaveTransactionID class ([f6c4f8b](https://github.com/ar-io/ar-io-sdk/commit/f6c4f8ba23a921eba281596b29dff3fece82b322)) +* **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](https://github.com/ar-io/ar-io-sdk/commit/d412d44dc9fd71fe6a81deb37e99b8c24f6b4661)) +* **tyeps:** set types to objects rather than top level params for easier readability ([edfd77b](https://github.com/ar-io/ar-io-sdk/commit/edfd77bb01f38c21f2e96aacaea07705372fe664)) +* **type:** rename all type implementations ([5959045](https://github.com/ar-io/ar-io-sdk/commit/595904509e152188eeadb07fbf57495b941a45bf)) +* **types and tests:** update evalTo to allow undefined sortKey and block and test that ([a59f05c](https://github.com/ar-io/ar-io-sdk/commit/a59f05c8669750b59b01ee140bcd84d91b9cfaf8)) +* **types:** add @ to records ([53601c1](https://github.com/ar-io/ar-io-sdk/commit/53601c1d08f7bf3e522f25b58e514b0c809ad195)) +* **types:** make props nullable on certain read apis ([f8ff552](https://github.com/ar-io/ar-io-sdk/commit/f8ff552ed6de9516476e74e6aad92e72a8d3adb3)) +* **types:** remove any type ([5c80242](https://github.com/ar-io/ar-io-sdk/commit/5c8024261b5e13ee4f4d697b545a710b7cf136d1)) +* **types:** remove any types ([d8d910b](https://github.com/ar-io/ar-io-sdk/commit/d8d910b9f2d0b95232ccf3c52e74f57b086df435)) +* **types:** remove ArweaveTransactionID type for now ([3adf53b](https://github.com/ar-io/ar-io-sdk/commit/3adf53bd54041bc5dbc6956586bfebcfe66bd71c)) +* **types:** remove unnecesssary empty defaults ([7d14edb](https://github.com/ar-io/ar-io-sdk/commit/7d14edb55c7db6a949d717fe19ffe1ae87916a9d)) +* **types:** rename signer to ContractSigner ([87d6c90](https://github.com/ar-io/ar-io-sdk/commit/87d6c90b625b8bb97d68ea89d63d7a97ea894051)) +* **types:** require atleast one param to update gateway settings ([857ebdc](https://github.com/ar-io/ar-io-sdk/commit/857ebdc1b0dd39d5b12943f9b15dd0ddb9b5785e)) +* **types:** update interaction type to only use read for now ([2c02e90](https://github.com/ar-io/ar-io-sdk/commit/2c02e90076bc0fe8580bef041cd7c07e65db43d9)) +* **types:** update tests, readme, and types ([e9985dd](https://github.com/ar-io/ar-io-sdk/commit/e9985ddada117561f8e666d133b3d573e0beef3e)) +* **types:** use partial write type ([fa6a638](https://github.com/ar-io/ar-io-sdk/commit/fa6a638ae9d69b234b264c3e510c09709fc56fd8)) +* **types:** use string instead of any ([014a262](https://github.com/ar-io/ar-io-sdk/commit/014a26210b2482b3aa5150b4fd37925760f39dd8)) +* **validate id:** make validator a private method ([dce4a94](https://github.com/ar-io/ar-io-sdk/commit/dce4a948e38ae0f6af3658dcb066861c766f5ed9)) +* **validity util:** isBlockheight check more strict ([2b28675](https://github.com/ar-io/ar-io-sdk/commit/2b28675fabb97be0cadfbc8a47241b0bcc5bd9fd)) +* **warp contract:** added test for getting state after connecting with warp ([060ee2c](https://github.com/ar-io/ar-io-sdk/commit/060ee2c4a8bc21c345eb6ab006c3da41b29ff7d5)) +* **warp-contract:** provide logger - update isTransaction flow ctrl - use typed props ([5f6e0a1](https://github.com/ar-io/ar-io-sdk/commit/5f6e0a17662e43d4b2d560fcd505a07e006a308b)) +* **warp-contracts:** bump warp to 1.4.38 - fixed warp exports ([af4a20b](https://github.com/ar-io/ar-io-sdk/commit/af4a20b0df97867327bdfea12f4eb1956d531352)) +* **winston:** move the winston polyfill - this will prevent any esm based web projects from getting polyfill issues ([c8b7998](https://github.com/ar-io/ar-io-sdk/commit/c8b7998db824506c1e213557e859604d903aab9c)) +* **write:** add dry run - sync state - abortSignal - update interface ([970bdef](https://github.com/ar-io/ar-io-sdk/commit/970bdefaff2eea93e3c0783dccafd6276a80ea03)) +* **write:** update utils - change error flow - update arweave constructor props ([0a81c92](https://github.com/ar-io/ar-io-sdk/commit/0a81c920e82c03beba7dad41c189c00e128ced10)) +* **write:** update write methods on warp ([9c0540b](https://github.com/ar-io/ar-io-sdk/commit/9c0540b1f98af68ada417e1e052d282a1c93fb07)) +* **yarn:** update lockfile ([fd5e0ee](https://github.com/ar-io/ar-io-sdk/commit/fd5e0ee013a40568e88a06ff4ac1e630559a68c0)) + + +### Features + +* **ant:** add ANT read interface ([c941c96](https://github.com/ar-io/ar-io-sdk/commit/c941c96cd201983270cc9e04c0fcaa5b4dc3b798)) +* **ant:** create ant contract class for interacting with ant contracts ([6eb7ef5](https://github.com/ar-io/ar-io-sdk/commit/6eb7ef5ed7f0ec3e64e0c18e97a708d7c528ff21)) +* **ants:** add readable-writable framework to the ant client and implement write methods ([3019f53](https://github.com/ar-io/ar-io-sdk/commit/3019f53953d362629a34c6282012b58de1171b23)) +* **ario contract:** add distributions and observation apis ([21e38d1](https://github.com/ar-io/ar-io-sdk/commit/21e38d1229e640a1cec685f491b1b07b84ee6a56)) +* **arioContract:** update ArIO interface and ArIOContract interface ([5d87e2e](https://github.com/ar-io/ar-io-sdk/commit/5d87e2e9b707e30caaf960585e3300efbab420bb)) +* **auctions:** add auctions apis ([faf08c5](https://github.com/ar-io/ar-io-sdk/commit/faf08c51f3b499e158e96cc2a0b97a06a20c6f8c)) +* **contract:** add distribution, observations apis, update readme and examples ([0208317](https://github.com/ar-io/ar-io-sdk/commit/0208317c211d659afbbc55d06345a0c33cd076eb)) +* **contract:** create new contract classes that impelement both warp and remote cache for ant contract and ar-io contracts ([855da2d](https://github.com/ar-io/ar-io-sdk/commit/855da2d1ce53ade61025e9a2513ac706e362e0b1)) +* **first issue:** setup examples, readme, and initial gateways provider ([5a9e232](https://github.com/ar-io/ar-io-sdk/commit/5a9e2320219b8b61dec1cf8d0ecb74562b9ebed0)) +* **gar methods:** add gar write methods to the ario client ([e01b08b](https://github.com/ar-io/ar-io-sdk/commit/e01b08beccb64112ae4ec333e9a5a2ea872b816f)) +* **inital providers:** scaffold initial providers ([4949514](https://github.com/ar-io/ar-io-sdk/commit/4949514a334eda107c87c77bef87ec839144c99f)) +* **io transfer:** add transfer api to ario writable client ([0d37623](https://github.com/ar-io/ar-io-sdk/commit/0d37623bdf0a460242ac8d2b6f819f686fb2cbce)) +* **observerations:** add `saveObservations` write interaction ([8dd977c](https://github.com/ar-io/ar-io-sdk/commit/8dd977c55091b038c6b4a1b30fbeed5bc816f433)) +* **observers:** add API for fetching prescribed observers ([a18e130](https://github.com/ar-io/ar-io-sdk/commit/a18e1306b185143b3b44416da168bf0610418d9c)) +* **observers:** add API for fetching prescribed observers ([#17](https://github.com/ar-io/ar-io-sdk/issues/17)) ([17ce6de](https://github.com/ar-io/ar-io-sdk/commit/17ce6de4aea61e5f97c999cdc96011dd911f7ad6)) +* **PE-5742:** add records api to arns remote cache ([#8](https://github.com/ar-io/ar-io-sdk/issues/8)) ([c46cd39](https://github.com/ar-io/ar-io-sdk/commit/c46cd3968efe31f9dac3c6368b073b97adfaeb2a)) +* **PE-5751:** add blockheight and sortkey eval filters ([#12](https://github.com/ar-io/ar-io-sdk/issues/12)) ([832a1ad](https://github.com/ar-io/ar-io-sdk/commit/832a1ad20f06407f21d87ad38111f1bae794efbc)) +* **PE-5758:** add signer to ario class ([#20](https://github.com/ar-io/ar-io-sdk/issues/20)) ([1b82077](https://github.com/ar-io/ar-io-sdk/commit/1b820774104d90f2bcbec9a18c8fbca891616f7b)) +* **PE-5759:** observations and distributions apis ([#16](https://github.com/ar-io/ar-io-sdk/issues/16)) ([dded361](https://github.com/ar-io/ar-io-sdk/commit/dded3619784561b416297855724fc5924a1cd1d0)) +* **PE-5773:** add auctions read apis ([#18](https://github.com/ar-io/ar-io-sdk/issues/18)) ([e0c6fca](https://github.com/ar-io/ar-io-sdk/commit/e0c6fca49788b361478aca85d3dae3ca96f6aa97)) +* **PE-5800:** add epoch apis ([48ee4ba](https://github.com/ar-io/ar-io-sdk/commit/48ee4ba04e162c09e0d75c0194119fa9c76649d4)) +* **PE-5800:** epoch apis ([#15](https://github.com/ar-io/ar-io-sdk/issues/15)) ([70563b1](https://github.com/ar-io/ar-io-sdk/commit/70563b18f07a31d001cc4610297182860536c2df)) +* **PE-5825:** ANT read interface ([#19](https://github.com/ar-io/ar-io-sdk/issues/19)) ([6a0c477](https://github.com/ar-io/ar-io-sdk/commit/6a0c47754689071d292eaebfa7b3af6c8e851fa4)) +* **records:** add records api to arns remote cache ([1b7f54f](https://github.com/ar-io/ar-io-sdk/commit/1b7f54fb04d8fe390345eb47a3402744e2293709)) +* **signer:** add arweave signer to ario class ([7e08097](https://github.com/ar-io/ar-io-sdk/commit/7e08097e9abccf4a57673209751b2cd2fc25b746)) +* **write:** add write interface and base implementation on warp-contract ([6dfc969](https://github.com/ar-io/ar-io-sdk/commit/6dfc969a23dd965fe169edeacf117aed8e59d642)) diff --git a/README.md b/README.md index 21f8ab42..abbb36b5 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting - [Custom Contracts](#custom-contracts) - [Arweave Name Tokens (ANT's)](#arweave-name-tokens-ants) - [APIs](#apis-1) - - [`init(signer)`](#initsigner) + - [`init({ signer })`](#init-signer-) - [`getOwner({ evaluationOptions })`](#getowner-evaluationoptions-) - [`getControllers({ evaluationOptions })`](#getcontrollers-evaluationoptions-) - [`getRecords({ evaluationOptions })`](#getrecords-evaluationoptions-) @@ -790,7 +790,7 @@ The ANT contract client class exposes APIs relevant to compliant Arweave Name To ### APIs -#### `init(signer)` +#### `init({ signer })` Factory function to that creates a read-only or writeabe client. By providing a `signer` additional write APIs that require signing, like `setRecord` and `transfer` are available. By default, a read-only client is returned and no write APIs are available. diff --git a/package.json b/package.json index 9288f5b7..b3df5210 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ar.io/sdk", - "version": "1.0.0-alpha.26", + "version": "1.0.0", "repository": { "type": "git", "url": "git+https://github.com/ar-io/ar-io-sdk.git" diff --git a/src/version.ts b/src/version.ts index 566b94d0..c32cbf62 100644 --- a/src/version.ts +++ b/src/version.ts @@ -17,4 +17,4 @@ // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH -export const version = '1.0.0-alpha.26'; +export const version = '1.0.0';