types/app-factory
@algorandfoundation/algokit-utils / types/app-factory
Table of contents
Classes
Interfaces
Type Aliases
- AppFactoryAppClientParams
- AppFactoryCreateMethodCallParams
- AppFactoryCreateParams
- AppFactoryDeployParams
- AppFactoryResolveAppClientByCreatorAndNameParams
- CreateOnComplete
- CreateSchema
Type Aliases
AppFactoryAppClientParams
Ƭ AppFactoryAppClientParams: Expand<Omit<AppClientParams, "algorand" | "appSpec">>
Params to get an app client by ID from an app factory.
Defined in
AppFactoryCreateMethodCallParams
Ƭ AppFactoryCreateMethodCallParams: Expand<AppClientMethodCallParams & AppClientCompilationParams & CreateOnComplete & CreateSchema>
Params to specify a create method call for an app
Defined in
AppFactoryCreateParams
Ƭ AppFactoryCreateParams: Expand<AppClientBareCallParams & AppClientCompilationParams & CreateOnComplete & CreateSchema>
Params to specify a bare (raw) create call for an app
Defined in
AppFactoryDeployParams
Ƭ AppFactoryDeployParams: Expand<Omit<AppDeployParams, "createParams" | "updateParams" | "deleteParams" | "metadata"> & { appName?: string ; createParams?: Expand<AppClientMethodCallParams & CreateOnComplete & CreateSchema> | Expand<AppClientBareCallParams & CreateOnComplete & CreateSchema> ; deletable?: boolean ; deleteParams?: AppClientMethodCallParams | AppClientBareCallParams ; updatable?: boolean ; updateParams?: AppClientMethodCallParams | AppClientBareCallParams }>
Parameters to define a deployment for an AppFactory
Defined in
AppFactoryResolveAppClientByCreatorAndNameParams
Ƭ AppFactoryResolveAppClientByCreatorAndNameParams: Expand<Omit<ResolveAppClientByCreatorAndName, "algorand" | "appSpec">>
Params to get an app client by creator address and name from an app factory.
Defined in
CreateOnComplete
Ƭ CreateOnComplete: Object
onComplete parameter for a create app call
Type declaration
| Name | Type |
|---|---|
onComplete? | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC> |
Defined in
CreateSchema
Ƭ CreateSchema: Object
Specifies a schema used for creating an app
Type declaration
| Name | Type | Description |
|---|---|---|
extraProgramPages? | number | Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created. |
schema? | { globalByteSlices: number ; globalInts: number ; localByteSlices: number ; localInts: number } | The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. |
schema.globalByteSlices | number | The number of byte slices saved in global state. |
schema.globalInts | number | The number of integers saved in global state. |
schema.localByteSlices | number | The number of byte slices saved in local state. |
schema.localInts | number | The number of integers saved in local state. |