@dedis/cothority NPM

Cothority client library in Javascript

This library offers methods to talk to a cothority node. At this point, it offers a socket interface that marshals and unmarshals automatically protobuf messages.

Usage

Import the library using

import Cothority from "@dedis/cothority"

Check out the example in index.html for a browser-based usage

Documentation

Execute npm run doc to generate the documentation and browse doc/index.html

Development

You need to have npm installed. Then

git clone https://github.com/dedis/cothority"
cd cothority/external/js/cothority
npm install

You should be able to run the tests with

npm run test

To run the tests, be sure to have docker installed and make docker executed from the root of this repo.

Protobuf generation

To add a new protobuf file to the library, simply place your *.proto file somewhere in lib/protobuf/build/models and then run

npm run protobuf

That would compile all protobuf definitions into a single JSON file (models.json). This json file is then embedded in the library automatically.

Publishing

You must use the given script instead of npm publish because we need to publish the dist folder instead. If you try to use the official command, you will get an error on purpose.

Message classes

You can write a class that will be used when decoding protobuf messages by using this template:

class MyMessage extends Message<MyMessage> {
    /**
     * @see README#Message classes
     */
    static register() {
        registerMessage("abc.MyMessage", MyMessage, MyMessageDependency);
    }

    readonly myField: MyMessageDependency;

    constructor(props?: Properties<MyMessage>) {
        super(props);

        // whatever you need to do for initialization
    }
}

MyMessage.register();

Note that protobuf will instantiate with an empty object and then fill the fields so this happens after the constructor has been called. The register is used to register the dependencies of the message but you also have to use it as a side effect of the package so that as soon as the class is imported, the message will be known by protobuf and used during decoding.

Side note on Buffer

Protobuf definition and classes implemented expect a Buffer for bytes but as you should know, in a browser environment bytes are instantiated with Uint8Array. You should then be aware that the actual type will be Uint8Array when using the library in a browser environment but the buffer interface will be provided thanks to the buffer package.

As this is a polyfill, please check that what you need is implemented or you will need to use a different approach. Of course for NodeJS, you will always get a Buffer.

Use a development version from an external app

Steps to use js/cothority as a local module for a local external app:

1) Build a version

(cothority/external/js/cothority) $ npm run build

2) Create a link

(cothority/external/js/cothority) $ npm run link

3) From the root folder of the external app, link the new package

(external_app) $ npm link @dedis/cothority

4) To unlink

(external_app) $ npm unlink @dedis/cothority
(cothority/external/js/cothority) $ npm unlink

cothority network

@infinitebrahmanuniverse/nolb-_ded @everything-registry/sub-chunk-230 @zalastax/nolb-_ded @c4dt/drynx @c4dt/dynacred artillery-engine-cothority

3.6.8-p2206.1407.1025.0

2 years ago

3.6.8-p2206.2812.1646.0

2 years ago

3.6.8-p2206.2914.3532.0

2 years ago

3.6.8-p2206.706.1228.0

2 years ago

3.6.7

2 years ago

3.6.7-p2206.208.2147.0

2 years ago

3.6.7-p2203.1714.2538.0

2 years ago

3.6.6

2 years ago

3.6.6-p2203.415.4219.0

2 years ago

3.6.6-p2202.2515.3326.0

2 years ago

3.6.6-p2203.409.4946.0

2 years ago

3.6.6-p2112.1015.5934.0

2 years ago

3.6.6-p2112.712.4257.0

2 years ago

3.6.6-p2112.1015.5808.0

2 years ago

3.6.6-p2202.1316.4608.0

2 years ago

3.6.6-p2112.916.3244.0

2 years ago

3.6.6-p2112.1609.5431.0

2 years ago

3.6.6-p2111.2514.2754.0

2 years ago

3.6.6-p2111.2313.5020.0

2 years ago

3.6.6-p2111.1812.3047.0

2 years ago

3.6.5

2 years ago

3.6.6-p2111.1515.5142.0

2 years ago

3.6.5-p2111.808.751.0

2 years ago

3.6.6-p2111.2007.4021.0

2 years ago

3.6.5-p2108.309.4843.0

3 years ago

3.6.5-p2106.814.736.0

3 years ago

3.6.5-p2104.2711.3659.0

3 years ago

3.6.5-p2104.3014.1438.0

3 years ago

3.6.5-p2104.2806.1010.0

3 years ago

3.6.5-p2104.1913.1631.0

3 years ago

3.6.5-p2104.2011.4902.0

3 years ago

3.6.5-p2104.3011.3650.0

