Skip to content

CHANGELOG.md

Latest commit

 

History

History
149 lines (96 loc) · 13 KB

CHANGELOG.md

File metadata and controls

149 lines (96 loc) · 13 KB
Raw

@evmnow/sdk

0.7.0

Minor Changes

  • 9d6eaa4 Thanks @jwahdatehagh! - Correctness, robustness, and API hardening across the SDK.

    Fixes

    • Sourcify v2: request the valid runtimeBytecode field instead of deployedBytecode (which the live API rejects with HTTP 400) and surface runtimeBytecode.onchainBytecode as deployedBytecode. Field selectors are validated against the known v2 field list (buildSourcifyFields, SOURCIFY_V2_FIELDS).
    • Repository source: chain-aware lookups — contracts/{chainId}/{address}.json first with a flat-layout fallback; documents with a mismatched chainId are discarded; malformed JSON shapes (arrays, non-string includes) return null instead of crashing get().
    • merge / mergeNatspecDocs skip __proto__, constructor, and prototype keys (prototype-pollution hardening).
    • ENS names are lowercased before the .eth check and hashing, so Vitalik.eth / VITALIK.ETH resolve correctly.
    • Diamond facets: NatSpec methods and derived actions are filtered to mounted selectors so unmounted facet functions can't inject actions.
    • Multi-target proxy metadataLayer is now first-target-wins, consistent with the NatSpec merge.
    • On-chain name()/symbol() fill uses the bytes32-aware, sanitizing token decoder (fixes MKR/SAI-style tokens; hostile values are capped/stripped).
    • Calldata matching treats a missing call.value as 0 for locked value constraints.
    • Event/error key validation flags truncated and uppercase hex keys; the action signature grammar accepts $ identifiers, aligned between actions.ts and validate.ts.
    • Mixed-case addresses are EIP-55 checksum-validated and rejected with InvalidAddressError on mismatch.

    Robustness

    • JSON-RPC calls carry a 10s abort timeout.
    • includes resolution only follows https: URLs; the schema base is configurable (schemaBaseUrl, default https://evmnow.github.io/contract-metadata/v1).
    • resolveUri caps response bodies at ~1 MB and recognizes the data:application/json;charset=utf-8, variant.
    • Sourcify responses are shape-validated (non-object bodies, non-record natspec, non-array ABIs).

    New options & API

    • ContractClientConfig: schemaBaseUrl, cache (per-client memoization + in-flight dedup of repository/Sourcify fetches, default on), ensResolver (custom ENS Universal Resolver address).
    • New error classes: InvalidAddressError, ChainIdMismatchError, ContractClientConfigError.
    • New exports: filterSourcifyBySelectors, buildSourcifyFields, SOURCIFY_V2_FIELDS, decodeSymbol, sanitizeSymbol, normalizeEnsName, UNIVERSAL_RESOLVER, AbiItem.
    • New subpath exports: ./actions, ./natspec, ./interfaces/detect, ./interfaces/erc20, ./interfaces/erc721, ./package.json.
    • ContractResult.abi, ProxyResolution.compositeAbi, TargetInfo.abi, and SourcifyResult.abi are now typed as AbiItem[] instead of unknown[].
    • Token info resolver fetches decimals() and symbol() concurrently.

0.6.0

Minor Changes

  • a5c2335 Thanks @jwahdatehagh! - New @evmnow/sdk/validate subpath: semanticChecks(doc, options) runs the document-level semantic checks that the JSON Schema cannot express — cross-references (group and related targets), input-flag contracts (hidden/disabled require autofill and are mutually exclusive), action/event/error key formats, tokenAddress+tokenParam mutual exclusion, and variant ambiguity (actions on one function with identical locked parameters, which calldata matching cannot distinguish). Pure and filesystem-free — existence checks are injected via options.interfaceExists, and options.expectedAddress verifies the document's address. Returns structured SemanticIssue { path, message } objects. This is the canonical implementation previously duplicated in the contract-metadata repo's validate script, which now consumes it.

0.5.0

Minor Changes

  • 17d370f Thanks @jwahdatehagh! - Detect ERC-20/ERC-721 standards from the final ABI (after proxy composition) and apply the bundled interface metadata layer at the lowest merge priority — labeled actions, groups, and semantic types like token-amount for any standard token, no curated document required. When no metadata layer provides name/symbol, they are read from the contract on-chain. Detection is reported in result.interfaces and can be disabled via sources.interfaces.

  • b56b774 Thanks @jwahdatehagh! - Align amount rendering with the standard's token-resolution rules. resolveAmountDisplay/formatAmount no longer guess 18 decimals for an unresolved token-amount — they return null so callers render the raw value (per the spec, consumers MUST NOT substitute default decimals). formatAmount renders 2^256-1 as "Unlimited" (configurable via the unlimited option; MAX_UINT256 is exported). New token-resolution helpers implement the spec's resolution order — tokenAddressOf, tokenParamOf, and resolveTokenAddress (explicit tokenAddress → tokenParam sibling-argument reference → described contract for bare forms) — and TokenAmountType gains the new optional tokenParam field. Two new subpath exports: @evmnow/sdk/token (createTokenInfoResolver reads decimals()/symbol() over JSON-RPC with caching, in-flight dedup, bytes32-symbol support, and hostile-symbol sanitization) and @evmnow/sdk/intent (renderIntent renders {param} intent templates with type-formatted values, including {value}, # prefixes, and token-amount resolution). The bundled ERC-20 interface types the Permit message value field as token-amount.

0.4.0

Minor Changes

  • 2142b7e Thanks @jwahdatehagh! - Resolve legacy ZeppelinOS (pre-EIP-1967) proxies via @1001-digital/proxies 0.2.0.

    Contracts like Circle's USDC (FiatTokenProxy) store their implementation at keccak256('org.zeppelinos.proxy.implementation') and were previously not detected — client.get returned only the proxy's own ABI. They now resolve through the standard proxy pipeline (result.proxy.pattern === 'zeppelinos'), with the implementation ABI merged into the composite ABI.

    Re-exports the new detectZeppelinOs, ZEPPELINOS_IMPL_SLOT, and ZEPPELINOS_ADMIN_SLOT from @evmnow/sdk/sources/proxy.

0.3.0

Minor Changes

  • 3e23f05 Thanks @jwahdatehagh! - Support positional _N parameter keys in action metadata: matchAction resolves constraints by ABI position (name keys win), and locked keys that match no ABI parameter fail the variant. Adds paramMetaAt and actionRequiresSender exports.

0.2.0

Minor Changes

  • #5 0a75783 Thanks @jwahdatehagh! - Adopt the ABI-independent actions model from the contract-metadata spec.

    The functions document section becomes actions, keyed by free-form identifier with an optional function reference (bare name, signature, or 4-byte selector — defaults to the action id). New resolveActions(abi, doc) resolves authored actions against the ABI and synthesizes a default action for every function no authored action references; authoring problems are surfaced as structured issues. New matchAction(actions, call) implements the spec's calldata-matching algorithm: locked parameters (hidden/disabled with a resolvable autofill) act as equality constraints against decoded arguments, the most-locked surviving candidate wins, and ties break deterministically by order then id. Actions may also describe the native currency attached to payable calls via a value object (ValueMeta), which participates in matching and validation. Sourcify NatSpec output is converted into the actions shape.

  • 302ed16 Thanks @jwahdatehagh! - Add canonical amount formatting for the eth, gwei, amount, and token-amount semantic types.

    New pure, dependency-free @evmnow/sdk/format module: formatAmount, parseAmount, formatUnits, parseUnits, resolveAmountDisplay, amountKind, and isAmountType. Also fixes a schema drift by adding the missing { type: 'amount', decimals?, symbol? } variant to ParamType (exported as AmountType).

0.1.4

Patch Changes

0.1.3

Patch Changes

0.1.2

Patch Changes

0.1.1

Patch Changes

0.1.0

Minor Changes

  • 7fe475b Thanks @jwahdatehagh! - Initial release of @evmnow/sdk — resolve complete contract metadata from multiple sources.

    Sources

    • Repository — curated JSON from the contract-metadata GitHub repo.
    • contractURI (ERC-7572) — on-chain contractURI resolution (HTTPS, IPFS, data:).
    • Sourcify v2 — ABI, NatSpec (userdoc / devdoc), optionally sources + deployed bytecode.
    • On-chain proxies — every major proxy convention: ERC-2535 diamonds, EIP-1967 (transparent / UUPS + beacon), EIP-1822, EIP-1167 clones, Gnosis Safe, EIP-897. Implementation-side ABI + NatSpec are folded back into the main result.

    Features

    • createContractClient(config) — factory returning a client with get, fetchRepository, fetchContractURI, fetchSourcify, fetchProxy.
    • client.get(addressOrEns) — resolves ENS, fetches every enabled source in parallel, resolves includes, and returns a single ContractResult with merged metadata, ABI, NatSpec, optional sources + deployed bytecode, and detected proxy info.
    • Layered merge — curated repository wins over contractURI wins over Sourcify wins over implementation-derived metadata. Record sections (functions, events, errors, …) shallow-merge per key.
    • includes resolution — interface references (e.g. interface:erc721) are fetched from the schema base and merged left-to-right under the document.
    • Proxy pipeline — detectProxy orchestrator with priority ordering; single-hop resolution; sources.proxy: false skips detection entirely; sources.sourcify: false also disables per-target lookups (no hidden traffic).
    • ENS resolution — .eth names via Universal Resolver, with explicit mainnet RPC support when chainId !== 1.
    • Dependency-injected fetch — pass any fetch-compatible function; no implicit globals.
    • Pure/standalone exports — merge, resolveIncludes, fetchRepository, fetchContractURI, fetchSourcify, buildSourcifyLayer, fetchProxy, detectProxy + per-pattern detectors, enrichTargets, composeProxyResolution, buildCompositeAbi, filterAbiBySelectors, computeSelector, canonicalSignature, mergeNatspecDocs, decodeFacets, resolveUri, namehash, dnsEncode, RPC helpers — all usable without the client.

    Result shape

    interface ContractResult {
  chainId: number;
  address: string;
  metadata: ContractMetadataDocument; // merged across every source
  abi?: unknown[]; // composite (main contract + implementation targets)
  natspec?: { userdoc?; devdoc? };
  sources?: Record<string, string>;
  deployedBytecode?: string;
  proxy?: ProxyResolution; // pattern, targets, beacon?, admin?, …
}

    Package layout

    • Vite build with preserveModules: true mirrors src/ → dist/ 1:1 — every module is independently importable under @evmnow/sdk/... (declared in package.json#exports).
    • sideEffects: false for aggressive tree-shaking.
    • Minimal runtime dependencies: @1001-digital/proxies, @1001-digital/natspec, @noble/hashes.