https://github.com/hadronous/pic-js

An Internet Computer Protocol canister testing library for TypeScript and JavaScript.
https://github.com/hadronous/pic-js

canister canisters icp integration-testing internet-computer internet-computer-protocol smart-contract smart-contracts testing testing-library testing-tools

Last synced: 5 days ago
JSON representation

An Internet Computer Protocol canister testing library for TypeScript and JavaScript.

• Host: GitHub
• URL: https://github.com/hadronous/pic-js
• Owner: hadronous
• License: apache-2.0
• Created: 2023-11-01T20:41:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-07T23:16:26.000Z (about 1 month ago)
• Last Synced: 2024-10-07T23:19:00.444Z (about 1 month ago)
• Topics: canister, canisters, icp, integration-testing, internet-computer, internet-computer-protocol, smart-contract, smart-contracts, testing, testing-library, testing-tools
• Language: TypeScript
• Homepage: https://hadronous.github.io/pic-js/
• Size: 126 MB
• Stars: 11
• Watchers: 1
• Forks: 5
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-internet-computer - pic-js - A TypeScript/JavaScript library for testing canisters with support for PocketIC. (Developer Tooling / Testing)

README

        
# Pic JS

[![NPM](https://badge.fury.io/js/@hadronous%2Fpic.svg)](https://badge.fury.io/js/@hadronous%2Fpic)

![Dependencies](https://img.shields.io/librariesio/release/npm/%40hadronous/pic)

[![Test (NodeJS)](https://github.com/hadronous/pic-js/actions/workflows/test-nodejs.yml/badge.svg)](https://github.com/hadronous/pic-js/actions/workflows/test-nodejs.yml)

[![Test (Bun)](https://github.com/hadronous/pic-js/actions/workflows/test-bun.yml/badge.svg)](https://github.com/hadronous/pic-js/actions/workflows/test-bun.yml)

[![Lint](https://github.com/hadronous/pic-js/actions/workflows/lint.yml/badge.svg)](https://github.com/hadronous/pic-js/actions/workflows/lint.yml)

[![CodeQL](https://github.com/hadronous/pic-js/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/hadronous/pic-js/actions/workflows/github-code-scanning/codeql)

Pic JS is a library for interacting with a local instance of `pocket-ic` from TypeScript.

The `pocket-ic` is a canister testing platform for the [Internet Computer](https://internetcomputer.org/). It is a standalone executable that can be used to test canisters locally, without the need to deploy them to a full replica.

Other languages available include [Python](https://github.com/dfinity/pocketic-py/) and [Rust](https://github.com/dfinity/ic/tree/master/packages/pocket-ic).

## API Docs

More detailed documentation is available in the [API docs](https://hadronous.github.io/pic-js/).

## Examples

Examples are available in the [examples](./examples/README.md) directory.

## Contributing

### Setup

- Install [bun](https://bun.sh/)

- Install [commitizen](https://commitizen-tools.github.io/commitizen/)

- Install [pre-commit](https://pre-commit.com/)

- Install dependencies:

  ```bash

  bun i

  ```