ConnectedProject | @truffle/db

Hierarchy

Project
- ConnectedProject

Index

Constructor

connect

Truffle-specific

Other

Processor

Constructor

connect

connect(options: { provider: Provider }): ConnectedProject

Inherited from Project.connect
- Defined in packages/db/src/project/index.ts:165
Accept a provider to enable workflows that require communicating with the underlying blockchain network.

Parameters
- options: { provider: Provider }
  - provider: Provider
Returns ConnectedProject

Truffle-specific

loadCompile

loadCompile(options: { result: WorkflowCompileResult }): Promise<{ compilations: Compilation[]; contracts: Contract[] }>

Inherited from Project.loadCompile
- Defined in packages/db/src/project/index.ts:92
Accept a compilation result and process it to save all relevant resources (Source, Bytecode, Compilation, Contract)

This returns the same WorkflowCompileResult but with additional references to each of the added resources.

Parameters
- options: { result: WorkflowCompileResult }
  - result: WorkflowCompileResult
Returns Promise<{ compilations: Compilation[]; contracts: Contract[] }>

loadMigrate

loadMigrate(options: { artifacts: (ContractObject & { db: { callBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">>; contract: IdObject<Collections, "contracts", Contract> | IdObject<Collections, "contracts", SavedInput<Collections, "contracts">>; createBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">> } })[]; network: Pick<NetworkInput, "name"> }): Promise<{ artifacts: Artifact[]; network: IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">> }>

- Defined in packages/db/src/project/index.ts:245
Process artifacts after a migration. Uses provider to determine most relevant network information directly, but still requires project-specific information about the network (i.e., name)

This adds potentially multiple Network resources to @truffle/db, creating individual networks for the historic blocks in which each ContractInstance was first created on-chain.

This saves Network and ContractInstance resources to @truffle/db.

Returns artifacts with network objects populated with IDs for each ContractInstance, along with a network object containing the ID of whichever Network was added with the highest block height.

Parameters
- options: { artifacts: (ContractObject & { db: { callBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">>; contract: IdObject<Collections, "contracts", Contract> | IdObject<Collections, "contracts", SavedInput<Collections, "contracts">>; createBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">> } })[]; network: Pick<NetworkInput, "name"> }
  - artifacts: (ContractObject & { db: { callBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">>; contract: IdObject<Collections, "contracts", Contract> | IdObject<Collections, "contracts", SavedInput<Collections, "contracts">>; createBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">> } })[]
  - network: Pick<NetworkInput, "name">
Returns Promise<{ artifacts: Artifact[]; network: IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">> }>

Other

id

get id(): string

- Defined in packages/db/src/project/index.ts:77
Returns string

assignNames

assignNames<N>(options: { assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, K, CollectionProperty<"resource", Collections, K>> | IdObject<Collections, K, SavedInput<Collections, K>>)[] } }): Promise<{ assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, "nameRecords", NameRecord> | IdObject<Collections, "nameRecords", SavedInput<Collections, "nameRecords">>)[] } }>

Inherited from Project.assignNames
- Defined in packages/db/src/project/index.ts:137
Update name pointers for this project. Currently affords name-keeping for Network and Contract resources (e.g., naming ContractInstance resources is not supported directly)

This saves NameRecord and ProjectName resources to @truffle/db.

Returns a list of NameRecord resources for completeness, although these may be regarded as an internal concern. ProjectName resources are not returned because they are mutable; returned representations would be impermanent.
example
```
await project.assignNames({
  assignments: {
    contracts: [
      { id: "<contract1-id>" },
      { id: "<contract2-id>" },
      // ...
    }
  }
});
```
Type parameters
- N: FilteredCollectionName<Collections, { is: "named" }>
  
  Either "contracts", "networks", or "contracts" | "networks".
