Namespace: Deploy
Namespaces
- AllDeploy
- AssetRouterCraftDeploy
- AssetRouterInputDeploy
- AssetRouterOutputDeploy
- DeterministicDeployerDeploy
- ERC1155DnaDeploy
- ERC1155MintableDeploy
- ERC1820Deploy
- ERC20MintableDeploy
- ERC721DnaDeploy
- ERC721MintableAutoIdDeploy
- ERC721MintableDeploy
- ERC721TopDownDnaDeploy
- ExamplesDeploy
- ImplementationsDeploy
- ProxyFactoryDeploy
- UpgradeableBeaconDeploy
Interfaces
- AssetRouterCraftDeployParams
- AssetRouterInputDeployParams
- AssetRouterOutputDeployParams
- ERC721TopDownDnaDeployParams
- RunTimeEnvironment
Variables
AllDeploy
• Const AllDeploy: Object
Call signature
▸ (): Promise<void>
Returns
Promise<void>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/all.ts:2
AssetRouterCraftDeploy
• Const AssetRouterCraftDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | AssetRouterCraftDeployParams |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/plugins/AssetRouter/AssetRouterCraft.ts:17
AssetRouterInputDeploy
• Const AssetRouterInputDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | AssetRouterInputDeployParams |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/plugins/AssetRouter/AssetRouterInput.ts:16
AssetRouterOutputDeploy
• Const AssetRouterOutputDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | AssetRouterOutputDeployParams |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/plugins/AssetRouter/AssetRouterOutput.ts:17
DeterministicDeployerDeploy
• Const DeterministicDeployerDeploy: Object
Call signature
▸ («destructured»): Promise<{ address: string = proxyAddress; tx: undefined = deploymentTx } | { address: string = proxyAddress; tx: string = deploymentTx }>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<{ address: string = proxyAddress; tx: undefined = deploymentTx } | { address: string = proxyAddress; tx: string = deploymentTx }>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/common/DeterministicDeployer.ts:15
ERC1155DnaDeploy
• Const ERC1155DnaDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC1155/ERC1155Dna.ts:16
ERC1155MintableDeploy
• Const ERC1155MintableDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC1155/ERC1155Mintable.ts:16
ERC1820Deploy
• Const ERC1820Deploy: Object
Call signature
▸ («destructured»): Promise<{ address: string = registryAddress; tx: string = deploymentTx }>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<{ address: string = registryAddress; tx: string = deploymentTx }>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/common/ERC1820.ts:10
ERC20MintableDeploy
• Const ERC20MintableDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC20/ERC20Mintable.ts:17
ERC721DnaDeploy
• Const ERC721DnaDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC721/ERC721Dna.ts:17
ERC721MintableAutoIdDeploy
• Const ERC721MintableAutoIdDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC721/ERC721MintableAutoId.ts:20
ERC721MintableDeploy
• Const ERC721MintableDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | Params |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC721/ERC721Mintable.ts:17
ERC721TopDownDnaDeploy
• Const ERC721TopDownDnaDeploy: Object
Call signature
▸ («destructured»): Promise<{}>
Parameters
| Name | Type |
|---|---|
«destructured» | ERC721TopDownDnaDeployParams |
Returns
Promise<{}>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/assets/ERC721/ERC721TopDownDna.ts:20
ExamplesDeploy
• Const ExamplesDeploy: Object
Call signature
▸ («destructured»): Promise<{ AssetRouterCraft: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterInput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterOutput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; BeaconProxy: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1167Factory: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC20Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721MintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Fallback: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Multicall2: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; UpgradeableBeacon: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } }>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<{ AssetRouterCraft: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterInput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterOutput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; BeaconProxy: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1167Factory: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC20Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721MintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Fallback: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Multicall2: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; UpgradeableBeacon: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } }>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/examples/Examples.ts:5
ImplementationsDeploy
• Const ImplementationsDeploy: Object
Call signature
▸ («destructured»): Promise<{ AssetRouterCraft: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterInput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterOutput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; BeaconProxy: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1167Factory: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC20Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721MintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Fallback: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Multicall2: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; UpgradeableBeacon: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } }>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<{ AssetRouterCraft: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterInput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; AssetRouterOutput: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; BeaconProxy: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1155Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC1167Factory: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC20Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Dna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721Mintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721MintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDna: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownDnaMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownLib: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintable: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; ERC721TopDownMintableAutoId: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Fallback: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; Multicall2: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } ; UpgradeableBeacon: { address: string ; contract: Contract | Fallback ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown } }>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/common/Implementations.ts:10
ProxyFactoryDeploy
• Const ProxyFactoryDeploy: Object
Call signature
▸ («destructured»): Promise<ERC1167Factory>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<ERC1167Factory>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/common/ProxyFactory.ts:7
UpgradeableBeaconDeploy
• Const UpgradeableBeaconDeploy: Object
Call signature
▸ («destructured»): Promise<Dictionary<{ address: string ; contract: UpgradeableBeacon ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown }>>
Parameters
| Name | Type |
|---|---|
«destructured» | RunTimeEnvironment |
Returns
Promise<Dictionary<{ address: string ; contract: UpgradeableBeacon ; deployed: boolean = false; error: undefined } | { address: string ; contract: undefined ; deployed: undefined = false; error: unknown }>>
Type declaration
| Name | Type |
|---|---|
dependencies | string[] |
tags | string[] |
Defined in
packages-public/packages/contracts/src/deploy/common/UpgradeableBeacon.ts:16
Functions
getContractURIs
▸ getContractURIs(«destructured»): Object
Parameters
| Name | Type |
|---|---|
«destructured» | Props |
Returns
Object
| Name | Type |
|---|---|
contractUri | string |
tokenUri | string |
Defined in
packages-public/packages/contracts/src/deploy/utils.ts:31
logDeployment
▸ logDeployment(networkName, contractName, address, deploymentType, status): void
Parameters
| Name | Type |
|---|---|
networkName | string |
contractName | string |
address | string |
deploymentType | "beacon" | "implementation" | "nicks" | "deterministic" | "proxy" | "beacon-proxy" | "example" |
status | "deployed" | "exists" | "failed" |
Returns
void
Defined in
packages-public/packages/contracts/src/deploy/utils.ts:10