Skip to Content
Telchar docs released 🎉
Telchar CLICommands

Commands

Install

This command allows you to install the blueprint from a published DApp

Usage

telchar install <scope>/<name>

Example

telchar install txpipe/asteria

Codegen

This command allows you to obtain the boilerplate code to comunicate with a published DApp

Usage

telchar codegen <scope>/<name> <template>

Example

telchar codegen txpipe/asteria blaze

Returns

const AssetName = Data.Bytes(); const Int = Data.Integer(); const PolicyId = Data.Bytes(); const PosixTime = Data.Integer(); const ScriptAddress = Data.Bytes(); const AsteriaTypesAssetClass = Data.Object({ policy: PolicyId, name: AssetName, }); const AsteriaTypesAsteriaDatum = Data.Object({ ship_counter: Int, shipyard_policy: PolicyId, }); const AsteriaTypesAsteriaRedeemer = Data.Enum([ AsteriaTypesAsteriaRedeemerAddNewShip, AsteriaTypesAsteriaRedeemerMine, AsteriaTypesAsteriaRedeemerConsumeAsteria, ]); const AsteriaTypesAsteriaRedeemerAddNewShip = Data.Literal("AddNewShip"); const AsteriaTypesAsteriaRedeemerMine = Data.Literal("Mine"); const AsteriaTypesAsteriaRedeemerConsumeAsteria = Data.Literal("ConsumeAsteria"); const AsteriaTypesFuelRedeemer = Data.Enum([ AsteriaTypesFuelRedeemerMintFuel, AsteriaTypesFuelRedeemerBurnFuel, ]); const AsteriaTypesFuelRedeemerMintFuel = Data.Literal("MintFuel"); const AsteriaTypesFuelRedeemerBurnFuel = Data.Literal("BurnFuel"); const AsteriaTypesPelletDatum = Data.Object({ pos_x: Int, pos_y: Int, shipyard_policy: PolicyId, }); ...

Publish

This command allows you to publish your DApp to the registry.
It will take the plutus.json file and README.md file and prepare an OCI image with all the information.

Usage

telchar publish

The CLI will try to find the plutus.json file in the current directory. If the file is not found, the CLI will ask you for the path to the file.

Then CLI will try to find the README.md file in the current directory. If the file is not found, the CLI will ask you for the path to the file (optional - this step could be skipped).

After the CLI finds the plutus.json and README.md files, it will ask you to confirm the following data:

  • Scope: The scope of the DApp (default to what is in plutus.json).
  • Name: The name of the DApp (default to what is in plutus.json).
  • Repository URL: The URL of the repository. (optional)

Once this data is confirmed, the CLI will prepare the information and create the OCI image.
The image will be pushed to the registry and will be available throw Telchar Registry.