3 years ago

3.6.5-p2104.1511.5838.0

3 years ago

3.6.5-p2104.1511.5530.0

3 years ago

3.6.5-p2104.105.4827.0

3 years ago

3.6.5-p2103.3014.5308.0

3 years ago

3.6.5-p2103.2611.139.0

3 years ago

3.6.4

3 years ago

3.6.4-p2103.1609.5311.0

3 years ago

3.6.4-p2103.1211.850.0

3 years ago

3.6.4-p2103.1211.616.0

3 years ago

3.6.4-p2103.111.3558.0

3 years ago

3.6.4-p2102.2507.3732.0

3 years ago

3.6.4-p2012.1814.1317.0

3 years ago

3.6.4-p2012.1814.730.0

3 years ago

3.6.4-p2012.1807.4411.0

3 years ago

3.6.4-p2012.1409.5058.0

3 years ago

3.6.4-p2012.1017.5225.0

3 years ago

3.6.4-p2012.1010.2124.0

3 years ago

3.6.4-p2012.910.3150.0

3 years ago

3.6.4-p2012.412.3952.0

3 years ago

3.6.4-p2012.313.951.0

3 years ago

3.6.4-p2012.216.1648.0

3 years ago

3.6.4-p2012.109.4652.0

3 years ago

3.6.3-p2011.3017.5847.0

3 years ago

3.6.4-p2011.2616.1001.0

3 years ago

3.6.3

3 years ago

3.6.3-p2011.2308.3834.0

3 years ago

3.6.3-p2011.2007.5453.0

3 years ago

3.6.3-p2011.1915.3700.0

3 years ago

3.6.3-p2011.1912.5442.0

3 years ago

3.6.3-p2011.1818.5115.0

3 years ago

3.6.3-p2011.1717.5026.0

3 years ago

3.6.3-p2011.509.2831.0

4 years ago

3.6.2

4 years ago

3.6.2-p2011.509.2311.0

4 years ago

3.6.2-p2010.2712.1125.0

4 years ago

3.6.1

4 years ago

3.6.1-p2010.2214.4047.0

4 years ago

3.5.6-p2010.1915.2504.0

4 years ago

3.5.6-p2010.1915.3652.0

4 years ago

3.5.5

4 years ago

3.5.6-p2010.1511.528.0

4 years ago

3.5.5-p2010.809.129.0

4 years ago

3.5.5-p2010.610.211.0

4 years ago

3.5.5-p2010.515.5935.0

4 years ago

3.5.5-p2010.509.4658.0

4 years ago

3.5.5-p2010.509.1241.0

4 years ago

3.5.5-p2009.3009.1553.0

4 years ago

3.5.5-p2009.2811.2407.0

4 years ago

3.5.4

4 years ago

3.5.4-p2009.2415.3933.0

4 years ago

3.5.3-p2009.209.842.0

4 years ago

3.5.3-p2008.2511.5304.0

4 years ago

3.5.3-p2008.2511.1746.0

4 years ago

3.5.3-p2008.2509.4756.0

4 years ago

3.5.3-p2008.2415.3145.0

4 years ago

3.5.3-p2008.2116.836.0

4 years ago

3.5.3-p2008.2010.5242.0

4 years ago

3.5.2

4 years ago

3.5.3-p2008.2016.4000.0

4 years ago

3.5.3-p2008.1914.5208.0

4 years ago

3.5.3-p2008.1913.1009.0

4 years ago

3.5.2-p2008.1909.1720.0

4 years ago

3.5.2-p2008.1908.556.0

4 years ago

3.5.2-p2008.1814.440.0

4 years ago

3.5.2-p2008.1715.4753.0

4 years ago

3.5.2-p2008.1709.5925.0

4 years ago

3.5.1

4 years ago

3.5.2-p2008.708.5101.0

4 years ago

3.5.1-p2008.515.358.0

4 years ago

3.5.1-p2007.2906.4454.0

4 years ago

3.5.1-p2007.2914.5335.0

4 years ago

3.5.1-p2007.2813.542.0

4 years ago

3.5.0

4 years ago

3.4.8-p2007.2410.903.0

4 years ago

3.4.8-p2007.2416.4442.0

4 years ago

3.4.8-p2007.2315.2138.0

4 years ago

3.4.8-p2007.2309.320.0

4 years ago

3.4.8-p2007.2308.5951.0

4 years ago

3.4.8-p2007.2210.1351.0

4 years ago

3.4.8-p2007.2104.5911.0

4 years ago

3.4.8-p2007.2014.3101.0

4 years ago

