Crate leo_package

Expand description

This crate deals with Leo packages on the file system and network.

The main type is Package, which deals with Leo packages on the local filesystem. A Leo package directory is intended to have a structure like this: . ├── program.json ├── build │ ├── imports │ │ └── credits.aleo │ └── main.aleo ├── outputs │ ├── program.TypeChecking.ast │ └── program.TypeChecking.json ├── src │ └── main.leo └── tests └── test_something.leo

The file program.json is a manifest containing the program name, version, description, and license, together with information about its dependencies.

Such a directory structure, together with a .gitignore file, may be created on the file system using Package::initialize.

let path = Package::initialize("my_package", "path/to/parent").unwrap();

tests is where unit test files may be placed.

Given an existing directory with such a structure, a Package may be created from it with Package::from_directory:

use leo_package::Package;
let package = Package::from_directory("path/to/package", "/home/me/.aleo", false, false, Some(NetworkName::TestnetV0), Some("http://localhost:3030")).unwrap();

This will read the manifest and env file and keep their data in package.manifest and package.env. It will also process dependencies and store them in topological order in package.programs. This processing will involve fetching bytecode from the network for network dependencies. If the no_cache option (3rd parameter) is set to true, the package will not use the dependency cache. The endpoint and network are optional and are only needed if the package has network dependencies.

If you want to simply read the manifest and env file without processing dependencies, use Package::from_directory_no_graph.

Program generally doesn’t need to be created directly, as Package will create Programs for the main program and all dependencies. However, if you’d like to fetch bytecode for a program, you can use Program::fetch.

Modules§

dependency 🔒
location 🔒
manifest 🔒
package 🔒
program 🔒

Structs§

Dependency: Information about a dependency, as represented in the program.json manifest.
Manifest: Struct representation of program’s program.json specification.
Package: A Leo package.
Program: Information about an Aleo program.

Enums§

Location
ProgramData: Either the bytecode of an Aleo program (if it was a network dependency) or a path to its source (if it was local).

Constants§

BUILD_DIRECTORY
IMPORTS_DIRECTORY
MAIN_FILENAME
MANIFEST_FILENAME
MAX_PROGRAM_SIZE: Maximum allowed program size in bytes.
OUTPUTS_DIRECTORY
SOURCE_DIRECTORY
TESTS_DIRECTORY
TEST_PRIVATE_KEY

Functions§