import { Interface, Typed } from "../abi/index.js"; import { resolveAddress } from "../address/index.js"; import { copyRequest, Log, TransactionResponse } from "../providers/index.js"; import { defineProperties, isCallException, isHexString, resolveProperties, makeError, throwArgumentError, throwError } from "../utils/index.js"; import { ContractEventPayload, ContractTransactionResponse, EventLog } from "./wrappers.js"; import type { EventFragment, FunctionFragment, InterfaceAbi, ParamType, Result } from "../abi/index.js"; import type { Addressable } from "../address/index.js"; import type { EventEmitterable, Listener } from "../utils/index.js"; import type { BlockTag, ContractRunner, Provider, TransactionRequest, TopicFilter } from "../providers/index.js"; import type { ContractEventName, ContractInterface, ContractMethodArgs, BaseContractMethod, ContractMethod, ContractEventArgs, ContractEvent, ContractTransaction, DeferredTopicFilter } from "./types.js"; interface ContractRunnerCaller extends ContractRunner { call: (tx: TransactionRequest) => Promise; } interface ContractRunnerEstimater extends ContractRunner { estimateGas: (tx: TransactionRequest) => Promise; } interface ContractRunnerSender extends ContractRunner { sendTransaction: (tx: TransactionRequest) => Promise; } interface ContractRunnerResolver extends ContractRunner { resolveName: (name: string | Addressable) => Promise; } function canCall(value: any): value is ContractRunnerCaller { return (value && typeof(value.call) === "function"); } function canEstimate(value: any): value is ContractRunnerEstimater { return (value && typeof(value.estimateGas) === "function"); } function canResolve(value: any): value is ContractRunnerResolver { return (value && typeof(value.resolveName) === "function"); } function canSend(value: any): value is ContractRunnerSender { return (value && typeof(value.sendTransaction) === "function"); } function concisify(items: Array): Array { items = Array.from((new Set(items)).values()) items.sort(); return items; } class PreparedTopicFilter implements DeferredTopicFilter { #filter: Promise; readonly fragment!: EventFragment; constructor(contract: BaseContract, fragment: EventFragment, args: Array) { defineProperties(this, { fragment }); if (fragment.inputs.length < args.length) { throw new Error("too many arguments"); } // Recursively descend into args and resolve any addresses const runner = getRunner(contract.runner, "resolveName"); const resolver = canResolve(runner) ? runner: null; this.#filter = (async function() { const resolvedArgs = await Promise.all(fragment.inputs.map((param, index) => { return param.walkAsync(args[index], (type, value) => { if (type === "address") { return resolveAddress(value, resolver); } return value; }); })); return contract.interface.encodeFilterTopics(fragment, resolvedArgs); })(); } getTopicFilter(): Promise { return this.#filter; } } // A = Arguments passed in as a tuple // R = The result type of the call (i.e. if only one return type, // the qualified type, otherwise Result) // D = The type the default call will return (i.e. R for view/pure, // TransactionResponse otherwise) //export interface ContractMethod = Array, R = any, D extends R | ContractTransactionResponse = ContractTransactionResponse> { function _WrappedMethodBase(): new () => Function & BaseContractMethod { return Function as any; } function getRunner(value: any, feature: keyof ContractRunner): null | T { if (value == null) { return null; } if (typeof(value[feature]) === "function") { return value; } if (value.provider && typeof(value.provider[feature]) === "function") { return value.provider; } return null; } function getProvider(value: null | ContractRunner): null | Provider { if (value == null) { return null; } return value.provider || null; } export async function copyOverrides(arg: any): Promise> { // Create a shallow copy (we'll deep-ify anything needed during normalizing) const overrides = copyRequest(Typed.dereference(arg, "overrides")); // Some sanity checking; these are what these methods adds //if ((overrides).to) { if (overrides.to) { throwArgumentError("cannot override to", "overrides.to", overrides.to); } else if (overrides.data) { throwArgumentError("cannot override data", "overrides.data", overrides.data); } // Resolve any from if (overrides.from) { overrides.from = await resolveAddress(overrides.from); } return overrides; } export async function resolveArgs(_runner: null | ContractRunner, inputs: ReadonlyArray, args: Array): Promise> { // Recursively descend into args and resolve any addresses const runner = getRunner(_runner, "resolveName"); const resolver = canResolve(runner) ? runner: null; return await Promise.all(inputs.map((param, index) => { return param.walkAsync(args[index], (type, value) => { if (type === "address") { return resolveAddress(value, resolver); } return value; }); })); } class WrappedMethod = Array, R = any, D extends R | ContractTransactionResponse = ContractTransactionResponse> extends _WrappedMethodBase() implements BaseContractMethod { readonly name: string = ""; // Investigate! readonly _contract!: BaseContract; readonly _key!: string; constructor (contract: BaseContract, key: string) { super(); defineProperties(this, { name: contract.interface.getFunctionName(key), _contract: contract, _key: key }); const proxy = new Proxy(this, { // Perform the default operation for this fragment type apply: async (target, thisArg, args: ContractMethodArgs) => { const fragment = target.getFragment(...args); if (fragment.constant) { return await target.staticCall(...args); } return await target.send(...args); }, }); return proxy; } // Only works on non-ambiguous keys (refined fragment is always non-ambiguous) get fragment(): FunctionFragment { return this._contract.interface.getFunction(this._key); } getFragment(...args: ContractMethodArgs): FunctionFragment { return this._contract.interface.getFunction(this._key, args); } async populateTransaction(...args: ContractMethodArgs): Promise { const fragment = this.getFragment(...args); // If an overrides was passed in, copy it and normalize the values let overrides: Omit = { }; if (fragment.inputs.length + 1 === args.length) { overrides = await copyOverrides(args.pop()); } if (fragment.inputs.length !== args.length) { throw new Error("internal error: fragment inputs doesn't match arguments; should not happen"); } const resolvedArgs = await resolveArgs(this._contract.runner, fragment.inputs, args); return Object.assign({ }, overrides, await resolveProperties({ to: this._contract.getAddress(), data: this._contract.interface.encodeFunctionData(fragment, resolvedArgs) })); } async staticCall(...args: ContractMethodArgs): Promise { const result = await this.staticCallResult(...args); if (result.length === 1) { return result[0]; } return result; } async send(...args: ContractMethodArgs): Promise { const runner = this._contract.runner; if (!canSend(runner)) { return throwError("contract runner does not support sending transactions", "UNSUPPORTED_OPERATION", { operation: "sendTransaction" }); } const tx = await runner.sendTransaction(await this.populateTransaction(...args)); const provider = getProvider(this._contract.runner); // @TODO: the provider can be null; make a custom dummy provider that will throw a // meaningful error return new ContractTransactionResponse(this._contract.interface, provider, tx); } async estimateGas(...args: ContractMethodArgs): Promise { const runner = getRunner(this._contract.runner, "estimateGas"); if (!canEstimate(runner)) { return throwError("contract runner does not support gas estimation", "UNSUPPORTED_OPERATION", { operation: "estimateGas" }); } return await runner.estimateGas(await this.populateTransaction(...args)); } async staticCallResult(...args: ContractMethodArgs): Promise { const runner = getRunner(this._contract.runner, "call"); if (!canCall(runner)) { return throwError("contract runner does not support calling", "UNSUPPORTED_OPERATION", { operation: "call" }); } const fragment = this.getFragment(...args); const tx = await this.populateTransaction(...args); let result = "0x"; try { result = await runner.call(tx); } catch (error: any) { if (isCallException(error)) { throw this._contract.interface.makeError(fragment, error.data, tx); } throw error; } return this._contract.interface.decodeFunctionResult(fragment, result); } } function _WrappedEventBase(): new () => Function & ContractEvent { return Function as any; } class WrappedEvent = Array> extends _WrappedEventBase() implements ContractEvent { readonly name: string = ""; // @TODO: investigate readonly _contract!: BaseContract; readonly _key!: string; constructor (contract: BaseContract, key: string) { super(); defineProperties(this, { name: contract.interface.getEventName(key), _contract: contract, _key: key }); return new Proxy(this, { // Perform the default operation for this fragment type apply: async (target, thisArg, args: ContractEventArgs) => { return new PreparedTopicFilter(contract, target.getFragment(...args), args); }, }); } // Only works on non-ambiguous keys get fragment(): EventFragment { return this._contract.interface.getEvent(this._key); } getFragment(...args: ContractEventArgs): EventFragment { return this._contract.interface.getEvent(this._key, args); } }; type Sub = { tag: string; listeners: Array<{ listener: Listener, once: boolean }>, start: () => void; stop: () => void; }; // The combination of TypeScrype, Private Fields and Proxies makes // the world go boom; so we hide variables with some trickery keeping // a symbol attached to each BaseContract which its sub-class (even // via a Proxy) can reach and use to look up its internal values. const internal = Symbol.for("_ethersInternal_contract"); type Internal = { addrPromise: Promise; addr: null | string; deployTx: null | ContractTransactionResponse; subs: Map; }; const internalValues: WeakMap = new WeakMap(); function setInternal(contract: BaseContract, values: Internal): void { internalValues.set(contract[internal], values); } function getInternal(contract: BaseContract): Internal { return internalValues.get(contract[internal]) as Internal; } function isDeferred(value: any): value is DeferredTopicFilter { return (value && typeof(value) === "object" && ("getTopicFilter" in value) && (typeof(value.getTopicFilter) === "function") && value.fragment); } async function getSubTag(contract: BaseContract, event: ContractEventName): Promise<{ tag: string, fragment: EventFragment, topics: TopicFilter }> { let fragment: EventFragment; let topics: Array>; if (Array.isArray(event)) { // Topics; e.g. `[ "0x1234...89ab" ]` fragment = contract.interface.getEvent(event[0] as string); topics = event; } else if (typeof(event) === "string") { // Event name (name or signature); `"Transfer"` fragment = contract.interface.getEvent(event); topics = [ fragment.topicHash ]; } else if (isDeferred(event)) { // Deferred Topic Filter; e.g. `contract.filter.Transfer(from)` fragment = event.fragment; topics = await event.getTopicFilter(); } else if ("fragment" in event) { // ContractEvent; e.g. `contract.filter.Transfer` fragment = event.fragment; topics = [ fragment.topicHash ]; } else { console.log(event); throw new Error("TODO"); } // Normalize topics and sort TopicSets topics = topics.map((t) => { if (t == null) { return null; } if (Array.isArray(t)) { return concisify(t.map((t) => t.toLowerCase())); } return t.toLowerCase(); }); const tag = topics.map((t) => { if (t == null) { return "null"; } if (Array.isArray(t)) { return t.join("|"); } return t; }).join("&"); return { fragment, tag, topics } } async function hasSub(contract: BaseContract, event: ContractEventName): Promise { const { subs } = getInternal(contract); return subs.get((await getSubTag(contract, event)).tag) || null; } async function getSub(contract: BaseContract, event: ContractEventName): Promise { // Make sure our runner can actually subscribe to events const provider = getProvider(contract.runner); if (!provider) { return throwError("contract runner does not support subscribing", "UNSUPPORTED_OPERATION", { operation: "on" }); } const { fragment, tag, topics } = await getSubTag(contract, event); const { addr, subs } = getInternal(contract); let sub = subs.get(tag); if (!sub) { const address: string | Addressable = (addr ? addr: contract); const filter = { address, topics }; const listener = (log: Log) => { const payload = new ContractEventPayload(contract, null, event, fragment, log); emit(contract, event, payload.args, payload); }; let started = false; const start = () => { if (started) { return; } provider.on(filter, listener); started = true; }; const stop = () => { if (!started) { return; } provider.off(filter, listener); started = false; }; sub = { tag, listeners: [ ], start, stop }; subs.set(tag, sub); } return sub; } // We use this to ensure one emit resolves before firing the next to // ensure correct ordering (note this cannot throw and just adds the // notice to the event queu using setTimeout). let lastEmit: Promise = Promise.resolve(); async function _emit(contract: BaseContract, event: ContractEventName, args: Array, payload: null | ContractEventPayload): Promise { await lastEmit; const sub = await hasSub(contract, event); if (!sub) { return false; } const count = sub.listeners.length; sub.listeners = sub.listeners.filter(({ listener, once }) => { const passArgs = args.slice(); if (payload) { passArgs.push(new ContractEventPayload(contract, (once ? null: listener), event, payload.fragment, payload.log)); } try { listener.call(contract, ...passArgs); } catch (error) { } return !once; }); return (count > 0); } async function emit(contract: BaseContract, event: ContractEventName, args: Array, payload: null | ContractEventPayload): Promise { try { await lastEmit; } catch (error) { } const resultPromise = _emit(contract, event, args, payload); lastEmit = resultPromise; return await resultPromise; } const passProperties = [ "then" ]; export class BaseContract implements Addressable, EventEmitterable { readonly target!: string | Addressable; readonly interface!: Interface; readonly runner!: null | ContractRunner; readonly filters!: Record; readonly [internal]: any; constructor(target: string | Addressable, abi: Interface | InterfaceAbi, runner: null | ContractRunner = null, _deployTx?: null | TransactionResponse) { const iface = Interface.from(abi); defineProperties(this, { target, runner, interface: iface }); Object.defineProperty(this, internal, { value: { } }); let addrPromise; let addr = null; let deployTx: null | ContractTransactionResponse = null; if (_deployTx) { const provider = getProvider(runner); // @TODO: the provider can be null; make a custom dummy provider that will throw a // meaningful error deployTx = new ContractTransactionResponse(this.interface, provider, _deployTx); } let subs = new Map(); // Resolve the target as the address if (typeof(target) === "string") { if (isHexString(target)) { addr = target; addrPromise = Promise.resolve(target); } else { const resolver = getRunner(runner, "resolveName"); if (!canResolve(resolver)) { throw makeError("contract runner does not support name resolution", "UNSUPPORTED_OPERATION", { operation: "resolveName" }); } addrPromise = resolver.resolveName(target).then((addr) => { if (addr == null) { throw new Error("TODO"); } getInternal(this).addr = addr; return addr; }); } } else { addrPromise = target.getAddress().then((addr) => { if (addr == null) { throw new Error("TODO"); } getInternal(this).addr = addr; return addr; }); } // Set our private values setInternal(this, { addrPromise, addr, deployTx, subs }); // Add the event filters const filters = new Proxy({ }, { get: (target, _prop, receiver) => { // Pass important checks (like `then` for Promise) through if (passProperties.indexOf(_prop) >= 0) { return Reflect.get(target, _prop, receiver); } const prop = String(_prop); const result = this.getEvent(prop); if (result) { return result; } throw new Error(`unknown contract event: ${ prop }`); } }); defineProperties(this, { filters }); // Return a Proxy that will respond to functions return new Proxy(this, { get: (target, _prop, receiver) => { if (_prop in target || passProperties.indexOf(_prop) >= 0) { return Reflect.get(target, _prop, receiver); } const prop = String(_prop); const result = target.getFunction(prop); if (result) { return result; } throw new Error(`unknown contract method: ${ prop }`); } }); } async getAddress(): Promise { return await getInternal(this).addrPromise; } async getDeployedCode(): Promise { const provider = getProvider(this.runner); if (!provider) { return throwError("runner does not support .provider", "UNSUPPORTED_OPERATION", { operation: "getDeployedCode" }); } const code = await provider.getCode(await this.getAddress()); if (code === "0x") { return null; } return code; } async waitForDeployment(): Promise { // We have the deployement transaction; just use that (throws if deployement fails) const deployTx = this.deploymentTransaction(); if (deployTx) { await deployTx.wait(); return this; } // Check for code const code = await this.getDeployedCode(); if (code != null) { return this; } // Make sure we can subscribe to a provider event const provider = getProvider(this.runner); if (provider == null) { return throwError("contract runner does not support .provider", "UNSUPPORTED_OPERATION", { operation: "waitForDeployment" }); } return new Promise((resolve, reject) => { const checkCode = async () => { try { const code = await this.getDeployedCode(); if (code != null) { return resolve(this); } provider.once("block", checkCode); } catch (error) { reject(error); } }; checkCode(); }); } deploymentTransaction(): null | ContractTransactionResponse { return getInternal(this).deployTx; } getFunction(key: string | FunctionFragment): T { if (typeof(key) !== "string") { key = key.format(); } return (new WrappedMethod(this, key)); } getEvent(key: string | EventFragment): ContractEvent { if (typeof(key) !== "string") { key = key.format(); } return (new WrappedEvent(this, key)); } async queryTransaction(hash: string): Promise> { // Is this useful? throw new Error("@TODO"); } async queryFilter(event: ContractEventName, fromBlock: BlockTag = 0, toBlock: BlockTag = "latest"): Promise> { const { addr, addrPromise } = getInternal(this); const address = (addr ? addr: (await addrPromise)); const { fragment, topics } = await getSubTag(this, event); const filter = { address, topics, fromBlock, toBlock }; const provider = getProvider(this.runner); if (!provider) { return throwError("contract runner does not have a provider", "UNSUPPORTED_OPERATION", { operation: "queryFilter" }); } return (await provider.getLogs(filter)).map((log) => { return new EventLog(log, this.interface, fragment); }); } async on(event: ContractEventName, listener: Listener): Promise { const sub = await getSub(this, event); sub.listeners.push({ listener, once: false }); sub.start(); return this; } async once(event: ContractEventName, listener: Listener): Promise { const sub = await getSub(this, event); sub.listeners.push({ listener, once: true }); sub.start(); return this; } async emit(event: ContractEventName, ...args: Array): Promise { return await emit(this, event, args, null); } async listenerCount(event?: ContractEventName): Promise { if (event) { const sub = await hasSub(this, event); if (!sub) { return 0; } return sub.listeners.length; } const { subs } = getInternal(this); let total = 0; for (const { listeners } of subs.values()) { total += listeners.length; } return total; } async listeners(event?: ContractEventName): Promise> { if (event) { const sub = await hasSub(this, event); if (!sub) { return [ ]; } return sub.listeners.map(({ listener }) => listener); } const { subs } = getInternal(this); let result: Array = [ ]; for (const { listeners } of subs.values()) { result = result.concat(listeners.map(({ listener }) => listener)); } return result; } async off(event: ContractEventName, listener?: Listener): Promise { const sub = await hasSub(this, event); if (!sub) { return this; } if (listener) { const index = sub.listeners.map(({ listener }) => listener).indexOf(listener); if (index >= 0) { sub.listeners.splice(index, 1); } } if (listener == null || sub.listeners.length === 0) { sub.stop(); getInternal(this).subs.delete(sub.tag); } return this; } async removeAllListeners(event?: ContractEventName): Promise { if (event) { const sub = await hasSub(this, event); if (!sub) { return this; } sub.stop(); getInternal(this).subs.delete(sub.tag); } else { const { subs } = getInternal(this); for (const { tag, stop } of subs.values()) { stop(); subs.delete(tag); } } return this; } // Alias for "on" async addListener(event: ContractEventName, listener: Listener): Promise { return await this.on(event, listener); } // Alias for "off" async removeListener(event: ContractEventName, listener: Listener): Promise { return await this.off(event, listener); } static buildClass(abi: InterfaceAbi): new (target: string, runner?: null | ContractRunner) => BaseContract & Omit { class CustomContract extends BaseContract { constructor(address: string, runner: null | ContractRunner = null) { super(address, abi, runner); } } return CustomContract as any; }; static from(target: string, abi: InterfaceAbi, runner: null | ContractRunner = null): BaseContract & Omit { const contract = new this(target, abi, runner); return contract as any; } } function _ContractBase(): new (target: string, abi: InterfaceAbi, runner?: null | ContractRunner) => BaseContract & Omit { return BaseContract as any; } export class Contract extends _ContractBase() { }