https://github.com/lookyman/chronicle-api

Client library for interacting with https://github.com/paragonie/chronicle
https://github.com/lookyman/chronicle-api

api chronicle client paragonie php sapient

Last synced: 3 months ago
JSON representation

Client library for interacting with https://github.com/paragonie/chronicle

• Host: GitHub
• URL: https://github.com/lookyman/chronicle-api
• Owner: lookyman
• License: mit
• Created: 2017-07-12T19:49:46.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-25T13:01:03.000Z (about 7 years ago)
• Last Synced: 2024-04-24T03:14:18.188Z (10 months ago)
• Topics: api, chronicle, client, paragonie, php, sapient
• Language: PHP
• Homepage:
• Size: 53.7 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lookyman/Chronicle

Client library for interacting with [Chronicle](https://github.com/paragonie/chronicle).

[![Build Status](https://travis-ci.org/lookyman/chronicle-api.svg?branch=master)](https://travis-ci.org/lookyman/chronicle-api)

[![Coverage Status](https://coveralls.io/repos/github/lookyman/chronicle-api/badge.svg?branch=master)](https://coveralls.io/github/lookyman/chronicle-api?branch=master)

[![Downloads](https://img.shields.io/packagist/dt/lookyman/chronicle-api.svg)](https://packagist.org/packages/lookyman/chronicle-api)

[![Latest stable](https://img.shields.io/packagist/v/lookyman/chronicle-api.svg)](https://packagist.org/packages/lookyman/chronicle-api)

[![PHPStan level](https://img.shields.io/badge/PHPStan-7-brightgreen.svg)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/lookyman/chronicle-api/blob/master/LICENSE)

## Installation

```sh

composer require lookyman/chronicle-api

```

## Usage

```php

use Lookyman\Chronicle\Api;

use ParagonIE\ConstantTime\Base64UrlSafe;

use ParagonIE\Sapient\CryptographyKeys\SigningPublicKey;

use ParagonIE\Sapient\CryptographyKeys\SigningSecretKey;

$api = new Api(

	new Client(), // Client must implement Http\Client\HttpAsyncClient

	new RequestFactory(), // RequestFactory must implement Interop\Http\Factory\RequestFactoryInterface

	'https://chronicle.uri',

	new SigningPublicKey(Base64UrlSafe::decode('chronicle public key')) // optional, omit if you don't care about validating API responses

);

var_dump($api->lastHash()->wait());

// you must authenticate first before you can publish a message

$api->authenticate(

	new SigningSecretKey(Base64UrlSafe::decode('your secret key')),

	'your client id'

);

var_dump($api->publish('hello world')->wait());

```

For implementations of client and request factory, you can use for example [Guzzle 6 HTTP Adapter](https://github.com/php-http/guzzle6-adapter) and [HTTP Factory for Guzzle](https://github.com/http-interop/http-factory-guzzle) respectively.

All endpoints return `Http\Promise\Promise`, so you can either just `->wait()` for the response, or handle it asynchronously with `->then()`. Responses are just plain arrays, look up the structure in the Chronicle's documentation.