3.4.8-p2007.1705.5543.0

4 years ago

3.4.8-p2007.1715.2536.0

4 years ago

3.4.8-p2007.1614.2748.0

4 years ago

3.4.8-p2007.1415.1854.0

4 years ago

3.4.8-p2007.1314.4615.0

4 years ago

3.4.8-p2007.1014.5518.0

4 years ago

3.4.8-p2007.311.3524.0

4 years ago

3.4.8-p2007.306.2856.0

4 years ago

3.4.8-p2007.210.4341.0

4 years ago

3.4.8-p2006.2516.213.0

4 years ago

3.4.8-p2006.1710.2144.0

4 years ago

3.4.8-p2006.1612.3349.0

4 years ago

3.4.8-p2006.1508.3033.0

4 years ago

3.4.8-p2006.1508.3310.0

4 years ago

3.4.7

4 years ago

3.4.8-p2006.1213.5245.0

4 years ago

3.4.8-p2006.1108.2549.0

4 years ago

3.4.7-p2006.1005.4246.0

4 years ago

3.4.7-p2006.1013.919.0

4 years ago

3.4.6

4 years ago

3.4.7-p2006.812.2140.0

4 years ago

3.4.7-p2006.509.1145.0

4 years ago

3.4.6-p2006.410.2725.0

4 years ago

3.4.6-p2006.409.225.0

4 years ago

3.4.6-p2006.409.1115.0

4 years ago

3.4.6-p2006.318.4050.0

4 years ago

3.4.6-p2006.312.5653.0

4 years ago

3.4.6-p2005.2910.4828.0

4 years ago

3.4.5-p2005.2906.4521.0

4 years ago

3.4.5-p2005.2612.1609.0

4 years ago

3.4.5-p2005.2513.2504.0

4 years ago

3.4.5-p2005.2511.1815.0

4 years ago

3.4.5-p2005.2514.3916.0

4 years ago

3.4.5-p2005.2514.4058.0

4 years ago

3.4.5-p2005.2509.1207.0

4 years ago

3.4.5-p2005.2210.1948.0

4 years ago

3.4.5-p2005.2013.2302.0

4 years ago

3.4.5-p2005.1813.556.0

4 years ago

3.4.5-p2005.1816.110.0

4 years ago

3.4.5-p2005.1509.4955.0

4 years ago

3.4.5-p2005.1315.5542.0

4 years ago

3.4.5-p2005.1108.2658.0

4 years ago

3.4.5-p2005.816.4711.0

4 years ago

3.4.5-p2005.815.4112.0

4 years ago

3.4.5-p2004.2214.4130.0

4 years ago

3.4.5-p2004.2114.4238.0

4 years ago

3.4.5-p2003.3111.1539.0

4 years ago

3.4.5-p2003.3109.1438.0

4 years ago

3.4.5-p2003.3109.754.0

4 years ago

3.4.5-p2003.2709.5624.0

4 years ago

3.4.5-p2003.2519.2457.0

4 years ago

3.4.5-p2003.1816.3454.0

4 years ago

3.4.5-p2003.1617.3144.0

4 years ago

3.4.5-p2003.1106.3318.0

4 years ago

3.4.5-p2003.1106.3249.0

4 years ago

3.4.5-p2003.312.1448.0

4 years ago

3.4.5-p2003.315.2722.0

4 years ago

3.4.5-p2002.2716.2746.0

4 years ago

3.4.4-p2002.2709.1938.0

4 years ago

3.4.4-p2002.2613.2216.0

4 years ago

3.4.4-p2002.2611.548.0

4 years ago

3.4.4

4 years ago

3.4.4-p2002.2609.2959.0

4 years ago

3.4.4-p2002.2513.2307.0

4 years ago

3.4.4-p2002.2413.1900.0

4 years ago

3.4.4-p2002.2112.1636.0

4 years ago

3.4.4-p2002.2111.2005.0

4 years ago

3.4.4-p2002.1417.808.0

4 years ago

3.4.4-p2002.1208.2011.0

4 years ago

3.4.4-p2002.607.5016.0

4 years ago

3.4.4-p2002.507.4839.0

4 years ago

3.4.4-p2002.408.5038.0

4 years ago

3.4.4-p2001.3110.2705.0

4 years ago

3.4.4-p2001.2414.4559.0

4 years ago

3.4.3

4 years ago

3.4.3-p2001.2414.1655.0

4 years ago

3.4.3-p2001.2409.3538.0

4 years ago

3.4.3-p2001.1716.2952.0

4 years ago

