fix(types): simplify types for init functions, cleanup contructors #345
Conversation
| @@ -126,7 +126,7 @@ | |||
| "dependencies": { | |||
| "@dha-team/arbundles": "^1.0.1", | |||
| "@permaweb/aoconnect": "^0.0.57", | |||
| "arweave": "1.14.4", | |||
| "arweave": "1.15.5", | |||
There was a problem hiding this comment.
this always makes me nervous. will do some validations across our clients (observer, ar-io-node, network-portal, arns.app) to validate if it causes any issues
There was a problem hiding this comment.
minor version bump -- "Drop Node 16 Support". that semantic versioning 😂
dtfiedler
force-pushed
the
type-cleanup-v2
branch
from
4f1c3b6 to
bcd0970
Compare
| it.skip('should be able to instantiate ARIO with a process and arweave', async () => { | ||
| const ario = ARIO.init({ | ||
| process: new AOProcess({ | ||
| processId, | ||
| }), | ||
| arweave, | ||
| }); | ||
| assert(ario instanceof ARIOReadable); | ||
| }); |
There was a problem hiding this comment.
is this meant to be removed or unskipped?
The init overloads can be hard to parse. This hopefully introduces new types that can be extended if/when necessary. Addittionally adds e2e tests validating the instance types returned for all major classes. We can look to leverage unit tests more to avoid the entire docker setup when doing this simple type validations/checks.
dtfiedler
force-pushed
the
type-cleanup-v2
branch
from
bcd0970 to
a580d79
Compare
tests/e2e/esm/index.test.ts
Outdated
| it('should be able to get a specific vault', async () => { | ||
| const { items: vaults } = await ario.getVaults(); | ||
| if (vaults.length > 0) { | ||
| const vault = await ario.getVault({ | ||
| address: vaults[0].address, | ||
| vaultId: vaults[0].vaultId, | ||
| }); | ||
| assert.deepEqual(vault, { | ||
| balance: 1, | ||
| startTimestamp: 1729962428678, | ||
| endTimestamp: 1731172028678, | ||
| }); | ||
| } |
There was a problem hiding this comment.
this doesn't seem stable. that vault will end at 1731172028678. maybe just assert the types?
There was a problem hiding this comment.
yes - good catch
There was a problem hiding this comment.
hmm, 1731172028678 is actually in GMT: Saturday, November 9, 2024 5:07:08.678 PM
I'm guessing this is just getting no vaults atm
|
🎉 This PR is included in version 3.3.0-alpha.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
I introduced a bug when adding
arweaveas an optional type in #337. It's easy to overlook what our overloadedinitfunctions expect. This hopefully introduces new types that can be extended if/when necessary. Additionally, i've added e2e tests validating the instance types returned for all major classes. We can look to leverage unit tests more to avoid the entire docker setup when doing these simple type validations/checks.