@parity/product-sdk-contracts 0.5.1 → 0.6.1

package/dist/types-BdHp-xWt.d.ts

@@ -1,196 +0,0 @@
-import { HexString, SS58String, PolkadotSigner } from 'polkadot-api';
-import { Weight, SubmitOptions, TxResult, BatchableCall } from '@parity/product-sdk-tx';
-import { SignerManager } from '@parity/product-sdk-signer';
-
-/** Pins a target to specific asset-hub and Bulletin chain hashes in `cdm.json`. */
-interface CdmJsonTarget {
-    "asset-hub": string;
-    bulletin: string;
-}
-/**
- * A deployed contract's on-chain address, ABI, and optional metadata CID.
- *
- * `metadataCid` is optional because real-world cdm.json files (e.g.
- * `paritytech/playground-cli/cdm.json`) don't always include it — only
- * `version`, `address`, and `abi` are load-bearing for `getContract()`.
- */
-interface CdmJsonContract {
-    version: number;
-    address: HexString;
-    abi: AbiEntry[];
-    metadataCid?: string;
-}
-/** A project's `cdm.json` manifest: declared targets, runtime dependencies, and per-target contract deployments. */
-interface CdmJson {
-    targets: Record<string, CdmJsonTarget>;
-    dependencies: Record<string, Record<string, number | string>>;
-    contracts?: Record<string, Record<string, CdmJsonContract>>;
-}
-/** An ABI parameter or return value, with support for nested tuple and struct types. */
-interface AbiParam {
-    name: string;
-    type: string;
-    components?: AbiParam[];
-}
-/** One function, constructor, or event in a contract's ABI. */
-interface AbiEntry {
-    type: string;
-    name?: string;
-    inputs: AbiParam[];
-    outputs?: AbiParam[];
-    stateMutability?: string;
-}
-/** Per-contract definition shape — generated into `.cdm/contracts.d.ts` via module augmentation. */
-interface ContractDef {
-    methods: Record<string, {
-        args: any[];
-        response: any;
-    }>;
-}
-/**
- * Augmentable interface extended by codegen with per-contract method types.
- *
- * After running `cdm install`, a generated `.d.ts` file augments this
- * interface so that `ContractManager.getContract()` returns fully-typed
- * contract handles.
- */
-interface Contracts {
-}
-/**
- * Result from a read-only contract query.
- *
- * On success, `value` is the decoded response and `gasRequired` is the
- * `Weight` consumed by `ReviveApi.call`'s dry-run — consumable directly by
- * `Revive.call`'s `weight_limit` parameter.
- *
- * On failure, `value` carries the raw dispatch-error payload the runtime
- * returned (typically a tagged enum like `{ type: "Module", value: ... }`,
- * `{ type: "ContractReverted" }`, or `{ type: "AccountNotMapped" }` — see the
- * `Revive` pallet error variants). Surfacing it lets callers narrow on shape
- * to diagnose silent failures instead of seeing `undefined` and being unable
- * to tell whether the contract reverted, gas estimation failed, or the
- * dry-run never ran. `gasRequired` is still populated when the runtime
- * reported a weight even though the call ultimately failed (e.g. a revert
- * after partial execution); it's optional because some failure modes don't
- * carry one.
- */
-type QueryResult<T> = {
-    success: true;
-    value: T;
-    gasRequired: Weight;
-} | {
-    success: false;
-    value: unknown;
-    gasRequired?: Weight;
-};
-/** Options for query calls — passed as the last argument after positional args. */
-interface QueryOptions {
-    origin?: SS58String;
-    value?: bigint;
-}
-/** Options for transaction calls — passed as the last argument after positional args. */
-interface TxOptions extends SubmitOptions {
-    signer?: PolkadotSigner;
-    origin?: SS58String;
-    value?: bigint;
-    gasLimit?: Weight;
-    storageDepositLimit?: bigint;
-}
-/**
- * Options for `.prepare()` — subset of {@link TxOptions}.
- *
- * Signer and submission lifecycle options (`signer`, `waitFor`, `timeoutMs`,
- * `mortalityPeriod`, `onStatus`) are intentionally absent — those belong to
- * the batch submission, not the individual prepared call.
- */
-interface PrepareOptions {
-    origin?: SS58String;
-    value?: bigint;
-    gasLimit?: Weight;
-    storageDepositLimit?: bigint;
-}
-/** Mutable defaults shared across all contract handles from a manager. */
-interface ContractDefaults {
-    origin?: SS58String;
-    signer?: PolkadotSigner;
-    signerManager?: SignerManager;
-}
-/**
- * Options for {@link createContract} and base for {@link ContractManagerOptions}.
- *
- * Signer resolution order (highest wins):
- * 1. Explicit override in call options
- * 2. `signerManager` (current logged-in account)
- * 3. Static `defaultSigner` / `defaultOrigin`
- */
-interface ContractOptions {
-    /**
-     * Signer manager from `@parity/product-sdk-signer`. When provided, the
-     * currently selected account is used as the default signer and origin
-     * for all contract interactions. Resolved at call time so account
-     * switches are reflected immediately.
-     */
-    signerManager?: SignerManager;
-    /** Static fallback caller address for queries. */
-    defaultOrigin?: SS58String;
-    /** Static fallback signer for transactions. */
-    defaultSigner?: PolkadotSigner;
-}
-/** Options for {@link ContractManager} construction. */
-interface ContractManagerOptions extends ContractOptions {
-    /** Explicit target hash to select from cdm.json. Defaults to the first target. */
-    targetHash?: string;
-}
-/**
- * A typed contract handle where each ABI method exposes `.query()` and `.tx()`.
- *
- * Both accept the method's positional arguments followed by an optional
- * options object as the last argument.
- */
-type Contract<C extends ContractDef> = {
-    [K in keyof C["methods"]]: {
-        /**
-         * Dry-run the method (read-only). Does not submit a transaction or
-         * cost gas. Returns the decoded response and estimated gas required.
-         *
-         * Origin is resolved from: explicit `{ origin }` option → signerManager →
-         * defaultOrigin → dev fallback (Alice).
-         */
-        query: (...args: [...C["methods"][K]["args"], opts?: QueryOptions]) => Promise<QueryResult<C["methods"][K]["response"]>>;
-        /**
-         * Sign, submit, and watch the method as an on-chain transaction.
-         * Resolves at best-block by default (configurable via `waitFor`).
-         *
-         * Signer is resolved from: explicit `{ signer }` option → signerManager →
-         * defaultSigner. Throws {@link ContractSignerMissingError} if none available.
-         */
-        tx: (...args: [...C["methods"][K]["args"], opts?: TxOptions]) => Promise<TxResult>;
-        /**
-         * Prepare the method as a {@link BatchableCall} — returns the same
-         * submittable that `.tx()` would build, but without signing or
-         * submitting. Consumable directly by `batchSubmitAndWatch` from
-         * `@parity/product-sdk-tx`:
-         *
-         * ```ts
-         * import { batchSubmitAndWatch } from "@parity/product-sdk-tx";
-         *
-         * const a = contract.transfer.prepare(addr1, 100n);
-         * const b = contract.transfer.prepare(addr2, 200n);
-         * await batchSubmitAndWatch([a, b], api, signer);
-         * ```
-         *
-         * Sizing: when either `gasLimit` or `storageDepositLimit` is
-         * omitted, `.prepare()` runs a `ReviveApi.call` dry-run (same as
-         * `.tx()`) against the dev fallback origin to fill the missing
-         * field(s) — pass both to skip the dry-run entirely. A failing
-         * dry-run throws {@link ContractDryRunFailedError} before the
-         * call is constructed.
-         *
-         * `.prepare()` does not require a signer; the batch's signer
-         * replaces the dispatched origin at submission.
-         */
-        prepare: (...args: [...C["methods"][K]["args"], opts?: PrepareOptions]) => Promise<BatchableCall>;
-    };
-};
-
-export type { AbiEntry as A, CdmJson as C, PrepareOptions as P, QueryOptions as Q, TxOptions as T, ContractManagerOptions as a, ContractDefaults as b, Contracts as c, Contract as d, ContractDef as e, ContractOptions as f, AbiParam as g, CdmJsonContract as h, CdmJsonTarget as i, QueryResult as j };