Parameters
- options: { assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, K, CollectionProperty<"resource", Collections, K>> | IdObject<Collections, K, SavedInput<Collections, K>>)[] } }
  - assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, K, CollectionProperty<"resource", Collections, K>> | IdObject<Collections, K, SavedInput<Collections, K>>)[] }
    
    Object whose keys belong to the set of named collection names and whose values are IdObjects for resources of that collection.
Returns Promise<{ assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, "nameRecords", NameRecord> | IdObject<Collections, "nameRecords", SavedInput<Collections, "nameRecords">>)[] } }>

Private populateNetworks

populateNetworks<Artifact>(options: { artifacts: Artifact[]; knownLatest: Pick<Network, "id" | "networkId">; networks: (undefined | IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">>)[] }): (Artifact & { networks?: undefined | {} })[]

- Defined in packages/db/src/project/index.ts:294
Type parameters
- Artifact: ContractObject & { db: { callBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">>; contract: IdObject<Collections, "contracts", Contract> | IdObject<Collections, "contracts", SavedInput<Collections, "contracts">>; createBytecode: IdObject<Collections, "bytecodes", Bytecode> | IdObject<Collections, "bytecodes", SavedInput<Collections, "bytecodes">> } }
Parameters
- options: { artifacts: Artifact[]; knownLatest: Pick<Network, "id" | "networkId">; networks: (undefined | IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">>)[] }
  - artifacts: Artifact[]
  - knownLatest: Pick<Network, "id" | "networkId">
  - networks: (undefined | IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">>)[]
Returns (Artifact & { networks?: undefined | {} })[]

Processor

run

run<A, T, R>(processor: Processor<Collections, A, T, R>, ...args: A): Promise<T>

Inherited from Project.run
- Defined in packages/db/src/project/index.ts:183
Run a given Processor with specified arguments.

This method is a ProcessorRunner and can be used to await (e.g.) the processors defined by Process's resources.

Type parameters
- A: unknown[]
- T = any
- R: undefined | GraphQlRequestType<Collections, string> | Web3RequestType<Collections, string> = undefined
Parameters
- processor: Processor<Collections, A, T, R>
- Rest ...args: A
Returns Promise<T>

Hierarchy

Index

Constructor

Truffle-specific

Other

Processor

Constructor

connect

Parameters

options: { provider: Provider }

provider: Provider

Returns ConnectedProject

Truffle-specific

loadCompile

Parameters

options: { result: WorkflowCompileResult }

result: WorkflowCompileResult

Returns Promise<{ compilations: Compilation[]; contracts: Contract[] }>

loadMigrate

Parameters

network: Pick<NetworkInput, "name">

Returns Promise<{ artifacts: Artifact[]; network: IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">> }>

Other

id

Returns string

assignNames

Type parameters

N: FilteredCollectionName<Collections, { is: "named" }>

Parameters

options: { assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, K, CollectionProperty<"resource", Collections, K>> | IdObject<Collections, K, SavedInput<Collections, K>>)[] } }

assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, K, CollectionProperty<"resource", Collections, K>> | IdObject<Collections, K, SavedInput<Collections, K>>)[] }

Returns Promise<{ assignments: {[ K in FilteredCollectionName<Collections, { is: "named" }>]: (IdObject<Collections, "nameRecords", NameRecord> | IdObject<Collections, "nameRecords", SavedInput<Collections, "nameRecords">>)[] } }>

Private populateNetworks

Type parameters

Parameters

options: { artifacts: Artifact[]; knownLatest: Pick<Network, "id" | "networkId">; networks: (undefined | IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">>)[] }

artifacts: Artifact[]

knownLatest: Pick<Network, "id" | "networkId">

networks: (undefined | IdObject<Collections, "networks", Network> | IdObject<Collections, "networks", SavedInput<Collections, "networks">>)[]

Returns (Artifact & { networks?: undefined | {} })[]

Processor

run

Type parameters

A: unknown[]

T = any

R: undefined | GraphQlRequestType<Collections, string> | Web3RequestType<Collections, string> = undefined

Parameters

processor: Processor<Collections, A, T, R>

Rest ...args: A

Returns Promise<T>