activeledger/ecc

Activeledger minimal key generation and data signing SDK

1.0.0 2024-07-22 15:27 UTC

Requires (Dev)

• phpunit/phpunit: ^11.2

MIT

• Chris

README

Activeledger - PHP Key SDK

The Activeledger PHP Key SDK has been built to provide an easy way to generate an ECC keypair that can be used to sign transactions to be sent to the Activeledger network.

Activeledger

Visit Activeledger.io

Read Activeledgers documentation

Installation

$ composer require activeledger/ecc ~0.0.1
$ composer install -o

Usage

The SDK currently supports the following functions:

• Generate a new ECC keypair
• Sign a string using the generated private key

Generate a new ECC keypair

The generate method returns an array containing the public and private keys as HEX strings.

<?php
use Activeledger\ActiveECC;

class MyCoolClass
{
    public function generateKeyPair(): array
    {
        $ecc = new ActiveECC();
        $keyPair = $ecc->generate();

        // Alternatively call generate as a static method
        $keyPair = ActiveECC::generate();

        return $keyPair;
    }
}

Sign a string using a private key

The sign method takes two parameters: the private key as a HEX string, and the data to be signed also as a string.

<?php
use Activeledger\ActiveECC;

class MyCoolClass
{
    public function signString(string $privateKey, string $data)
    {
        $ecc = new ActiveECC();
        $signature = $ecc->sign($privateKey, $string);
        return $signature;
    }
}

License

This project is licensed under the MIT License