@sprillow-connor/holochain-client
v0.4.4
Published
A JavaScript client for the Holochain Conductor API
Downloads
3
Maintainers
Readme
Holochain Client - JavaScript
NOTE: this is a temporary fork of @holochain/client
.
A JavaScript client for the Holochain Conductor API (works with browsers as well as Nodejs).
Holochain's Conductor API is under active development. This client package tracks that development fairly closely but sometimes gets behind.
Installation
To install from NPM, run
npm install --save-exact @sprillow-connor/holochain-client
This code is still under alpha development and npm releases are pre-releases with
dev
tags meaning they will not use full semantic versioning, and you may wish to lock to an exact version of the library for that reason, as shown in the above command.
Sample usage
Use AdminWebsocket
const admin = await AdminWebsocket.connect(`ws://localhost:8000`, TIMEOUT)
await admin.generateAgentPubKey()
Use AppWebsocket
const signalCb = (signal: AppSignal) => {
// impl...
resolve()
}
const TIMEOUT = 12000
// default timeout is set to 12000
const client = await AppWebsocket.connect(`ws://localhost:${appPort}`, 12000, signalCb)
// default timeout set here (30000) will overwrite the defaultTimeout(12000) set above
await client.callZome({
cap: null,
cell_id,
zome_name: "test_zome",
fn_name: 'test_emitter_fn',
provenance: fakeAgentPubKey('TODO'),
payload: null,
}, 30000)
API Reference
See docs/API.md
Holochain Compatibility
See default.nix for the Holochain version this package is compatible with.
If updating the Holochain version included in holonix, please use niv update
as explained in the
Holochain Installation Guide.
Running tests
You need a version (stable
toolchain) of Rust available.
You need holochain
and hc
on your path, best to get them from nix with nix-shell
.
To perform the pre-requisite DNA compilation steps, and run the Nodejs test, run:
nix-shell
./run-test.sh
Contribute
Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contribution guidelines for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc.
- Connect with us on our forum
License
Copyright (C) 2020-2022, Holochain Foundation
This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.