crypto-aio 0.1.0 → 1.0.0-rc.1

package/CHANGELOG.md

@@ -7,11 +7,229 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0-rc.1] - 2026-11-12
+
+The release candidate for 1.0.0. It keeps the API 0.2.0 settled and writes down the
+contract 1.0 keeps: [Versioning and
+stability](https://vhidvz.github.io/crypto-aio/reference/stability.html) lists what semver
+covers surface by surface, [Errors](https://vhidvz.github.io/crypto-aio/reference/errors.html)
+the safe action for every code and the error fields you may rely on, and the plugin and
+store pages what a driver and a durable store must do. It closes the gaps a review of every
+page found in the surfaces 1.0 freezes. Code written for 0.2.0 needs no change unless it
+reads Tron block times (now Unix seconds, as on every family) or writes a plugin driver
+that misdeclares its capabilities; [Upgrade to
+1.0](https://vhidvz.github.io/crypto-aio/reference/upgrading.html) says what changed. It is
+published under npm's `next` tag: `npm install crypto-aio@next`.
+
+### Added
+
+- `CallOptions.endpointLimit`: a transport read without a quorum can mark a definitive
+  refusal as the endpoint's own limit, so the read asks the endpoints it has not asked
+  instead of failing; the refusal stands only when every endpoint refuses.
+
+### Changed
+
+- `stringifyTagged` refuses, with a `TypeError`, a plain object whose only key is `$bigint`
+  or `$bytes` (with a string value): `parseTagged` would read it back as a bigint or bytes,
+  so a durable store built on them refuses the write instead of storing data that reads
+  back changed. The format they write is unchanged, and the core never stores such an
+  object.
+- A plugin driver that does not implement a capability its manifest and network declare
+  (`ChainDriver.capabilities`), or that orders Attempts otherwise than its chain
+  (`ordering`), is refused with `CONFIG_INVALID` when its handle first loads it, instead
+  of failing later at a port it lacks.
+- During a rolling upgrade, `aio.operations.list()` and `recover()` leave out an
+  Operation a newer version stored, with a logged warning, instead of throwing
+  `RECORD_FORMAT_UNSUPPORTED` on the first one; a read by id, key or ref still throws.
+- `Scanner`'s constructor is private, so its internal dependencies leave the declarations;
+  scanners come from `bc.scanner()`, as before (the package exports `Scanner` as a type
+  only).
+- `OperationStore.findByRef` is specified for several Operations of a namespace holding
+  one ref, which the core never writes: a store may return any one of them.
+- **Breaking (Tron):** block and transaction `timestamp`s are Unix seconds on every family.
+  Tron reported java-tron's milliseconds, so the same field meant another unit there;
+  multiply by 1,000 where you relied on milliseconds. Drivers report seconds too.
+- The documentation states the 1.0 contract and corrects what 0.2.0 left stale: proofs
+  as 0.2.0 sizes them (a down endpoint still counts, so production wants three or more
+  providers), `TX_UNEVIDENCED` as a failure where value may have moved, what abandoning a
+  signed transfer leaves possible on each family, Avalanche change in deposit crediting,
+  TON's 512-transaction proof window, each family's covered fee and `ext` shapes, the
+  rules a driver and a durable store must keep, and a production checklist covering
+  stores, providers, keys, workers, monitoring and upgrades. 26 more snippets are
+  type-checked by the docs tests.
+
+### Removed
+
+- The repository's Dependabot configuration: the nightly run tests the newest release of
+  every chain SDK, and GitHub's security updates work without it. The runtime
+  dependencies `@noble/*` and `@scure/*` stay on their 1.x lines, since their 2.x lines
+  are ES modules only, which Jest's CommonJS loader cannot `require`; the pack check now
+  loads every entry point under Jest.
+
+### Fixed
+
+- Bitcoin: an indexer that refuses an address for its own limit (HTTP 400 "Scripthash
+  history too large to scan" or "Too many unspent transaction outputs") no longer fails the
+  balance, unspent-output or history read when another `indexer` endpoint is configured:
+  the read asks it. blockstream.info started refusing busy addresses this way, which failed
+  the nightly signet suite.
+
+## [0.2.0] - 2026-10-21
+
+crypto-aio 0.2.0 settles everything 1.0 will promise: the API is locked by reports in CI,
+the driver port is final, stored Operations carry a record format, and the gaps that could
+make a paid transfer look failed are closed. Entries marked **Breaking** need a change from
+some users; [Upgrade to 1.0](https://vhidvz.github.io/crypto-aio/reference/upgrading.html)
+says what to do for each.
+
+### Added
+
+- `SECURITY.md`: how to report a vulnerability privately, and what is in scope.
+- Operation records carry `format` (`OPERATION_FORMAT`, 1), the record format they were
+  stored in; a record without one (0.1.0) reads as format 1. A process never reads a record
+  of a newer format: the read throws the new `RECORD_FORMAT_UNSUPPORTED`, and a worker
+  releases its claim for a newer process. The `OperationStore` contract suite checks that
+  a store keeps `format`, and tests pin the intent hash and the store keys as 0.1.0 wrote
+  them.
+- API reports (`etc/api/*.api.md`, one per entry point), generated by API Extractor: CI fails
+  when the public API changes without its report (`pnpm api:update`).
+- Release tooling: a tag such as `1.0.0-rc.1` publishes under npm's `next` dist-tag, a
+  release tag must match `package.json` and have a `CHANGELOG.md` section, which becomes the
+  GitHub Release's notes, and a release runs every CI check before it publishes.
+- CI runs on Node.js 22.12.0, 22, 24 and 26, audits the runtime dependencies, and checks the
+  package's exports and types with `publint` and `@arethetypeswrong/cli`
+  (`pnpm lint:package`). CodeQL and Dependabot are configured.
+
+### Changed
+
+- **Breaking:** crypto-aio needs Node.js 22.12 or later (`engines.node` is `>=22.12`), the
+  version every family already needed for Solana. `engines` no longer names an npm version,
+  so npm 11 installs without an engine warning.
+- `package.json` declares `"type": "commonjs"`.
+- **Breaking:** a transfer whose transaction executed but shows no transfer to the
+  recipient fails with the new `TX_UNEVIDENCED`, not `TX_REVERTED`: an EVM or Tron token
+  that logged no `Transfer` to the recipient, or TON jettons sent to a wallet the master
+  does not name. Value may have moved, so check the chain before paying again; a
+  `TX_REVERTED` now always means the execution failed. Drivers say which with
+  `failure: 'reverted' | 'unevidenced'` (`TxFailure`) on `observe` and `includedFinal`, and
+  the core keeps it on the Attempt's observation (`failure`, a field stores must keep).
+- **Breaking:** an endpoint reads `healthy` in `status()` and `getNetworkStatus()` only
+  once its height is known, when its family probes heights: before that it is `unknown`,
+  where a confirmed identity alone used to make it `healthy`.
+- **Breaking:** a proof needs `proofQuorum` endpoints even after some drop out of its count
+  (down for three health intervals): the quorum is capped by the endpoints configured, not
+  by those still counted, so the one endpoint left never proves alone; proofs wait for the
+  others instead. The new `transport.degradedProofs: true` restores the old behavior, which
+  favours liveness.
+- `lifecycle.leaseWaitMs` (default: `leaseMs`): how long a transfer waits for its wallet's
+  address lease before `SEQUENCE_BUSY`, so transfers can queue behind a slow signer.
+- Fuzz tests feed every decoder of untrusted bytes (Solana messages and transactions, Tron
+  protobuf, Bitcoin and EVM raw transactions, Avalanche transactions, cb58, exact-integer
+  JSON) random and mutated input; they may refuse it, never throw an unclassified error.
+  A nightly workflow runs them deeper, runs the live read-only integration suites, and
+  runs the unit suites on the newest release of every SDK.
+- The pack check compiles a project that imports every entry point with TypeScript 5.3 (the
+  oldest supported, with `skipLibCheck`), the tested 5.9 and 7, under `nodenext` and
+  `bundler` resolution.
+- `@solana/web3.js` 3 is supported next to 1.99 (peer range `^1.99.0 || ^3.0.0`). The
+  Solana driver now compiles its messages and derives token account addresses itself
+  (checked byte for byte against the SDK), so signed bytes no longer depend on the SDK
+  version; the SDK only backs `native()`. The pack check loads the family with 3.x too.
+- `BuildContext.decimals`: the decimals the core scaled a transfer's amounts with. The
+  Solana driver refuses a token transfer whose mint has other decimals
+  (`ASSET_RESOLUTION`), which a wrong registration would otherwise sign as a mis-scaled
+  `transferChecked`.
+- `ReplacementPolicy.comparePrice` (optional): the EVM family ranks earlier cancels by
+  price, so a repeat cancel climbs from the highest one without an explicit `fee`.
+- `assets` on the root container's options registers tokens (decimals, symbol, aliases)
+  without writing a plugin.
+- `PROVIDER_MISCONFIGURED` for refused credentials carries `details.httpStatus` (401 or 403).
+- Solana: the signature fee is computed (5,000 lamports per signature), and an endpoint's
+  `getFeeForMessage` quote must match the message's fee exactly; any other quote fails the
+  estimate with a retryable `PROVIDER_UNAVAILABLE`, so one endpoint can neither inflate an
+  estimate (refusing a payable transfer) nor deflate it. Whether an explicit fee fits in
+  u64 is decided locally.
+- **Breaking:** Bitcoin: a wallet whose signer does not declare the scheme its address type
+  signs with (a `p2tr` wallet on an ECDSA-only signer, such as a KMS key) is refused with
+  `CONFIG_INVALID` when the wallet resolves (`ready()`, `walletAddress()`, `transfer()`,
+  `prepareTransfer()`), before anything is built or reserved, instead of failing at
+  signing. A Schnorr-only signer on a non-`p2tr` wallet gets the same error, where it got
+  `INVALID_ADDRESS`. Watch-only wallets are unaffected. Drivers declare this with the
+  optional `ChainDriver.signingSchemes(wallet)`.
+- **Breaking:** EVM and Tron: a token whose contract answers `deprecated()` with `true`
+  (Tether's `TetherToken`, USDT on Ethereum and Tron) is refused before signing with
+  `ASSET_RESOLUTION`, rather than sent through a contract that forwards it and logs no
+  `Transfer`. Every token estimate makes one more read.
+- **Breaking:** EVM: the `maxGasLimit` option (`chains.<id>.options`, a handle's `options`,
+  or a network's `params.maxGasLimit`) bounds the gas limit of every transfer, replacement
+  and cancel, by default 2^24 (`DEFAULT_MAX_GAS_LIMIT`, Ethereum's EIP-7825 cap). An
+  estimate (with its headroom) or an override above it fails with `INVALID_INTENT` before
+  signing (`details.required`, `details.maxGasLimit`).
+- EVM: on OP Stack chains since Isthmus, the operator fee (`GasPriceOracle.getOperatorFee`
+  for the gas limit) is its own `operator` charge and `details.operatorFee`, counted in
+  `details.expected` and the funds check.
+- **Breaking:** the Bitcoin scanner reads each block's own bytes (`/block/:hash/raw`) and
+  delivers only transactions its header commits to: the merkle root (refusing the
+  CVE-2012-2459 duplicate), a coinbase first, and the BIP141 witness commitment; the header
+  read at the height must match those bytes. A scanned transaction's `from`, input values and
+  fee come from the previous transactions' bytes, checked against the txids its inputs name.
+  A block that does not match is a retryable `PROVIDER_INCONSISTENT` and decides nothing. A
+  filtered scan uses the indexer's JSON pages only to find spends from watched addresses,
+  checked against the bytes; an unfiltered one reads one previous transaction per distinct
+  parent outside the block, so scan with `filter.addresses`. `details.vout[].type` is named
+  from the script, as Blockstream electrs names it.
+- The transport's `http` reads a binary answer with `responseType: 'bytes'`, within
+  `maxResponseBytes`.
+- A reference PostgreSQL implementation of the four store ports, in
+  `examples/postgres-store` (schema, source, README; not part of the package), passes every
+  store contract suite and an engine crash-and-recover run against PostgreSQL 16 in CI.
+- `pnpm test:evm-local` proves the EVM write path on a local anvil node, with ethers and
+  web3: proven finality, idempotent repeats, concurrent nonces, an ERC-20, replace, cancel,
+  crash recovery, funds checks and a reorg. CI runs it on every change.
+- **Breaking:** an idempotency key and a scanner's `cursorKey` must be well-formed text
+  without U+0000 (`INVALID_INTENT`, `CONFIG_INVALID`): a database may refuse U+0000, and a
+  driver may turn a lone surrogate into U+FFFD, so two keys would become one.
+- The store ports say which clock stamps times (the container's, or a wall clock the
+  processes share), and that a store may refuse an attempt id another Operation holds; the
+  contract suite no longer reuses one. `createFakeEnv` takes a `clock`, so stores built
+  beforehand can share it, and `FaultyOperationStore` passes `purge` through. The memory
+  store lists and purges nothing for a negative `limit`, as for 0.
+- `RecoveryReport.unresent`: a `signed` or ambiguous Operation whose wallet no longer
+  resolves is now checked on chain and counted `unresent`, where it was counted `failed`
+  without its check.
+- **Breaking (types only):** `Blockchain`'s constructor is private (handles come from
+  `aio.blockchain()` or `Blockchain.create()`), and its internal `protected` methods are gone
+  from the type declarations. `CryptoAio`'s constructor has one signature, `(options?)`.
+
+### Deprecated
+
+- `library: 'web3'` (and `Library.WEB3`): web3.js is no longer maintained upstream (4.16.0 is
+  its last release). It keeps working through 1.x, warns once per process with a
+  `DeprecationWarning` (code `CRYPTO_AIO_WEB3`), and is removed in 2.0. Use `ethers`.
+
+### Fixed
+
+- `evmChainPlugin` registers each `assets` ERC-20 under its EIP-55 checksummed contract,
+  whatever case it is given in, so a token's alias, its ref, its transfers and its balances
+  share one asset id (a lower-case contract made two assets, and deposits missed the
+  alias's). A token of another standard, a malformed contract, or a mixed-case contract with
+  a wrong checksum is refused with `CONFIG_INVALID` at registration.
+- `stringifyTagged` encodes a Node.js `Buffer` as bytes, as the memory store keeps it; it was
+  written as `{ type: 'Buffer', data }` and read back as a plain object by a durable store.
+- TON: `transfer bounced` and `jetton transfer bounced` no longer rest on the indexer's
+  word. The provider's raw records of the wallet transaction and of each delivery, checked
+  against their hashes and linked by message hash, must show the bounce; until they do, or
+  while the provider's endpoints disagree, the transfer stays undecided (a warning with code
+  `BOUNCE_UNPROVEN` when they contradict the indexer). A lone lying indexer can delay a
+  verdict, never fail a transfer that landed.
+
 ## [0.1.0] - 2026-10-01
 
 ### Added
 
-- initial release 🎉​🎊​.
+- initial release 🎉🎊.
 
-[Unreleased]: https://github.com/vhidvz/crypto-aio/compare/0.1.0...HEAD
+[Unreleased]: https://github.com/vhidvz/crypto-aio/compare/1.0.0-rc.1...HEAD
+[1.0.0-rc.1]: https://github.com/vhidvz/crypto-aio/compare/0.2.0...1.0.0-rc.1
+[0.2.0]: https://github.com/vhidvz/crypto-aio/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/vhidvz/crypto-aio/releases/tag/0.1.0

package/README.md

@@ -1,11 +1,20 @@
-# crypto-aio
+<h1 align="center">
+  <a href="https://vhidvz.github.io/crypto-aio/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vhidvz/crypto-aio/main/docs/public/crypto-aio-logo-dark.svg">
+      <img alt="crypto-aio" src="https://raw.githubusercontent.com/vhidvz/crypto-aio/main/docs/public/crypto-aio-logo.svg" width="420">
+    </picture>
+  </a>
+</h1>
+
+<div align="center">
 
 [![npm](https://img.shields.io/npm/v/crypto-aio)](https://www.npmjs.com/package/crypto-aio)
 [![CI](https://github.com/vhidvz/crypto-aio/actions/workflows/ci.yml/badge.svg)](https://github.com/vhidvz/crypto-aio/actions/workflows/ci.yml)
 ![npm](https://img.shields.io/npm/dm/crypto-aio)
 [![Coverage](https://raw.githubusercontent.com/vhidvz/crypto-aio/main/coverage-badge.svg)](https://htmlpreview.github.io/?https://github.com/vhidvz/crypto-aio/blob/main/coverage/lcov-report/index.html)
 [![License](https://img.shields.io/github/license/vhidvz/crypto-aio?style=flat)](LICENSE)
-[![documentation](https://img.shields.io/badge/documentation-read_the_docs-c27cf4)](https://vhidvz.github.io/crypto-aio/)
+[![documentation](https://img.shields.io/badge/documentation-read_the_docs-5b5fef)](https://vhidvz.github.io/crypto-aio/)
 
 **One TypeScript API for moving money on blockchains.** Balances, transfers, confirmations
 and deposit scanning across EVM chains, Bitcoin, Tron, Solana, TON and the Avalanche X-Chain and
@@ -17,6 +26,8 @@ P-Chain, built for exchanges, wallets and payment systems.
 [Examples](https://vhidvz.github.io/crypto-aio/build/examples.html) ·
 [API](https://vhidvz.github.io/crypto-aio/reference/api.html)
 
+</div>
+
 ## Why crypto-aio
 
 Every chain has an SDK that can build, sign and send a transaction. None of them is a payment
@@ -26,11 +37,13 @@ node that says "final" about a block that is later replaced. crypto-aio is the l
 those cases, written once, with the same API on every chain:
 
 - **Pay exactly once.** Every transfer carries your own idempotency key. Repeat the call after a
-  timeout, a crash or a lost reply, and you get the same payment back, never a second one.
-- **Crash-safe.** A signed transaction is stored before it is sent. After a restart, the library
-  sends those exact bytes again; recovery never signs.
+  timeout, a crash or a lost reply, and you get the same payment back, never a second one
+  (across restarts too, with durable stores).
+- **Crash-safe.** With durable stores, a signed transaction is stored before it is sent. After
+  a restart, the library sends those exact bytes again; recovery never signs.
 - **Final means proven.** A transfer is final only on finalized chain data that a quorum of
-  independent endpoints agree on, never on one node's word.
+  independent endpoints agree on, never on one node's word, once you configure two or more
+  (three keep proofs going through an outage).
 - **Deposits that survive reorgs.** Durable scanners deliver every block at least once, and roll
   back when the chain reorganizes.
 - **Keys stay with signers.** In memory, or behind your HSM, KMS or MPC custody, with a policy
@@ -46,10 +59,10 @@ principles, starting with [what a ledger is](https://vhidvz.github.io/crypto-aio
 
 | Family | Chains | Through |
 | --- | --- | --- |
-| EVM | Ethereum, BNB Smart Chain, Polygon, Avalanche C-Chain, Arbitrum, Optimism, Base, and any EVM chain you add | `ethers` 6 (default) or `web3` 4 |
+| EVM | Ethereum, BNB Smart Chain, Polygon, Avalanche C-Chain, Arbitrum, Optimism, Base, and any EVM chain you add | `ethers` 6 (or the deprecated `web3` 4) |
 | Bitcoin | mainnet, testnet, testnet4, signet, regtest | `bitcoinjs-lib` 7 and an Esplora indexer |
 | Tron | mainnet, Shasta, Nile | `tronweb` 6 |
-| Solana | mainnet, devnet, testnet | `@solana/web3.js` 1 |
+| Solana | mainnet, devnet, testnet | `@solana/web3.js` 1 or 3 |
 | TON | mainnet, testnet | `@ton/ton` 16 and toncenter |
 | Avalanche X-Chain and P-Chain | mainnet, Fuji | `@avalabs/avalanchejs` 5 and the Avalanche Data API |
 
@@ -58,11 +71,11 @@ What each network supports, family by family, is in
 
 ## Install
 
-crypto-aio needs Node.js 22 or later (Solana: 22.12 or later). Install the package, and only the
+crypto-aio needs Node.js 22.12 or later. Install the package, and only the
 SDK of each family you use:
 
 ```sh
-npm install crypto-aio ethers           # EVM chains (or web3)
+npm install crypto-aio ethers           # EVM chains
 npm install crypto-aio bitcoinjs-lib    # Bitcoin
 npm install crypto-aio tronweb          # Tron
 npm install crypto-aio @solana/web3.js  # Solana
@@ -71,6 +84,9 @@ npm install crypto-aio @avalabs/avalanchejs  # Avalanche X-Chain and P-Chain
 ```
 
 A handle whose SDK is missing fails with `DEPENDENCY_MISSING` and names the install command.
+The type declarations need TypeScript 5.3 or later, and each family's entry point
+(`crypto-aio/evm`, …) the types of its SDK; some SDKs' own declarations need TypeScript 5.7
+unless `skipLibCheck` is on. TypeScript 7 is supported.
 
 ## Your first transfer, with no network and no keys
 
@@ -104,6 +120,7 @@ configure({
   },
   signers: { hot: localSigner({ id: 'hot', secp256k1: secret(process.env.HOT_KEY ?? '') }) },
   wallets: { treasury: { signer: 'hot' } },
+  // Two providers cross-check every proof; production wants three, so one outage never stalls it.
   chains: { ethereum: { network: 'sepolia', provider: ['alchemy', 'infura'], wallet: 'treasury' } },
   lifecycle: { requireIdempotencyKey: true },
 });
@@ -115,6 +132,7 @@ console.log((await eth.getBalance(me.canonical)).amount.format()); // e.g. '0.5
 const sub = await eth.transfer(
   { to: '0x3535353535353535353535353535353535353535', amount: '0.01' },
   { idempotencyKey: 'withdrawal-42' }, // your own id: repeating the call never pays twice
+  // (across restarts too, once `stores` are durable)
 );
 const { status } = await sub.wait({ finality: 'final' });
 console.log(status.state, status.evidence); // 'final' 'proven'
@@ -137,16 +155,24 @@ family.
 
 ## Status
 
-crypto-aio is at **0.1.0**, the first release of this API; the 0.0.x releases on npm are an older,
-unrelated API. Before 1.0, some extension interfaces may still change
-([what is stable](https://vhidvz.github.io/crypto-aio/reference/stability.html)). Only in-memory
-stores ship: production needs durable stores of your own, proven with the contract suites in
-`crypto-aio/testing`. Release notes are in the [changelog](CHANGELOG.md).
+crypto-aio 1.0 is in release candidate: **1.0.0-rc.1**, on npm's `next` tag
+(`npm install crypto-aio@next`). From 1.0.0, [semantic
+versioning](https://vhidvz.github.io/crypto-aio/reference/stability.html) covers what that
+page lists: the API, the driver port and what a process stores, but not `crypto-aio/native`
+or message texts. The 0.0.x releases on npm are an older, unrelated API. [Known
+limitations](https://vhidvz.github.io/crypto-aio/reference/limitations.html) lists what it
+does not do yet, and [Upgrade to 1.0](https://vhidvz.github.io/crypto-aio/reference/upgrading.html)
+what changes from 0.2.0 and 0.1.0. Only in-memory stores ship: production needs durable stores of your
+own, proven with the contract suites in `crypto-aio/testing`; [examples/postgres-store](examples/postgres-store)
+is a reference implementation on PostgreSQL. Release notes are in the [changelog](CHANGELOG.md).
 
 ## Contributing
 
 Issues and pull requests are welcome. `pnpm install` and `pnpm check` (lint, typecheck and tests)
-are all a change needs locally; the [source map](https://vhidvz.github.io/crypto-aio/explore/source-map.html)
+are all a change needs locally, plus `pnpm api:update` when it changes the public API (CI
+compares the API with the reports in `etc/api/`). `pnpm test:evm-local` also signs, broadcasts
+and proves real EVM transactions on a local anvil node, which it starts and stops; CI runs it
+on every change. The [source map](https://vhidvz.github.io/crypto-aio/explore/source-map.html)
 explains the repository, and [docs/README.md](docs/README.md) how the documentation is built and
 tested.
 

package/dist/adapters/avalanche/driver.d.ts

@@ -5,6 +5,10 @@
  */
 import type { DriverFactory } from '../../core/driver/types';
 import { type AvalancheSdk, type SdkContext } from './sdk';
+/**
+ * What `native(bc, '@avalabs/avalanchejs')` hands out. It mirrors the SDK, so it is outside
+ * semver: a new avalanchejs line may change it in a minor release.
+ */
 export interface AvalancheNativeClient {
     /**
      * The `@avalabs/avalanchejs` module. Its type names the members this library uses; cast

package/dist/adapters/avalanche/driver.js.map

@@ -1 +1 @@
-{"version":3,"file":"driver.js","sourceRoot":"","sources":["../../../src/adapters/avalanche/driver.ts"],"names":[],"mappings":";;;AAMA,mDAAsD;AAEtD,+BAAwE;AACxE,uCAAgF;AAChF,mCAAqC;AACrC,uCAAuE;AACvE,uCAAgF;AAChF,qCAAoD;AACpD,qCAAkF;AAClF,+BAAsE;AAkBtE,SAAS,UAAU,CAAC,MAA8B;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;IACxD,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACrC,IAAA,gBAAU,EACR,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,mBAAmB,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAChF,CAAC,EAAE;QACN,gBAAgB,EAAE,MAAM,CAAC,cAAc;QACvC,MAAM,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACnC,IAAA,iBAAW,EACR,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,YAAY,EAAE,EAAE,CAAC,CAAiC;YAC1E,EAAE,MAAM,CACX;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,MAA8B;IACnD,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACrC,aAAO,CAAC,SAAS,CACf,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAC5E;QACH,gBAAgB,EAAE,MAAM,CAAC,cAAc;QACvC,MAAM,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACnC,aAAO,CAAC,YAAY,CAClB,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;YACxB,KAAK,EAAE,SAAS;SACjB,CAAC,CACH;KACJ,CAAC;AACJ,CAAC;AAEY,QAAA,sBAAsB,GAAkB;IACnD,KAAK,CAAC,MAAM,CAAC,GAAkB;QAC7B,MAAM,MAAM,GAAG,IAAA,gCAAsB,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,4EAA4E,CAC7E,CAAC;QACJ,CAAC;QACD,kFAAkF;QAClF,mFAAmF;QACnF,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAqB;YAC7B,IAAI,EAAE,IAAI,mBAAa,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;YACjD,OAAO,EAAE,IAAI,aAAO,CAAC,GAAG,CAAC,OAAO,CAAC;YACjC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,MAAM;YACN,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,OAAO,EAAE,IAAI,uBAAa,EAAE;SAC7B,CAAC;QACF,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,OAAO,EAAE,IAAA,qBAAY,EAAC,IAAI,CAAC;YAC3B,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,OAAO,EAAE,IAAA,0BAAgB,EAAC,IAAI,CAAC;YAC/B,WAAW,EAAE,IAAA,8BAAoB,EAAC,IAAI,CAAC;YACvC,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,OAAO,EAAE,IAAA,uBAAc,EAAC,IAAI,CAAC;YAC7B,GAAG,EAAE;gBACH,SAAS,EAAE;oBACT,WAAW,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,IAAI,EAAE,OAAO,CAAC;iBAC7D;aACqB;YACxB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,qBAAW,EAAE,CAAC;YAC3C,kBAAkB,EAAE,GAAG,EAAE;gBACvB,MAAM,MAAM,GAA0B;oBACpC,SAAS,EAAT,eAAS;oBACT,OAAO,EAAE,IAAA,kBAAU,EAAC,MAAM,CAAC;oBAC3B,GAAG,EAAE,CAAI,MAAc,EAAE,MAAgB,EAAE,EAAE,CAC3C,GAAG,CAAC,SAAS,CAAC,GAAG,CAAI,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,cAAI,CAAC;iBACnD,CAAC;gBACF,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC","sourcesContent":["/**\n * The Avalanche driver factory: validated network config, endpoint probes on both\n * transports, and the ports. Loaded only by the manifest's `load()`, with\n * `@avalabs/avalanchejs`.\n */\nimport type { ChainDriver, DriverContext, DriverFactory } from '../../core/driver/types';\nimport { ConfigError } from '../../core/errors/error';\nimport type { EndpointCall, HealthProbes } from '../../core/transport/types';\nimport { AvalancheNode, DataApi, parseBlock, parseHeight } from './api';\nimport { avalancheBroadcaster, avalancheBuilder, MAX_OUTPUTS } from './builder';\nimport { sdkContext } from './codec';\nimport { LocationCache, READ, type AvalancheContext } from './context';\nimport { avalancheNetworkConfig, type AvalancheNetworkConfig } from './network';\nimport { blockSource, proofSource } from './proofs';\nimport { addressCodec, addressHistory, chainReader, listUnspent } from './reader';\nimport { avalanche, type AvalancheSdk, type SdkContext } from './sdk';\nimport type { AvalancheExt } from './types';\n\nexport interface AvalancheNativeClient {\n  /**\n   * The `@avalabs/avalanchejs` module. Its type names the members this library uses; cast\n   * it to reach the rest of the SDK.\n   */\n  readonly avalanche: AvalancheSdk;\n  /**\n   * avalanchejs's `Context` for this network and chain (network id, HRP, AVAX asset id,\n   * this chain's id). Its fee fields are zero: read the fees from the chain.\n   */\n  readonly context: SdkContext;\n  /** A JSON-RPC call (e.g. `avm.getTxFee`) to the handle's node endpoints, through the transport. */\n  rpc<T = unknown>(method: string, params?: unknown): Promise<T>;\n}\n\nfunction nodeProbes(config: AvalancheNetworkConfig): HealthProbes {\n  const prefix = config.vm === 'avm' ? 'avm' : 'platform';\n  return {\n    identity: async (call: EndpointCall) =>\n      parseBlock(\n        await call.rpc(`${prefix}.getBlockByHeight`, { height: '0', encoding: 'json' }),\n      ).id,\n    expectedIdentity: config.genesisBlockId,\n    height: async (call: EndpointCall) =>\n      parseHeight(\n        ((await call.rpc(`${prefix}.getHeight`, {})) as { height?: unknown } | null)\n          ?.height,\n      ),\n  };\n}\n\nfunction indexerProbes(config: AvalancheNetworkConfig): HealthProbes {\n  return {\n    identity: async (call: EndpointCall) =>\n      DataApi.blockZero(\n        await call.http({ method: 'GET', path: '/blocks/0', route: '/blocks/:id' }),\n      ),\n    expectedIdentity: config.genesisBlockId,\n    height: async (call: EndpointCall) =>\n      DataApi.latestHeight(\n        await call.http({\n          method: 'GET',\n          path: '/blocks',\n          query: { pageSize: '1' },\n          route: '/blocks',\n        }),\n      ),\n  };\n}\n\nexport const avalancheDriverFactory: DriverFactory = {\n  async create(ctx: DriverContext): Promise<ChainDriver> {\n    const config = avalancheNetworkConfig(ctx.chain, ctx.network, ctx.options);\n    if (!ctx.indexer) {\n      throw new ConfigError(\n        'CONFIG_INVALID',\n        'the Avalanche driver requires an indexer provider (the Avalanche Data API)',\n      );\n    }\n    // Probes on both transports, once, before any traffic: without them an endpoint's\n    // identity is never checked, and an endpoint of another network is never disabled.\n    ctx.transport.setProbes(nodeProbes(config));\n    ctx.indexer.setProbes(indexerProbes(config));\n    const avax: AvalancheContext = {\n      node: new AvalancheNode(ctx.transport, config.vm),\n      dataApi: new DataApi(ctx.indexer),\n      chain: ctx.chain,\n      network: ctx.network,\n      config,\n      clock: ctx.clock,\n      log: ctx.log,\n      located: new LocationCache(),\n    };\n    return {\n      ordering: 'inputs',\n      capabilities: config.capabilities,\n      address: addressCodec(avax),\n      reader: chainReader(avax),\n      builder: avalancheBuilder(avax),\n      broadcaster: avalancheBroadcaster(avax),\n      proofs: proofSource(avax),\n      blocks: blockSource(avax),\n      history: addressHistory(avax),\n      ext: {\n        avalanche: {\n          listUnspent: (address: string) => listUnspent(avax, address),\n        },\n      } satisfies AvalancheExt,\n      limits: () => ({ maxOutputs: MAX_OUTPUTS }),\n      createNativeClient: () => {\n        const client: AvalancheNativeClient = {\n          avalanche,\n          context: sdkContext(config),\n          rpc: <T>(method: string, params?: unknown) =>\n            ctx.transport.rpc<T>(method, params ?? {}, READ),\n        };\n        return { client };\n      },\n    };\n  },\n};\n"]}
+{"version":3,"file":"driver.js","sourceRoot":"","sources":["../../../src/adapters/avalanche/driver.ts"],"names":[],"mappings":";;;AAMA,mDAAsD;AAEtD,+BAAwE;AACxE,uCAAgF;AAChF,mCAAqC;AACrC,uCAAuE;AACvE,uCAAgF;AAChF,qCAAoD;AACpD,qCAAkF;AAClF,+BAAsE;AAsBtE,SAAS,UAAU,CAAC,MAA8B;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;IACxD,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACrC,IAAA,gBAAU,EACR,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,mBAAmB,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAChF,CAAC,EAAE;QACN,gBAAgB,EAAE,MAAM,CAAC,cAAc;QACvC,MAAM,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACnC,IAAA,iBAAW,EACR,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,YAAY,EAAE,EAAE,CAAC,CAAiC;YAC1E,EAAE,MAAM,CACX;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,MAA8B;IACnD,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACrC,aAAO,CAAC,SAAS,CACf,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAC5E;QACH,gBAAgB,EAAE,MAAM,CAAC,cAAc;QACvC,MAAM,EAAE,KAAK,EAAE,IAAkB,EAAE,EAAE,CACnC,aAAO,CAAC,YAAY,CAClB,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;YACxB,KAAK,EAAE,SAAS;SACjB,CAAC,CACH;KACJ,CAAC;AACJ,CAAC;AAEY,QAAA,sBAAsB,GAAkB;IACnD,KAAK,CAAC,MAAM,CAAC,GAAkB;QAC7B,MAAM,MAAM,GAAG,IAAA,gCAAsB,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,4EAA4E,CAC7E,CAAC;QACJ,CAAC;QACD,kFAAkF;QAClF,mFAAmF;QACnF,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAqB;YAC7B,IAAI,EAAE,IAAI,mBAAa,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;YACjD,OAAO,EAAE,IAAI,aAAO,CAAC,GAAG,CAAC,OAAO,CAAC;YACjC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,MAAM;YACN,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,OAAO,EAAE,IAAI,uBAAa,EAAE;SAC7B,CAAC;QACF,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,OAAO,EAAE,IAAA,qBAAY,EAAC,IAAI,CAAC;YAC3B,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,OAAO,EAAE,IAAA,0BAAgB,EAAC,IAAI,CAAC;YAC/B,WAAW,EAAE,IAAA,8BAAoB,EAAC,IAAI,CAAC;YACvC,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,MAAM,EAAE,IAAA,oBAAW,EAAC,IAAI,CAAC;YACzB,OAAO,EAAE,IAAA,uBAAc,EAAC,IAAI,CAAC;YAC7B,GAAG,EAAE;gBACH,SAAS,EAAE;oBACT,WAAW,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,IAAI,EAAE,OAAO,CAAC;iBAC7D;aACqB;YACxB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,qBAAW,EAAE,CAAC;YAC3C,kBAAkB,EAAE,GAAG,EAAE;gBACvB,MAAM,MAAM,GAA0B;oBACpC,SAAS,EAAT,eAAS;oBACT,OAAO,EAAE,IAAA,kBAAU,EAAC,MAAM,CAAC;oBAC3B,GAAG,EAAE,CAAI,MAAc,EAAE,MAAgB,EAAE,EAAE,CAC3C,GAAG,CAAC,SAAS,CAAC,GAAG,CAAI,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,cAAI,CAAC;iBACnD,CAAC;gBACF,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC","sourcesContent":["/**\n * The Avalanche driver factory: validated network config, endpoint probes on both\n * transports, and the ports. Loaded only by the manifest's `load()`, with\n * `@avalabs/avalanchejs`.\n */\nimport type { ChainDriver, DriverContext, DriverFactory } from '../../core/driver/types';\nimport { ConfigError } from '../../core/errors/error';\nimport type { EndpointCall, HealthProbes } from '../../core/transport/types';\nimport { AvalancheNode, DataApi, parseBlock, parseHeight } from './api';\nimport { avalancheBroadcaster, avalancheBuilder, MAX_OUTPUTS } from './builder';\nimport { sdkContext } from './codec';\nimport { LocationCache, READ, type AvalancheContext } from './context';\nimport { avalancheNetworkConfig, type AvalancheNetworkConfig } from './network';\nimport { blockSource, proofSource } from './proofs';\nimport { addressCodec, addressHistory, chainReader, listUnspent } from './reader';\nimport { avalanche, type AvalancheSdk, type SdkContext } from './sdk';\nimport type { AvalancheExt } from './types';\n\n/**\n * What `native(bc, '@avalabs/avalanchejs')` hands out. It mirrors the SDK, so it is outside\n * semver: a new avalanchejs line may change it in a minor release.\n */\nexport interface AvalancheNativeClient {\n  /**\n   * The `@avalabs/avalanchejs` module. Its type names the members this library uses; cast\n   * it to reach the rest of the SDK.\n   */\n  readonly avalanche: AvalancheSdk;\n  /**\n   * avalanchejs's `Context` for this network and chain (network id, HRP, AVAX asset id,\n   * this chain's id). Its fee fields are zero: read the fees from the chain.\n   */\n  readonly context: SdkContext;\n  /** A JSON-RPC call (e.g. `avm.getTxFee`) to the handle's node endpoints, through the transport. */\n  rpc<T = unknown>(method: string, params?: unknown): Promise<T>;\n}\n\nfunction nodeProbes(config: AvalancheNetworkConfig): HealthProbes {\n  const prefix = config.vm === 'avm' ? 'avm' : 'platform';\n  return {\n    identity: async (call: EndpointCall) =>\n      parseBlock(\n        await call.rpc(`${prefix}.getBlockByHeight`, { height: '0', encoding: 'json' }),\n      ).id,\n    expectedIdentity: config.genesisBlockId,\n    height: async (call: EndpointCall) =>\n      parseHeight(\n        ((await call.rpc(`${prefix}.getHeight`, {})) as { height?: unknown } | null)\n          ?.height,\n      ),\n  };\n}\n\nfunction indexerProbes(config: AvalancheNetworkConfig): HealthProbes {\n  return {\n    identity: async (call: EndpointCall) =>\n      DataApi.blockZero(\n        await call.http({ method: 'GET', path: '/blocks/0', route: '/blocks/:id' }),\n      ),\n    expectedIdentity: config.genesisBlockId,\n    height: async (call: EndpointCall) =>\n      DataApi.latestHeight(\n        await call.http({\n          method: 'GET',\n          path: '/blocks',\n          query: { pageSize: '1' },\n          route: '/blocks',\n        }),\n      ),\n  };\n}\n\nexport const avalancheDriverFactory: DriverFactory = {\n  async create(ctx: DriverContext): Promise<ChainDriver> {\n    const config = avalancheNetworkConfig(ctx.chain, ctx.network, ctx.options);\n    if (!ctx.indexer) {\n      throw new ConfigError(\n        'CONFIG_INVALID',\n        'the Avalanche driver requires an indexer provider (the Avalanche Data API)',\n      );\n    }\n    // Probes on both transports, once, before any traffic: without them an endpoint's\n    // identity is never checked, and an endpoint of another network is never disabled.\n    ctx.transport.setProbes(nodeProbes(config));\n    ctx.indexer.setProbes(indexerProbes(config));\n    const avax: AvalancheContext = {\n      node: new AvalancheNode(ctx.transport, config.vm),\n      dataApi: new DataApi(ctx.indexer),\n      chain: ctx.chain,\n      network: ctx.network,\n      config,\n      clock: ctx.clock,\n      log: ctx.log,\n      located: new LocationCache(),\n    };\n    return {\n      ordering: 'inputs',\n      capabilities: config.capabilities,\n      address: addressCodec(avax),\n      reader: chainReader(avax),\n      builder: avalancheBuilder(avax),\n      broadcaster: avalancheBroadcaster(avax),\n      proofs: proofSource(avax),\n      blocks: blockSource(avax),\n      history: addressHistory(avax),\n      ext: {\n        avalanche: {\n          listUnspent: (address: string) => listUnspent(avax, address),\n        },\n      } satisfies AvalancheExt,\n      limits: () => ({ maxOutputs: MAX_OUTPUTS }),\n      createNativeClient: () => {\n        const client: AvalancheNativeClient = {\n          avalanche,\n          context: sdkContext(config),\n          rpc: <T>(method: string, params?: unknown) =>\n            ctx.transport.rpc<T>(method, params ?? {}, READ),\n        };\n        return { client };\n      },\n    };\n  },\n};\n"]}

package/dist/adapters/avalanche/sdk.d.ts

@@ -11,19 +11,24 @@
 export interface SdkSerializable {
     readonly _type: string;
 }
+/** The part of avalanchejs's `Id` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkId {
     toString(): string;
     toBytes(): Uint8Array;
 }
+/** The part of avalanchejs's `Int` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkInt {
     value(): number;
 }
+/** The part of avalanchejs's `BigIntPr` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkBigInt {
     value(): bigint;
 }
+/** The part of avalanchejs's `Address` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkAddress {
     toBytes(): Uint8Array;
 }
+/** The part of avalanchejs's `OutputOwners` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkOutputOwners {
     readonly locktime: SdkBigInt;
     readonly threshold: SdkInt;
@@ -34,21 +39,25 @@ export interface SdkTransferOutput extends SdkSerializable {
     readonly outputOwners: SdkOutputOwners;
     amount(): bigint;
 }
+/** The part of avalanchejs's `TransferableOutput` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkTransferableOutput extends SdkSerializable {
     readonly assetId: SdkId;
     readonly output: SdkSerializable;
     amount(): bigint;
 }
+/** The part of avalanchejs's `UTXOID` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkUtxoId {
     readonly txID: SdkId;
     readonly outputIdx: SdkInt;
 }
+/** The part of avalanchejs's `TransferableInput` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkTransferableInput extends SdkSerializable {
     readonly utxoID: SdkUtxoId;
     readonly assetId: SdkId;
     amount(): bigint;
     sigIndicies(): number[];
 }
+/** The part of avalanchejs's `Utxo` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkUtxo extends SdkSerializable {
     readonly utxoId: SdkUtxoId;
     readonly assetId: SdkId;
@@ -72,10 +81,12 @@ export interface SdkTransaction extends SdkSerializable {
     readonly baseTx?: SdkBaseTx;
     getSigIndices(): number[][];
 }
+/** The part of avalanchejs's `Credential` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkCredential extends SdkSerializable {
     /** Each signature as hex (65 bytes: r, s, recovery id). */
     getSignatures(): string[];
 }
+/** The part of avalanchejs's `SignedTx` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkSignedTx {
     readonly unsignedTx: SdkTransaction;
     getCredentials(): SdkCredential[];
@@ -86,6 +97,7 @@ export interface SdkUnsignedTx {
     getTx(): SdkTransaction;
     toBytes(): Uint8Array;
 }
+/** The part of avalanchejs's `codec Manager` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkManager {
     getDefaultCodec(): unknown;
     unpack<T>(bytes: Uint8Array, unpacker: SdkUnpacker<T>): T;
@@ -96,6 +108,7 @@ export interface SdkManager {
 export interface SdkUnpacker<T> {
     fromBytes(bytes: Uint8Array, codec: unknown): [T, Uint8Array];
 }
+/** The part of avalanchejs's `fee Dimensions` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkDimensions {
     readonly 0: number;
     readonly 1: number;
@@ -121,12 +134,14 @@ export interface SdkContext {
         readonly excessConversionConstant: bigint;
     };
 }
+/** The part of avalanchejs's `FeeState` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkFeeState {
     readonly capacity: bigint;
     readonly excess: bigint;
     readonly price: bigint;
     readonly timestamp: string;
 }
+/** The part of avalanchejs's `Signature` this library uses; it mirrors the SDK, outside semver. */
 export interface SdkSignature extends SdkSerializable {
     toString(): string;
 }

package/dist/adapters/avalanche/sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/adapters/avalanche/sdk.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AA6MH,iEAAiE;AACpD,QAAA,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAiB,CAAC;AAEzE,2DAA2D;AAC9C,QAAA,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,cAAc,EAAE,4BAA4B;IAC5C,gBAAgB,EAAE,sBAAsB;IACxC,UAAU,EAAE,wBAAwB;CACrC,CAAC,CAAC","sourcesContent":["/**\n * The one place that loads `@avalabs/avalanchejs`, at run time with `require()` (its 5.x\n * package is an ES module with a CommonJS build). Its type declarations re-export their own\n * modules without file extensions, which TypeScript cannot follow under `node16`\n * resolution, so the part of the SDK this library uses is declared here instead: the codec\n * managers, the transaction builders, the P-Chain fee calculator and the serializable\n * classes the driver reads. The tests run every declared member against the real package.\n * Loaded only through the manifest's `load()`.\n */\n\n/** A serializable avalanchejs object; `_type` names its class (e.g. `avm.BaseTx`). */\nexport interface SdkSerializable {\n  readonly _type: string;\n}\n\nexport interface SdkId {\n  toString(): string;\n  toBytes(): Uint8Array;\n}\n\nexport interface SdkInt {\n  value(): number;\n}\n\nexport interface SdkBigInt {\n  value(): bigint;\n}\n\nexport interface SdkAddress {\n  toBytes(): Uint8Array;\n}\n\nexport interface SdkOutputOwners {\n  readonly locktime: SdkBigInt;\n  readonly threshold: SdkInt;\n  readonly addrs: readonly SdkAddress[];\n}\n\n/** A `secp256k1fx.TransferOutput`. */\nexport interface SdkTransferOutput extends SdkSerializable {\n  readonly outputOwners: SdkOutputOwners;\n  amount(): bigint;\n}\n\nexport interface SdkTransferableOutput extends SdkSerializable {\n  readonly assetId: SdkId;\n  readonly output: SdkSerializable;\n  amount(): bigint;\n}\n\nexport interface SdkUtxoId {\n  readonly txID: SdkId;\n  readonly outputIdx: SdkInt;\n}\n\nexport interface SdkTransferableInput extends SdkSerializable {\n  readonly utxoID: SdkUtxoId;\n  readonly assetId: SdkId;\n  amount(): bigint;\n  sigIndicies(): number[];\n}\n\nexport interface SdkUtxo extends SdkSerializable {\n  readonly utxoId: SdkUtxoId;\n  readonly assetId: SdkId;\n  readonly output: SdkSerializable;\n  /** Its bytes without the codec version, in `codec`. */\n  toBytes(codec: unknown): Uint8Array;\n}\n\n/** The `avax.BaseTx` every X-Chain and most P-Chain transactions carry. */\nexport interface SdkBaseTx {\n  readonly NetworkId: SdkInt;\n  readonly BlockchainId: SdkId;\n  readonly outputs: readonly SdkTransferableOutput[];\n  readonly inputs: readonly SdkTransferableInput[];\n  readonly memo: { readonly bytes: Uint8Array };\n}\n\n/** An unsigned transaction of any type (`avm.*`, `pvm.*`). */\nexport interface SdkTransaction extends SdkSerializable {\n  readonly vm: string;\n  readonly baseTx?: SdkBaseTx;\n  getSigIndices(): number[][];\n}\n\nexport interface SdkCredential extends SdkSerializable {\n  /** Each signature as hex (65 bytes: r, s, recovery id). */\n  getSignatures(): string[];\n}\n\nexport interface SdkSignedTx {\n  readonly unsignedTx: SdkTransaction;\n  getCredentials(): SdkCredential[];\n  toBytes(): Uint8Array;\n}\n\n/** A builder's result. */\nexport interface SdkUnsignedTx {\n  getTx(): SdkTransaction;\n  toBytes(): Uint8Array;\n}\n\nexport interface SdkManager {\n  getDefaultCodec(): unknown;\n  unpack<T>(bytes: Uint8Array, unpacker: SdkUnpacker<T>): T;\n  unpackTransaction(bytes: Uint8Array): SdkTransaction;\n  packCodec(serializable: SdkSerializable): Uint8Array;\n}\n\n/** A class `Manager.unpack` reads (`Utxo`, `avaxSerial.SignedTx`). */\nexport interface SdkUnpacker<T> {\n  fromBytes(bytes: Uint8Array, codec: unknown): [T, Uint8Array];\n}\n\nexport interface SdkDimensions {\n  readonly 0: number;\n  readonly 1: number;\n  readonly 2: number;\n  readonly 3: number;\n}\n\n/** avalanchejs's `Context`: what its builders need to know about the network. */\nexport interface SdkContext {\n  readonly networkID: number;\n  readonly hrp: string;\n  readonly xBlockchainID: string;\n  readonly pBlockchainID: string;\n  readonly cBlockchainID: string;\n  readonly avaxAssetID: string;\n  readonly baseTxFee: bigint;\n  readonly createAssetTxFee: bigint;\n  readonly platformFeeConfig: {\n    readonly weights: SdkDimensions;\n    readonly maxCapacity: bigint;\n    readonly maxPerSecond: bigint;\n    readonly targetPerSecond: bigint;\n    readonly minPrice: bigint;\n    readonly excessConversionConstant: bigint;\n  };\n}\n\nexport interface SdkFeeState {\n  readonly capacity: bigint;\n  readonly excess: bigint;\n  readonly price: bigint;\n  readonly timestamp: string;\n}\n\nexport interface SdkSignature extends SdkSerializable {\n  toString(): string;\n}\n\n/** The members of `@avalabs/avalanchejs` this library calls. */\nexport interface AvalancheSdk {\n  readonly Utxo: SdkUnpacker<SdkUtxo>;\n  readonly avaxSerial: {\n    readonly SignedTx: SdkUnpacker<SdkSignedTx> &\n      (new (tx: SdkTransaction, credentials: SdkSerializable[]) => SdkSignedTx);\n  };\n  readonly Credential: new (signatures: SdkSignature[]) => SdkCredential;\n  readonly Signature: new (bytes: Uint8Array) => SdkSignature;\n  readonly TransferableOutput: {\n    fromNative(\n      assetId: string,\n      amount: bigint,\n      addresses: readonly Uint8Array[],\n      locktime?: bigint,\n      threshold?: number,\n    ): SdkTransferableOutput;\n  };\n  readonly Common: {\n    createDimensions(dimensions: {\n      bandwidth: number;\n      dbRead: number;\n      dbWrite: number;\n      compute: number;\n    }): SdkDimensions;\n  };\n  readonly utils: {\n    getManagerForVM(vm: 'AVM' | 'PVM'): SdkManager;\n    getBurnedAmountByTx(tx: SdkTransaction, context: SdkContext): Map<string, bigint>;\n  };\n  readonly avm: {\n    newBaseTx(\n      context: SdkContext,\n      fromAddressesBytes: readonly Uint8Array[],\n      utxos: readonly SdkUtxo[],\n      outputs: readonly SdkTransferableOutput[],\n      options: {\n        readonly changeAddresses: readonly Uint8Array[];\n        readonly memo: Uint8Array;\n        readonly minIssuanceTime: bigint;\n      },\n    ): SdkUnsignedTx;\n  };\n  readonly pvm: {\n    newBaseTx(\n      props: {\n        readonly feeState: SdkFeeState;\n        readonly fromAddressesBytes: readonly Uint8Array[];\n        readonly changeAddressesBytes: readonly Uint8Array[];\n        readonly outputs: readonly SdkTransferableOutput[];\n        readonly utxos: readonly SdkUtxo[];\n        readonly memo: Uint8Array;\n        readonly minIssuanceTime: bigint;\n      },\n      context: SdkContext,\n    ): SdkUnsignedTx;\n    calculateFee(tx: SdkTransaction, weights: SdkDimensions, price: bigint): bigint;\n  };\n}\n\n// eslint-disable-next-line @typescript-eslint/no-require-imports\nexport const avalanche = require('@avalabs/avalanchejs') as AvalancheSdk;\n\n/** The serializable class names the driver tells apart. */\nexport const TYPES = Object.freeze({\n  transferOutput: 'secp256k1fx.TransferOutput',\n  stakeableLockOut: 'pvm.StakeableLockOut',\n  credential: 'secp256k1fx.Credential',\n});\n"]}
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/adapters/avalanche/sdk.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AA4NH,iEAAiE;AACpD,QAAA,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAiB,CAAC;AAEzE,2DAA2D;AAC9C,QAAA,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,cAAc,EAAE,4BAA4B;IAC5C,gBAAgB,EAAE,sBAAsB;IACxC,UAAU,EAAE,wBAAwB;CACrC,CAAC,CAAC","sourcesContent":["/**\n * The one place that loads `@avalabs/avalanchejs`, at run time with `require()` (its 5.x\n * package is an ES module with a CommonJS build). Its type declarations re-export their own\n * modules without file extensions, which TypeScript cannot follow under `node16`\n * resolution, so the part of the SDK this library uses is declared here instead: the codec\n * managers, the transaction builders, the P-Chain fee calculator and the serializable\n * classes the driver reads. The tests run every declared member against the real package.\n * Loaded only through the manifest's `load()`.\n */\n\n/** A serializable avalanchejs object; `_type` names its class (e.g. `avm.BaseTx`). */\nexport interface SdkSerializable {\n  readonly _type: string;\n}\n\n/** The part of avalanchejs's `Id` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkId {\n  toString(): string;\n  toBytes(): Uint8Array;\n}\n\n/** The part of avalanchejs's `Int` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkInt {\n  value(): number;\n}\n\n/** The part of avalanchejs's `BigIntPr` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkBigInt {\n  value(): bigint;\n}\n\n/** The part of avalanchejs's `Address` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkAddress {\n  toBytes(): Uint8Array;\n}\n\n/** The part of avalanchejs's `OutputOwners` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkOutputOwners {\n  readonly locktime: SdkBigInt;\n  readonly threshold: SdkInt;\n  readonly addrs: readonly SdkAddress[];\n}\n\n/** A `secp256k1fx.TransferOutput`. */\nexport interface SdkTransferOutput extends SdkSerializable {\n  readonly outputOwners: SdkOutputOwners;\n  amount(): bigint;\n}\n\n/** The part of avalanchejs's `TransferableOutput` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkTransferableOutput extends SdkSerializable {\n  readonly assetId: SdkId;\n  readonly output: SdkSerializable;\n  amount(): bigint;\n}\n\n/** The part of avalanchejs's `UTXOID` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkUtxoId {\n  readonly txID: SdkId;\n  readonly outputIdx: SdkInt;\n}\n\n/** The part of avalanchejs's `TransferableInput` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkTransferableInput extends SdkSerializable {\n  readonly utxoID: SdkUtxoId;\n  readonly assetId: SdkId;\n  amount(): bigint;\n  sigIndicies(): number[];\n}\n\n/** The part of avalanchejs's `Utxo` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkUtxo extends SdkSerializable {\n  readonly utxoId: SdkUtxoId;\n  readonly assetId: SdkId;\n  readonly output: SdkSerializable;\n  /** Its bytes without the codec version, in `codec`. */\n  toBytes(codec: unknown): Uint8Array;\n}\n\n/** The `avax.BaseTx` every X-Chain and most P-Chain transactions carry. */\nexport interface SdkBaseTx {\n  readonly NetworkId: SdkInt;\n  readonly BlockchainId: SdkId;\n  readonly outputs: readonly SdkTransferableOutput[];\n  readonly inputs: readonly SdkTransferableInput[];\n  readonly memo: { readonly bytes: Uint8Array };\n}\n\n/** An unsigned transaction of any type (`avm.*`, `pvm.*`). */\nexport interface SdkTransaction extends SdkSerializable {\n  readonly vm: string;\n  readonly baseTx?: SdkBaseTx;\n  getSigIndices(): number[][];\n}\n\n/** The part of avalanchejs's `Credential` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkCredential extends SdkSerializable {\n  /** Each signature as hex (65 bytes: r, s, recovery id). */\n  getSignatures(): string[];\n}\n\n/** The part of avalanchejs's `SignedTx` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkSignedTx {\n  readonly unsignedTx: SdkTransaction;\n  getCredentials(): SdkCredential[];\n  toBytes(): Uint8Array;\n}\n\n/** A builder's result. */\nexport interface SdkUnsignedTx {\n  getTx(): SdkTransaction;\n  toBytes(): Uint8Array;\n}\n\n/** The part of avalanchejs's `codec Manager` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkManager {\n  getDefaultCodec(): unknown;\n  unpack<T>(bytes: Uint8Array, unpacker: SdkUnpacker<T>): T;\n  unpackTransaction(bytes: Uint8Array): SdkTransaction;\n  packCodec(serializable: SdkSerializable): Uint8Array;\n}\n\n/** A class `Manager.unpack` reads (`Utxo`, `avaxSerial.SignedTx`). */\nexport interface SdkUnpacker<T> {\n  fromBytes(bytes: Uint8Array, codec: unknown): [T, Uint8Array];\n}\n\n/** The part of avalanchejs's `fee Dimensions` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkDimensions {\n  readonly 0: number;\n  readonly 1: number;\n  readonly 2: number;\n  readonly 3: number;\n}\n\n/** avalanchejs's `Context`: what its builders need to know about the network. */\nexport interface SdkContext {\n  readonly networkID: number;\n  readonly hrp: string;\n  readonly xBlockchainID: string;\n  readonly pBlockchainID: string;\n  readonly cBlockchainID: string;\n  readonly avaxAssetID: string;\n  readonly baseTxFee: bigint;\n  readonly createAssetTxFee: bigint;\n  readonly platformFeeConfig: {\n    readonly weights: SdkDimensions;\n    readonly maxCapacity: bigint;\n    readonly maxPerSecond: bigint;\n    readonly targetPerSecond: bigint;\n    readonly minPrice: bigint;\n    readonly excessConversionConstant: bigint;\n  };\n}\n\n/** The part of avalanchejs's `FeeState` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkFeeState {\n  readonly capacity: bigint;\n  readonly excess: bigint;\n  readonly price: bigint;\n  readonly timestamp: string;\n}\n\n/** The part of avalanchejs's `Signature` this library uses; it mirrors the SDK, outside semver. */\nexport interface SdkSignature extends SdkSerializable {\n  toString(): string;\n}\n\n/** The members of `@avalabs/avalanchejs` this library calls. */\nexport interface AvalancheSdk {\n  readonly Utxo: SdkUnpacker<SdkUtxo>;\n  readonly avaxSerial: {\n    readonly SignedTx: SdkUnpacker<SdkSignedTx> &\n      (new (tx: SdkTransaction, credentials: SdkSerializable[]) => SdkSignedTx);\n  };\n  readonly Credential: new (signatures: SdkSignature[]) => SdkCredential;\n  readonly Signature: new (bytes: Uint8Array) => SdkSignature;\n  readonly TransferableOutput: {\n    fromNative(\n      assetId: string,\n      amount: bigint,\n      addresses: readonly Uint8Array[],\n      locktime?: bigint,\n      threshold?: number,\n    ): SdkTransferableOutput;\n  };\n  readonly Common: {\n    createDimensions(dimensions: {\n      bandwidth: number;\n      dbRead: number;\n      dbWrite: number;\n      compute: number;\n    }): SdkDimensions;\n  };\n  readonly utils: {\n    getManagerForVM(vm: 'AVM' | 'PVM'): SdkManager;\n    getBurnedAmountByTx(tx: SdkTransaction, context: SdkContext): Map<string, bigint>;\n  };\n  readonly avm: {\n    newBaseTx(\n      context: SdkContext,\n      fromAddressesBytes: readonly Uint8Array[],\n      utxos: readonly SdkUtxo[],\n      outputs: readonly SdkTransferableOutput[],\n      options: {\n        readonly changeAddresses: readonly Uint8Array[];\n        readonly memo: Uint8Array;\n        readonly minIssuanceTime: bigint;\n      },\n    ): SdkUnsignedTx;\n  };\n  readonly pvm: {\n    newBaseTx(\n      props: {\n        readonly feeState: SdkFeeState;\n        readonly fromAddressesBytes: readonly Uint8Array[];\n        readonly changeAddressesBytes: readonly Uint8Array[];\n        readonly outputs: readonly SdkTransferableOutput[];\n        readonly utxos: readonly SdkUtxo[];\n        readonly memo: Uint8Array;\n        readonly minIssuanceTime: bigint;\n      },\n      context: SdkContext,\n    ): SdkUnsignedTx;\n    calculateFee(tx: SdkTransaction, weights: SdkDimensions, price: bigint): bigint;\n  };\n}\n\n// eslint-disable-next-line @typescript-eslint/no-require-imports\nexport const avalanche = require('@avalabs/avalanchejs') as AvalancheSdk;\n\n/** The serializable class names the driver tells apart. */\nexport const TYPES = Object.freeze({\n  transferOutput: 'secp256k1fx.TransferOutput',\n  stakeableLockOut: 'pvm.StakeableLockOut',\n  credential: 'secp256k1fx.Credential',\n});\n"]}