'use strict'; import { EventDescription, Interface } from './interface'; import { Provider, TransactionRequest, TransactionResponse } from '../providers/provider'; import { Signer } from '../wallet/wallet'; import { defaultAbiCoder } from '../utils/abi-coder'; import { getContractAddress } from '../utils/address'; import { hexDataLength, hexDataSlice, isHexString } from '../utils/bytes'; import { ParamType } from '../utils/abi-coder'; import { BigNumber, ConstantZero } from '../utils/bignumber'; import { defineReadOnly, shallowCopy } from '../utils/properties'; import { poll } from '../utils/web'; import * as errors from '../utils/errors'; var allowedTransactionKeys: { [ key: string ]: boolean } = { data: true, from: true, gasLimit: true, gasPrice:true, nonce: true, to: true, value: true } // Recursively replaces ENS names with promises to resolve the name and // stalls until all promises have returned // @TODO: Expand this to resolve any promises too function resolveAddresses(provider: Provider, value: any, paramType: ParamType | Array): Promise { if (Array.isArray(paramType)) { var promises: Array> = []; paramType.forEach((paramType, index) => { var v = null; if (Array.isArray(value)) { v = value[index]; } else { v = value[paramType.name]; } promises.push(resolveAddresses(provider, v, paramType)); }); return Promise.all(promises); } if (paramType.type === 'address') { return provider.resolveName(value); } if (paramType.components) { return resolveAddresses(provider, value, paramType.components); } return Promise.resolve(value); } type RunFunction = (...params: Array) => Promise; function runMethod(contract: Contract, functionName: string, estimateOnly: boolean): RunFunction { let method = contract.interface.functions[functionName]; return function(...params): Promise { var tx: any = {} // If 1 extra parameter was passed in, it contains overrides if (params.length === method.inputs.length + 1 && typeof(params[params.length - 1]) === 'object') { tx = shallowCopy(params.pop()); // Check for unexpected keys (e.g. using "gas" instead of "gasLimit") for (var key in tx) { if (!allowedTransactionKeys[key]) { throw new Error('unknown transaction override ' + key); } } } if (params.length != method.inputs.length) { throw new Error('incorrect number of arguments'); } // Check overrides make sense ['data', 'to'].forEach(function(key) { if (tx[key] != null) { errors.throwError('cannot override ' + key, errors.UNSUPPORTED_OPERATION, { operation: key }) } }); // Send to the contract address tx.to = contract.addressPromise; return resolveAddresses(contract.provider, params, method.inputs).then((params) => { tx.data = method.encode(params); if (method.type === 'call') { // Call (constant functions) always cost 0 ether if (estimateOnly) { return Promise.resolve(ConstantZero); } if (!contract.provider) { errors.throwError('call (constant functions) require a provider or a signer with a provider', errors.UNSUPPORTED_OPERATION, { operation: 'call' }) } // Check overrides make sense ['gasLimit', 'gasPrice', 'value'].forEach(function(key) { if (tx[key] != null) { throw new Error('call cannot override ' + key) ; } }); if (tx.from == null && contract.signer) { tx.from = contract.signer.getAddress() } return contract.provider.call(tx).then((value) => { if ((hexDataLength(value) % 32) === 4 && hexDataSlice(value, 0, 4) === '0x08c379a0') { let reason = defaultAbiCoder.decode([ 'string' ], hexDataSlice(value, 4)); errors.throwError('call revert exception', errors.CALL_EXCEPTION, { address: contract.address, args: params, method: method.signature, errorSignature: 'Error(string)', errorArgs: [ reason ], reason: reason, transaction: tx }); } try { let result = method.decode(value); if (method.outputs.length === 1) { result = result[0]; } return result; } catch (error) { if (value === '0x' && method.outputs.length > 0) { errors.throwError('call exception', errors.CALL_EXCEPTION, { address: contract.address, method: method.signature, args: params }); } throw error; } }); } else if (method.type === 'transaction') { // Only computing the transaction estimate if (estimateOnly) { if (!contract.provider) { errors.throwError('estimate gas require a provider or a signer with a provider', errors.UNSUPPORTED_OPERATION, { operation: 'estimateGas' }) } if (tx.from == null && contract.signer) { tx.from = contract.signer.getAddress() } return contract.provider.estimateGas(tx); } if (!contract.signer) { errors.throwError('sending a transaction require a signer', errors.UNSUPPORTED_OPERATION, { operation: 'sendTransaction' }) } // Make sure they aren't overriding something they shouldn't if (tx.from != null) { errors.throwError('cannot override from in a transaction', errors.UNSUPPORTED_OPERATION, { operation: 'sendTransaction' }) } return contract.signer.sendTransaction(tx); } throw new Error('invalid type - ' + method.type); return null; }); } } export type ContractEstimate = (...params: Array) => Promise; export type ContractFunction = (...params: Array) => Promise; export type ContractEvent = (...params: Array) => void; interface Bucket { [name: string]: T; } export type ErrorCallback = (error: Error) => void; export type Contractish = Array | Interface | string; export class Contract { readonly address: string; readonly interface: Interface; readonly signer: Signer; readonly provider: Provider; readonly estimate: Bucket; readonly functions: Bucket; readonly events: Bucket; readonly addressPromise: Promise; // This is only set if the contract was created with a call to deploy readonly deployTransaction: TransactionResponse; private _onerror: ErrorCallback; // https://github.com/Microsoft/TypeScript/issues/5453 // Once this issue is resolved (there are open PR) we can do this nicer // by making addressOrName default to null for 2 operand calls. :) constructor(addressOrName: string, contractInterface: Contractish, signerOrProvider: Signer | Provider) { errors.checkNew(this, Contract); // @TODO: Maybe still check the addressOrName looks like a valid address or name? //address = getAddress(address); if (contractInterface instanceof Interface) { defineReadOnly(this, 'interface', contractInterface); } else { defineReadOnly(this, 'interface', new Interface(contractInterface)); } if (signerOrProvider instanceof Signer) { defineReadOnly(this, 'provider', signerOrProvider.provider); defineReadOnly(this, 'signer', signerOrProvider); } else if (signerOrProvider instanceof Provider) { defineReadOnly(this, 'provider', signerOrProvider); defineReadOnly(this, 'signer', null); } else { errors.throwError('invalid signer or provider', errors.INVALID_ARGUMENT, { arg: 'signerOrProvider', value: signerOrProvider }); } defineReadOnly(this, 'estimate', { }); defineReadOnly(this, 'events', { }); defineReadOnly(this, 'functions', { }); // Not connected to an on-chain instance, so do not connect functions and events if (!addressOrName) { defineReadOnly(this, 'address', null); defineReadOnly(this, 'addressPromise', Promise.resolve(null)); return; } defineReadOnly(this, 'address', addressOrName); defineReadOnly(this, 'addressPromise', this.provider.resolveName(addressOrName)); Object.keys(this.interface.functions).forEach((name) => { var run = runMethod(this, name, false); if ((this)[name] == null) { defineReadOnly(this, name, run); } else { console.log('WARNING: Multiple definitions for ' + name); } if (this.functions[name] == null) { defineReadOnly(this.functions, name, run); defineReadOnly(this.estimate, name, runMethod(this, name, true)); } }); Object.keys(this.interface.events).forEach((eventName) => { let eventInfo: EventDescription = this.interface.events[eventName]; type Callback = (...args: Array) => void; let eventCallback: Callback = null; let contract = this; function handleEvent(log: any): void { contract.addressPromise.then((address) => { // Not meant for us (the topics just has the same name) if (address != log.address) { return; } try { let result = eventInfo.decode(log.data, log.topics); // Some useful things to have with the log log.args = result; log.event = eventName; log.decode = eventInfo.decode; log.removeListener = function() { contract.provider.removeListener([ eventInfo.topic ], handleEvent); } log.getBlock = function() { return contract.provider.getBlock(log.blockHash);; } log.getTransaction = function() { return contract.provider.getTransaction(log.transactionHash); } log.getTransactionReceipt = function() { return contract.provider.getTransactionReceipt(log.transactionHash); } log.eventSignature = eventInfo.signature; eventCallback.apply(log, Array.prototype.slice.call(result)); } catch (error) { console.log(error); let onerror = contract._onerror; if (onerror) { setTimeout(() => { onerror(error); }); } } }); } var property = { enumerable: true, get: function() { return eventCallback; }, set: function(value: Callback) { if (!value) { value = null; } if (!contract.provider) { errors.throwError('events require a provider or a signer with a provider', errors.UNSUPPORTED_OPERATION, { operation: 'events' }) } if (!value && eventCallback) { contract.provider.removeListener([ eventInfo.topic ], handleEvent); } else if (value && !eventCallback) { contract.provider.on([ eventInfo.topic ], handleEvent); } eventCallback = value; } }; var propertyName = 'on' + eventName.toLowerCase(); if ((this)[propertyName] == null) { Object.defineProperty(this, propertyName, property); } Object.defineProperty(this.events, eventName, property); }, this); } get onerror() { return this._onerror; } set onerror(callback: ErrorCallback) { this._onerror = callback; } // @TODO: Allow timeout? deployed(): Promise { // If we were just deployed, we know the transaction we should occur in if (this.deployTransaction) { return this.deployTransaction.wait().then(() => { return this; }); } // Otherwise, poll for our code to be deployed return poll(() => { return this.provider.getCode(this.address).then((code) => { if (code === '0x') { return undefined; } return this; }); }, { onceBlock: this.provider }); } // @TODO: // estimateFallback(overrides?: TransactionRequest): Promise // @TODO: // estimateDeploy(bytecode: string, ...args): Promise fallback(overrides?: TransactionRequest): Promise { if (!this.signer) { errors.throwError('sending a transaction require a signer', errors.UNSUPPORTED_OPERATION, { operation: 'sendTransaction(fallback)' }) } var tx: TransactionRequest = shallowCopy(overrides || {}); ['from', 'to'].forEach(function(key) { if ((tx)[key] == null) { return; } errors.throwError('cannot override ' + key, errors.UNSUPPORTED_OPERATION, { operation: key }) }); tx.to = this.addressPromise; return this.signer.sendTransaction(tx); } // Reconnect to a different signer or provider connect(signerOrProvider: Signer | Provider): Contract { return new Contract(this.address, this.interface, signerOrProvider); } // Re-attach to a different on=chain instance of this contract attach(addressOrName: string): Contract { return new Contract(addressOrName, this.interface, this.signer || this.provider); } // Deploy the contract with the bytecode, resolving to the deployed address. // Use contract.deployTransaction.wait() to wait until the contract has // been mined. deploy(bytecode: string, ...args: Array): Promise { if (this.signer == null) { throw new Error('missing signer'); // @TODO: errors.throwError } // A lot of common tools do not prefix bytecode with a 0x if (typeof(bytecode) === 'string' && bytecode.match(/^[0-9a-f]*$/i) && (bytecode.length % 2) == 0) { bytecode = '0x' + bytecode; } if (!isHexString(bytecode)) { errors.throwError('bytecode must be a valid hex string', errors.INVALID_ARGUMENT, { arg: 'bytecode', value: bytecode }); } if ((bytecode.length % 2) !== 0) { errors.throwError('bytecode must be valid data (even length)', errors.INVALID_ARGUMENT, { arg: 'bytecode', value: bytecode }); } let tx: TransactionRequest = { }; if (args.length === this.interface.deployFunction.inputs.length + 1) { tx = shallowCopy(args.pop()); for (var key in tx) { if (!allowedTransactionKeys[key]) { throw new Error('unknown transaction override ' + key); } } } ['data', 'from', 'to'].forEach(function(key) { if ((tx)[key] == null) { return; } errors.throwError('cannot override ' + key, errors.UNSUPPORTED_OPERATION, { operation: key }) }); tx.data = this.interface.deployFunction.encode(bytecode, args); errors.checkArgumentCount(args.length, this.interface.deployFunction.inputs.length, 'in Contract constructor'); // @TODO: overrides of args.length = this.interface.deployFunction.inputs.length + 1 return this.signer.sendTransaction(tx).then((tx) => { let contract = new Contract(getContractAddress(tx), this.interface, this.signer || this.provider); defineReadOnly(contract, 'deployTransaction', tx); return contract; }); } }