ethers.js/lib.esm/providers/abstract-signer.js

156 lines
5.4 KiB
JavaScript
Raw Normal View History

2022-09-05 23:57:11 +03:00
import { Transaction } from "../transaction/index.js";
2022-09-16 05:58:45 +03:00
import { defineProperties, getBigInt, resolveProperties, throwArgumentError, throwError } from "../utils/index.js";
2022-09-05 23:57:11 +03:00
export class AbstractSigner {
provider;
constructor(provider) {
defineProperties(this, { provider: (provider || null) });
}
#checkProvider(operation) {
if (this.provider) {
return this.provider;
}
2022-09-16 05:58:45 +03:00
return throwError("missing provider", "UNSUPPORTED_OPERATION", { operation });
2022-09-05 23:57:11 +03:00
}
async getNonce(blockTag) {
return this.#checkProvider("getTransactionCount").getTransactionCount(await this.getAddress(), blockTag);
}
async #populate(op, tx) {
const provider = this.#checkProvider(op);
//let pop: Deferrable<TransactionRequest> = Object.assign({ }, tx);
let pop = Object.assign({}, tx);
if (pop.to != null) {
pop.to = provider.resolveName(pop.to).then((to) => {
if (to == null) {
2022-09-16 05:58:45 +03:00
return throwArgumentError("transaction to ENS name not configured", "tx.to", pop.to);
2022-09-05 23:57:11 +03:00
}
return to;
});
}
if (pop.from != null) {
const from = pop.from;
pop.from = Promise.all([
this.getAddress(),
this.resolveName(from)
]).then(([address, from]) => {
if (!from || address.toLowerCase() !== from.toLowerCase()) {
2022-09-16 05:58:45 +03:00
return throwArgumentError("transaction from mismatch", "tx.from", from);
2022-09-05 23:57:11 +03:00
}
return address;
});
}
return pop;
}
async populateCall(tx) {
const pop = await this.#populate("populateCall", tx);
return pop;
}
async populateTransaction(tx) {
const pop = await this.#populate("populateTransaction", tx);
if (pop.nonce == null) {
pop.nonce = await this.getNonce("pending");
}
if (pop.gasLimit == null) {
pop.gasLimit = await this.estimateGas(pop);
}
2022-09-16 05:58:45 +03:00
// Populate the chain ID
const network = await (this.provider).getNetwork();
if (pop.chainId != null) {
const chainId = getBigInt(pop.chainId);
if (chainId !== network.chainId) {
throwArgumentError("transaction chainId mismatch", "tx.chainId", tx.chainId);
}
}
else {
pop.chainId = network.chainId;
}
//@TOOD: Don't await all over the place; save them up for
// the end for better batching
2022-09-05 23:57:11 +03:00
//@TODO: Copy type logic from AbstractSigner in v5
2022-09-16 05:58:45 +03:00
// Test how many batches is actually sent for sending a tx; compare before/after
2022-09-05 23:57:11 +03:00
return await resolveProperties(pop);
}
async estimateGas(tx) {
return this.#checkProvider("estimateGas").estimateGas(await this.populateCall(tx));
}
async call(tx) {
return this.#checkProvider("call").call(await this.populateCall(tx));
}
async resolveName(name) {
const provider = this.#checkProvider("resolveName");
return await provider.resolveName(name);
}
async sendTransaction(tx) {
const provider = this.#checkProvider("sendTransaction");
const txObj = Transaction.from(await this.populateTransaction(tx));
return await provider.broadcastTransaction(await this.signTransaction(txObj));
}
}
export class VoidSigner extends AbstractSigner {
address;
constructor(address, provider) {
super(provider);
defineProperties(this, { address });
}
async getAddress() { return this.address; }
connect(provider) {
return new VoidSigner(this.address, provider);
}
#throwUnsupported(suffix, operation) {
2022-09-16 05:58:45 +03:00
return throwError(`VoidSigner cannot sign ${suffix}`, "UNSUPPORTED_OPERATION", {
2022-09-05 23:57:11 +03:00
operation
});
}
async signTransaction(tx) {
this.#throwUnsupported("transactions", "signTransaction");
}
async signMessage(message) {
this.#throwUnsupported("messages", "signMessage");
}
async signTypedData(domain, types, value) {
this.#throwUnsupported("typed-data", "signTypedData");
}
}
export class WrappedSigner extends AbstractSigner {
#signer;
constructor(signer) {
super(signer.provider);
this.#signer = signer;
}
async getAddress() {
return await this.#signer.getAddress();
}
connect(provider) {
return new WrappedSigner(this.#signer.connect(provider));
}
async getNonce(blockTag) {
return await this.#signer.getNonce(blockTag);
}
async populateCall(tx) {
return await this.#signer.populateCall(tx);
}
async populateTransaction(tx) {
return await this.#signer.populateTransaction(tx);
}
async estimateGas(tx) {
return await this.#signer.estimateGas(tx);
}
async call(tx) {
return await this.#signer.call(tx);
}
async resolveName(name) {
return this.#signer.resolveName(name);
}
async signTransaction(tx) {
return await this.#signer.signTransaction(tx);
}
async sendTransaction(tx) {
return await this.#signer.sendTransaction(tx);
}
async signMessage(message) {
return await this.#signer.signMessage(message);
}
async signTypedData(domain, types, value) {
return await this.#signer.signTypedData(domain, types, value);
}
}
//# sourceMappingURL=abstract-signer.js.map