Building Packages

A psibase package may be composed of one or more crates. It can be built by cargo psibase package or installed on a running chain with cargo psibase install.

cargo psibase reads the [package.metadata.psibase] section of Cargo.toml. At the minimum, package-name must be specified.

Available fields

In the top-level crate:

  • package-name: Required.
  • services: A list of services to include in the psibase package.

In any crate that builds a service:

  • server: The value is a crate which will handle HTTP requests sent to this service. The other crate will be built and included in the current package. If HTTP requests are handled in the base service, it should reference the service. Can be omitted if service serves no HTTP requests.
  • plugin: The value is a crate that should be built with cargo component and uploaded as /plugin.wasm
  • flags: Flags for the service.
  • data: An array of {src, dst} paths to upload to the service's subdomain. src is relative to the location of Cargo.toml. If src is a directory, its contents will be included recursively.

In top-level crate or any crate that builds a service:

  • postinstall: An array of actions to run when the package is installed. Actions from a single postinstall will be run in order. The order of actions from multiple crates is unspecified.
  • dependencies: Additional packages, not build by cargo, that the package depends on.

Example

./Cargo.toml

[package]
name = "example"
version = "0.1.0"
description = "An example package"

[package.metadata.psibase]
# (required) Builds example.psi (<package-name>.psi (case-sensitive))
package-name = "example"
# package includes `service1` service
services = ["service1"]

[package.metadata.psibase.dependencies]
HttpServer = "0.15.0"

./service/Cargo.toml

[package]
name = "service1"
version = "0.1.0"
description = "A service to be included in the package"

[package.metadata.psibase]
# Most services besides the core system services don't need extra flags.
flags = []
# This service handles its own HTTP requests
server = "service1"
# Plugin for the front end
plugin = "service1-plugin"
# Upload the UI
data = [{src = "../ui/dist", dst = "/"}]
# Run the service's init action; "0000" represents <no args> from the Fracpack perspective.
postinstall = [{sender="service1", service="service1", method="init", rawData="0000"}]