958 lines
23 KiB
Plaintext
958 lines
23 KiB
Plaintext
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: CompilerOptions
|
|
|
|
Options you can specify (as flags or in a compiler.json file) when invoking sol-compiler
|
|
contractsDir: Directory containing your project's Solidity contracts. Can contain nested directories.
|
|
artifactsDir: Directory where you want the generated artifacts.json written to
|
|
compilerSettings: Desired settings to pass to the Solidity compiler during compilation.
|
|
(http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description)
|
|
contracts: List of contract names you wish to compile, or alternatively ['*'] to compile all contracts in the
|
|
specified directory.
|
|
useDockerisedSolc: If set to true - sol-compiler will try calling a dockerized installations of solc to achieve faster compilation times. Otherwise and by default - solcjs will be used. Defaults to false.
|
|
isOfflineMode: If set to true - sol-compiler will not fetch the list of solc releases from github. It will use the hardcoded list. Defaults to false.
|
|
solcVersion: If you don't want to compile each contract with the Solidity version specified in-file, you can force all
|
|
contracts to compile with the the version specified here.
|
|
shouldSaveStandardInput: Write the standard JSON input in ${contractsDir}/${contractName}.input.json
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` artifactsDir
|
|
|
|
• **artifactsDir**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L733)*
|
|
|
|
___
|
|
|
|
### `Optional` compilerSettings
|
|
|
|
• **compilerSettings**? : *[CompilerSettings](#class-compilersettings)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L734)*
|
|
|
|
___
|
|
|
|
### `Optional` contracts
|
|
|
|
• **contracts**? : *string[] | "*"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L735)*
|
|
|
|
___
|
|
|
|
### `Optional` contractsDir
|
|
|
|
• **contractsDir**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L732)*
|
|
|
|
___
|
|
|
|
### `Optional` isOfflineMode
|
|
|
|
• **isOfflineMode**? : *undefined | false | true*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L737)*
|
|
|
|
___
|
|
|
|
### `Optional` shouldSaveStandardInput
|
|
|
|
• **shouldSaveStandardInput**? : *undefined | false | true*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:739](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L739)*
|
|
|
|
___
|
|
|
|
### `Optional` solcVersion
|
|
|
|
• **solcVersion**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L738)*
|
|
|
|
___
|
|
|
|
### `Optional` useDockerisedSolc
|
|
|
|
• **useDockerisedSolc**? : *undefined | false | true*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L736)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
# Interface: CompilerSettings
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` evmVersion
|
|
|
|
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)*
|
|
|
|
___
|
|
|
|
### `Optional` libraries
|
|
|
|
• **libraries**? : *undefined | object*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)*
|
|
|
|
___
|
|
|
|
### `Optional` metadata
|
|
|
|
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)*
|
|
|
|
___
|
|
|
|
### `Optional` optimizer
|
|
|
|
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)*
|
|
|
|
___
|
|
|
|
### outputSelection
|
|
|
|
• **outputSelection**: *object*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)*
|
|
|
|
#### Type declaration:
|
|
|
|
● \[▪ **fileName**: *string*\]: object
|
|
|
|
● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[]
|
|
|
|
___
|
|
|
|
### `Optional` remappings
|
|
|
|
• **remappings**? : *string[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
|
|
|
|
<hr />
|
|
|
|
# Interface: CompilerSettingsMetadata
|
|
|
|
|
|
## Properties
|
|
|
|
### useLiteralContent
|
|
|
|
• **useLiteralContent**: *true*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
|
|
|
|
<hr />
|
|
|
|
# Interface: ConstructorAbi
|
|
|
|
|
|
## Properties
|
|
|
|
### inputs
|
|
|
|
• **inputs**: *[DataItem](#class-dataitem)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)*
|
|
|
|
___
|
|
|
|
### payable
|
|
|
|
• **payable**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)*
|
|
|
|
___
|
|
|
|
### stateMutability
|
|
|
|
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: DataItem
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` components
|
|
|
|
• **components**? : *[DataItem](#class-dataitem)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)*
|
|
|
|
___
|
|
|
|
### `Optional` internalType
|
|
|
|
• **internalType**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: DevdocOutput
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` author
|
|
|
|
• **author**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)*
|
|
|
|
___
|
|
|
|
### methods
|
|
|
|
• **methods**: *object*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)*
|
|
|
|
#### Type declaration:
|
|
|
|
● \[▪ **signature**: *string*\]: object
|
|
|
|
___
|
|
|
|
### `Optional` title
|
|
|
|
• **title**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
# Interface: EventAbi
|
|
|
|
|
|
## Properties
|
|
|
|
### anonymous
|
|
|
|
• **anonymous**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L131)*
|
|
|
|
___
|
|
|
|
### inputs
|
|
|
|
• **inputs**: *[EventParameter](#class-eventparameter)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L130)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L129)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L128)*
|
|
|
|
<hr />
|
|
|
|
# Interface: EventParameter
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` components
|
|
|
|
• **components**? : *[DataItem](#class-dataitem)[]*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[components](#optional-components)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)*
|
|
|
|
___
|
|
|
|
### indexed
|
|
|
|
• **indexed**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L116)*
|
|
|
|
___
|
|
|
|
### `Optional` internalType
|
|
|
|
• **internalType**? : *undefined | string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
|
|
|
|
<hr />
|
|
|
|
# Interface: EvmBytecodeOutput
|
|
|
|
|
|
## Properties
|
|
|
|
### object
|
|
|
|
• **object**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)*
|
|
|
|
___
|
|
|
|
### sourceMap
|
|
|
|
• **sourceMap**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
|
|
|
|
<hr />
|
|
|
|
# Interface: EvmOutput
|
|
|
|
|
|
## Properties
|
|
|
|
### bytecode
|
|
|
|
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)*
|
|
|
|
___
|
|
|
|
### deployedBytecode
|
|
|
|
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
|
|
|
|
<hr />
|
|
|
|
# Interface: FallbackAbi
|
|
|
|
|
|
## Properties
|
|
|
|
### payable
|
|
|
|
• **payable**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
# Class: Compiler
|
|
|
|
The Compiler facilitates compiling Solidity smart contracts and saves the results
|
|
to artifact files.
|
|
|
|
|
|
## Constructors
|
|
|
|
|
|
|
|
\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)*
|
|
|
|
*Defined in [sol-compiler/src/compiler.ts:100](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L100)*
|
|
|
|
Instantiates a new instance of the Compiler class.
|
|
|
|
**Parameters:**
|
|
|
|
Name | Type | Description |
|
|
------ | ------ | ------ |
|
|
`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options |
|
|
|
|
**Returns:** *[Compiler](#class-compiler)*
|
|
|
|
An instance of the Compiler class.
|
|
|
|
## Methods
|
|
|
|
### compileAsync
|
|
|
|
▸ **compileAsync**(): *`Promise<void>`*
|
|
|
|
*Defined in [sol-compiler/src/compiler.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L143)*
|
|
|
|
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
|
|
|
|
**Returns:** *`Promise<void>`*
|
|
|
|
___
|
|
|
|
### getCompilerOutputsAsync
|
|
|
|
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
|
|
|
|
*Defined in [sol-compiler/src/compiler.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L156)*
|
|
|
|
Compiles Solidity files specified during instantiation, and returns the
|
|
compiler output given by solc. Return value is an array of outputs:
|
|
Solidity modules are batched together by version required, and each
|
|
element of the returned array corresponds to a compiler version, and
|
|
each element contains the output for all of the modules compiled with
|
|
that version.
|
|
|
|
**Returns:** *`Promise<StandardOutput[]>`*
|
|
|
|
___
|
|
|
|
### getContractNamesToCompile
|
|
|
|
▸ **getContractNamesToCompile**(): *string[]*
|
|
|
|
*Defined in [sol-compiler/src/compiler.ts:197](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L197)*
|
|
|
|
Gets a list of contracts to compile.
|
|
|
|
**Returns:** *string[]*
|
|
|
|
___
|
|
|
|
### watchAsync
|
|
|
|
▸ **watchAsync**(): *`Promise<void>`*
|
|
|
|
*Defined in [sol-compiler/src/compiler.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L160)*
|
|
|
|
**Returns:** *`Promise<void>`*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: MethodAbi
|
|
|
|
|
|
## Properties
|
|
|
|
### constant
|
|
|
|
• **constant**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)*
|
|
|
|
___
|
|
|
|
### inputs
|
|
|
|
• **inputs**: *[DataItem](#class-dataitem)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)*
|
|
|
|
___
|
|
|
|
### outputs
|
|
|
|
• **outputs**: *[DataItem](#class-dataitem)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)*
|
|
|
|
___
|
|
|
|
### payable
|
|
|
|
• **payable**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)*
|
|
|
|
___
|
|
|
|
### stateMutability
|
|
|
|
• **stateMutability**: *[StateMutability](#statemutability)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
|
|
|
|
<hr />
|
|
|
|
# Interface: OptimizerSettings
|
|
|
|
|
|
## Properties
|
|
|
|
### enabled
|
|
|
|
• **enabled**: *boolean*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)*
|
|
|
|
___
|
|
|
|
### `Optional` runs
|
|
|
|
• **runs**? : *undefined | number*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: RevertErrorAbi
|
|
|
|
|
|
## Properties
|
|
|
|
### `Optional` arguments
|
|
|
|
• **arguments**? : *[DataItem](#class-dataitem)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *"error"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
|
|
|
|
<hr />
|
|
|
|
# Interface: SolcError
|
|
|
|
|
|
## Properties
|
|
|
|
### component
|
|
|
|
• **component**: *"general" | "ewasm"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L605)*
|
|
|
|
___
|
|
|
|
### `Optional` formattedMessage
|
|
|
|
• **formattedMessage**? : *undefined | string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:608](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L608)*
|
|
|
|
___
|
|
|
|
### message
|
|
|
|
• **message**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L607)*
|
|
|
|
___
|
|
|
|
### severity
|
|
|
|
• **severity**: *[ErrorSeverity](#errorseverity)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L606)*
|
|
|
|
___
|
|
|
|
### `Optional` sourceLocation
|
|
|
|
• **sourceLocation**? : *[SourceLocation](#class-sourcelocation)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L603)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *[ErrorType](#errortype)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L604)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: StandardContractOutput
|
|
|
|
|
|
## Properties
|
|
|
|
### abi
|
|
|
|
• **abi**: *[ContractAbi](#contractabi)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)*
|
|
|
|
___
|
|
|
|
### `Optional` devdoc
|
|
|
|
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)*
|
|
|
|
___
|
|
|
|
### evm
|
|
|
|
• **evm**: *[EvmOutput](#class-evmoutput)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
|
|
|
|
<hr />
|
|
|
|
# Interface: StandardOutput
|
|
|
|
|
|
## Properties
|
|
|
|
### contracts
|
|
|
|
• **contracts**: *object*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:579](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L579)*
|
|
|
|
#### Type declaration:
|
|
|
|
● \[▪ **fileName**: *string*\]: object
|
|
|
|
● \[▪ **contractName**: *string*\]: [StandardContractOutput](#class-standardcontractoutput)
|
|
|
|
___
|
|
|
|
### errors
|
|
|
|
• **errors**: *[SolcError](#class-solcerror)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L571)*
|
|
|
|
___
|
|
|
|
### sources
|
|
|
|
• **sources**: *object*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:572](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L572)*
|
|
|
|
#### Type declaration:
|
|
|
|
● \[▪ **fileName**: *string*\]: object
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Interface: TupleDataItem
|
|
|
|
|
|
## Properties
|
|
|
|
### components
|
|
|
|
• **components**: *[DataItem](#class-dataitem)[]*
|
|
|
|
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)*
|
|
|
|
___
|
|
|
|
### `Optional` internalType
|
|
|
|
• **internalType**? : *undefined | string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• **name**: *string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: *string*
|
|
|
|
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Type aliases
|
|
|
|
### AbiDefinition
|
|
|
|
Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)*
|
|
|
|
___
|
|
|
|
|
|
|
|
### ConstructorStateMutability
|
|
|
|
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)*
|
|
|
|
___
|
|
|
|
### ContractAbi
|
|
|
|
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)*
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### ErrorSeverity
|
|
|
|
Ƭ **ErrorSeverity**: *"error" | "warning"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:600](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L600)*
|
|
|
|
___
|
|
|
|
### ErrorType
|
|
|
|
Ƭ **ErrorType**: *"JSONError" | "IOError" | "ParserError" | "DocstringParsingError" | "SyntaxError" | "DeclarationError" | "TypeError" | "UnimplementedFeatureError" | "InternalCompilerError" | "Exception" | "CompilerError" | "FatalError" | "Warning"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:586](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L586)*
|
|
|
|
___
|
|
|
|
### FunctionAbi
|
|
|
|
Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)*
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
|
|
### OutputField
|
|
|
|
Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)*
|
|
|
|
___
|
|
|
|
### ParamDescription
|
|
|
|
Ƭ **ParamDescription**: *string*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)*
|
|
|
|
___
|
|
|
|
|
|
|
|
### StateMutability
|
|
|
|
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
|
|
|
|
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)*
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|