3.4.3-p2001.1714.5310.0

4 years ago

3.4.3-p2001.915.443.0

4 years ago

3.4.3-p2001.808.4924.0

4 years ago

3.4.3-p2001.812.4844.0

4 years ago

3.4.3-p2001.607.5919.0

4 years ago

3.4.3-p1912.2016.2029.0

4 years ago

3.4.3-p1912.2015.4128.0

4 years ago

3.4.3-p1912.1216.3440.0

4 years ago

3.4.2-p1912.1210.2817.0

4 years ago

3.4.2

4 years ago

3.4.2-p1912.1210.353.0

4 years ago

3.4.2-p1912.1209.5556.0

4 years ago

3.4.2-p1912.915.4838.0

4 years ago

3.4.2-p1912.915.2410.0

4 years ago

3.4.2-p1912.914.5634.0

4 years ago

3.4.2-p1912.516.3201.0

4 years ago

3.4.2-p1911.2913.5438.0

4 years ago

3.4.1

4 years ago

3.4.2-p1911.2907.3711.0

4 years ago

3.4.1-p1911.2716.629.0

4 years ago

3.4.0

4 years ago

3.1.11

4 years ago

3.1.10

4 years ago

3.1.8-p1911.815.4351.0

4 years ago

3.1.8-p1911.814.1548.0

4 years ago

3.1.8-p1911.417.4314.0

5 years ago

3.1.9

5 years ago

3.1.8

5 years ago

3.1.8-p1910.3012.3304.0

5 years ago

3.1.8-p1910.3009.4354.0

5 years ago

3.1.8-p1910.3009.4127.0

5 years ago

3.1.8-p1910.3008.5646.0

5 years ago

3.1.8-p1910.2916.3359.0

5 years ago

3.1.8-p1910.2915.739.0

5 years ago

3.1.8-p1910.2907.1718.0

5 years ago

3.1.8-p1910.2907.1521.0

5 years ago

3.1.8-p1910.2811.1022.0

5 years ago

3.1.8-p1910.2514.5218.0

5 years ago

3.1.8-p1910.2408.2636.0

5 years ago

3.1.8-p1910.2308.5425.0

5 years ago

3.1.8-p1910.2307.2406.0

5 years ago

3.1.8-p1910.2208.2632.0

5 years ago

3.1.8-p1910.1607.3231.0

5 years ago

3.1.8-p1910.1416.742.0

5 years ago

3.1.8-p1910.1413.1135.0

5 years ago

3.1.8-p1910.1119.2026.0

5 years ago

3.1.8-p1910.1119.137.0

5 years ago

3.1.8-p1910.1110.853.0

5 years ago

3.1.8-p1910.1108.1526.0

5 years ago

3.1.8-p1910.914.5025.0

5 years ago

3.1.8-p1910.909.1217.0

5 years ago

3.1.7

5 years ago

3.1.7-p1910.822.3923.0

5 years ago

3.1.7-p1910.810.655.0

5 years ago

3.1.7-p1910.416.3818.0

5 years ago

3.1.7-p1910.416.1930.0

5 years ago

3.1.7-p1910.416.1623.0

5 years ago

3.1.7-p1910.413.4917.0

5 years ago

3.1.7-p1910.211.4834.0

5 years ago

3.1.7-p1909.3013.4610.0

5 years ago

3.1.7-p1909.3013.836.0

5 years ago

3.1.7-p1909.2711.359.0

5 years ago

3.1.7-p1909.2710.4839.0

5 years ago

3.1.7-p1909.2709.5851.0

5 years ago

3.1.6-p1909.2410.4743.0

5 years ago

3.1.6-p1909.2315.935.0

5 years ago

3.1.6-p1909.2312.4849.0

5 years ago

3.1.6-p1909.2308.2852.0

5 years ago

3.1.6-p1909.2010.1332.0

5 years ago

3.1.6-p1909.1207.3126.0

5 years ago

3.1.6-p1909.1023.1332.0

5 years ago

3.1.6-p1909.1022.546.0

5 years ago

3.1.6-p1909.1021.5453.0

5 years ago

3.1.6-p1909.1016.702.0

5 years ago

3.1.6-p1909.513.4056.0

5 years ago

3.1.6-p1909.307.4804.0

5 years ago

3.1.5-p1909.307.1954.0

5 years ago

3.1.5

5 years ago

3.1.5-p1909.209.1106.0

5 years ago

3.1.5-p1908.3014.5139.0

5 years ago

3.1.5-pretest.0

5 years ago

3.1.5-p20190828092906.0

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago