@orchestra-labs/symphonyjs v1.1.1

symphony-js

The npm repository for Symphony blockchain message structures.

Installation

To set up this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/Orchestra-Labs/symphonyjs.git

2. Navigate to the project directory:

   cd <project-directory>

3. Install dependencies with pnpm:

   pnpm install

Maintenance

Updating

Regularly update dependencies to keep the application secure and efficient:

pnpm upgrade

Codegen

Generate or regenerate TypeScript files from Protobuf definitions:

pnpm run codegen

Build

Compile the CommonJS and ESM outputs:

pnpm run build

Deployment

With the deployment structure in place, the only steps necessary are to update the version then push to github. The github workflow will take care of deployment to npm.

If manual deployment to npm is necessary, make sure your local .npmrc file is configured with the following line:

//registry.npmjs.org/:_authToken=your_auth_token_here

Updating patch version

Update the npm package with new patches (bug fixes):

pnpm run patch
git push

Update the npm package with new minor versions (backwards compatible changes):

pnpm run minor
git push

Update the npm package with new major versions (breaking changes):

pnpm run major
git push