PHP download

Download the PHP package nimiq/utils without Composer

On this page you can find all versions of the php package nimiq/utils. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download nimiq/utils
More information about nimiq/utils
Files in nimiq/utils

Vendor nimiq
Package utils
Short Description PHP Utilities for Nimiq
License Apache-2.0
Homepage https://github.com/nimiq/php-utils

Keywords blockchain nimiq

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of nimiq/utils

Informations about the package utils

Nimiq PHP Utilities

This is a collection of utility classes for working with Nimiq primitives in PHP. It is not meant to enable a Nimiq network node in PHP, but rather to verify signatures, derive and validate addresses and to work with serialized primitives in a PHP environment. This collection is planned to grow over time when the need arises or by additions from the community.

Installation

The Nimiq PHP Utilities are availabe via the Packagist package registry and can be installed with Composer:

Please note that PHP >= 7.2 with an installed sodium extention is required to use these utilities. Please make sure that you have your operating system's equivalent of the php-sodium package installed or that you activate the sodium extension in your hosting's PHP settings.

Usage

The utility classes are available in the Nimiq\Utils namespace:

To generate byte-encoded strings from HEX representations, you can use sodium_hex2bin(), for example:

AddressUtils

Convert a public key into a Nimiq userfriendly address.

$public_key A byte-encoded string of length 32 representing a Nimiq public key.
$with_spaces [optional] Set to FALSE to output the address without spaces.

SignatureUtils

Verify a signature for the given data and public key.

$signature A byte-encoded string representing a Nimiq signature.
$data A byte-encoded string representing the data that the signature should be verified for.
$public_key A byte-encoded string representing the Nimiq public key of the signer.

Verify a message signature for the given message and public key.

Message signatures are different from regular signatures in that the message is prefixed and hashed before being signed. This method applies these same manipulations to the message before verifying the signature.

$signature A byte-encoded string representing a Nimiq message signature.
$message The plain-text representation of the message that the signature should be verified for.
$public_key A byte-encoded string representing the Nimiq public key of the signer.

RpcUtils

Generate a redirect URL with the parameters encoded in the URL fragment.

$targetURL The base URL to redirect to, including paths and query parameters (a fragment is discarded).
$id A numeric ID for the RPC request, must be >= 0.
$returnURL The URl to redirect back to, when the requests succeeds or fails.
$command The name of the function that should be called.
$args An array of function arguments to pass to the called function.
$responseMethod How to receive the response: 'message' (postMessage), 'url' (GET redirect), or 'post' (POST redirect)

Note: Binary strings are not yet supported in $args!

Development

The sodium cryptographic methods are best documented in the developer's documentation: https://paragonie.com/book/pecl-libsodium.

Setup

Use PHP >= 7.2
Install the sodium extension
Verify that you have the sodium extension correctly installed by running php test/version_check.php - if it displays the extension's version numbers, everything is good to go

Testing

To execute a (minimal) test of these utilities' functionality, run:

The expected output is:

All versions of utils with dependencies

PHP Build Version

Package Version

Version 0.1.0 Release 16. Jun 2019
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of utils from vendor nimiq

Requires php Version ^7.2
ext-sodium Version *
tuupola/base32 Version ^0.2.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nimiq/utils contains the following files

Loading the files please wait ...