README

info@wishknish.com | https://wishknish.com

Knish.IO PHP Client SDK

This is the official PHP implementation of the Knish.IO client SDK. Its purpose is to expose class libraries for building and signing Knish.IO Molecules, composing Atoms, generating Wallets, and much more.

Installation

The SDK can be installed via Composer:

composer require wishknish/knishio-client-php

Requirements:

PHP 8.2 or higher
Required extensions: ext-json, ext-sodium, ext-mbstring
Composer for dependency management

After installation, include the autoloader in your project:

<?php
require_once 'vendor/autoload.php';

use WishKnish\KnishIO\Client\KnishIOClient;
use WishKnish\KnishIO\Client\Libraries\Crypto;
use WishKnish\KnishIO\Client\Wallet;

Basic Usage

The purpose of the Knish.IO SDK is to expose various ledger functions to new or existing applications.

There are two ways to take advantage of these functions:

The easy way: use the KnishIOClient wrapper class
The granular way: build Atom and Molecule instances and broadcast GraphQL messages yourself

This document will explain both ways.

The Easy Way: KnishIOClient Wrapper

Include the wrapper class in your application code:

<?php
use WishKnish\KnishIO\Client\KnishIOClient;

Instantiate the class with your node URI:

$client = new KnishIOClient('http://localhost:8000/graphql');
$client->setCellSlug('my-cell-slug');

Request authorization token from the node:

$response = $client->requestAuthToken($secret);

if ($response->success()) {
    // Authentication successful
    $authToken = $client->getAuthToken();
    echo "Authenticated successfully!\n";
} else {
    throw new Exception('Authentication failed: ' . $response->reason());
}

(Note: The $secret parameter can be a salted combination of username + password, a biometric hash, an existing user identifier from an external authentication process, for example)

Begin using $client to trigger commands described below...

KnishIOClient Methods

Query metadata for a Wallet Bundle. Omit the $bundleHash parameter to query your own Wallet Bundle:

$response = $client->queryBundle('c47e20f99df190e418f0cc5ddfa2791e9ccc4eb297cfa21bd317dc0f98313b1d');

if ($response->success()) {
    $bundleData = $response->data();
    print_r($bundleData); // Raw Metadata
}

Query metadata for a Meta Asset:

$result = $client->queryMeta(
    metaType: 'Vehicle',
    metaId: null, // Meta ID
    key: 'LicensePlate',
    value: '1H17P',
    latest: true, // Limit meta values to latest per key
    throughAtom: true // Optional, query through Atom (default: true)
);

print_r($result); // Raw Metadata

Writing new metadata for a Meta Asset:

$response = $client->createMeta(
    metaType: 'Pokemon',
    metaId: 'Charizard',
    metadata: [
        'type' => 'fire',
        'weaknesses' => [
            'rock',
            'water',
            'electric'
        ],
        'immunities' => [
            'ground',
        ],
        'hp' => 78,
        'attack' => 84,
    ]
);

if ($response->success()) {
    // Do things!
    echo "Metadata created successfully!\n";
}

print_r($response->data()); // Raw response

Query Wallets associated with a Wallet Bundle:

$wallets = $client->queryWallets(
    bundleHash: 'c47e20f99df190e418f0cc5ddfa2791e9ccc4eb297cfa21bd317dc0f98313b1d',
    tokenSlug: 'FOO' // Optional, filter by token
);

print_r($wallets); // Raw response

Declaring new Wallets:

(Note: If Tokens are sent to undeclared Wallets, Shadow Wallets will be used (placeholder Wallets that can receive, but cannot send) to store tokens until they are claimed.)

$response = $client->createWallet('FOO'); // Token Slug for the wallet we are declaring

if ($response->success()) {
    // Do things!
    echo "Wallet created successfully!\n";
}

print_r($response->data()); // Raw response

Issuing new Tokens:

$response = $client->createToken(
    tokenSlug: 'CRZY', // Token slug (ticker symbol)
    amount: 100000000, // Initial amount to issue
    meta: [
        'name' => 'CrazyCoin', // Public name for the token
        'fungibility' => 'fungible', // Fungibility style (fungible / nonfungible / stackable)
        'supply' => 'limited', // Supply style (limited / replenishable)
        'decimals' => 2 // Decimal places
    ],
    units: [], // Optional, for stackable tokens
    batchId: null // Optional, for stackable tokens
);

if ($response->success()) {
    // Do things!
    echo "Token created successfully!\n";
}

print_r($response->data()); // Raw response

Transferring Tokens to other users:

$response = $client->transferToken(
    bundleHash: '7bf38257401eb3b0f20cabf5e6cf3f14c76760386473b220d95fa1c38642b61d', // Recipient's bundle hash
    tokenSlug: 'CRZY', // Token slug
    amount: 100,
    units: [], // Optional, for stackable tokens
    batchId: null // Optional, for stackable tokens
);

if ($response->success()) {
    // Do things!
    echo "Token transferred successfully!\n";
}

print_r($response->data()); // Raw response

Creating a new Rule:

$response = $client->createRule(
    metaType: 'MyMetaType',
    metaId: 'MyMetaId',
    rule: [
        // Rule definition
    ],
    policy: [] // Optional policy object
);

if ($response->success()) {
    // Do things!
    echo "Rule created successfully!\n";
}

print_r($response->data()); // Raw response

Querying Atoms:

$response = $client->queryAtom([
    'molecularHash' => 'hash',
    'bundleHash' => 'bundle',
    'isotope' => 'V',
    'tokenSlug' => 'CRZY',
    'latest' => true,
    'limit' => 15,
    'offset' => 1
]);

print_r($response->data()); // Raw response

Working with Buffer Tokens:

// Deposit to buffer
$depositResponse = $client->depositBufferToken(
    tokenSlug: 'CRZY',
    amount: 100,
    tradeRates: [
        'OTHER_TOKEN' => 0.5
    ]
);

// Withdraw from buffer
$withdrawResponse = $client->withdrawBufferToken(
    tokenSlug: 'CRZY',
    amount: 50
);

print_r([$depositResponse->data(), $withdrawResponse->data()]); // Raw responses

Getting client fingerprint:

$fingerprint = $client->getFingerprint();
echo $fingerprint . "\n";

$fingerprintData = $client->getFingerprintData();
print_r($fingerprintData);

Advanced Usage: Working with Molecules

For more granular control, you can work directly with Molecules:

Create a new Molecule:

use WishKnish\KnishIO\Client\Molecule;

$molecule = new Molecule($secret, $sourceWallet, $remainderWallet, $cellSlug);

Create a custom Mutation:

use WishKnish\KnishIO\Client\Mutation\MutationProposeMolecule;

$mutation = new MutationProposeMolecule($client, $molecule);

Sign and check a Molecule:

$molecule->sign();
try {
    $molecule->check();
    echo "Molecule validation passed!\n";
} catch (\Exception $e) {
    echo "Molecule validation failed: " . $e->getMessage() . "\n";
}

Execute a custom Query or Mutation:

$response = $client->executeQuery($mutation);

if ($response->success()) {
    echo "Molecule executed successfully!\n";
}

The Hard Way: DIY Everything

This method involves individually building Atoms and Molecules, triggering the signature and validation processes, and communicating the resulting signed Molecule mutation or Query to a Knish.IO node via GraphQL.

Include the relevant classes in your application code:

<?php
use WishKnish\KnishIO\Client\{Molecule, Wallet, Atom};
use WishKnish\KnishIO\Client\Libraries\Crypto;

Generate a 2048-symbol hexadecimal secret, either randomly, or via hashing login + password + salt, OAuth secret ID, biometric ID, or any other static value.
(optional) Initialize a signing wallet with:
```
$wallet = new Wallet(
    secret: $secret,
    token: $tokenSlug,
    position: $customPosition, // (optional) instantiate specific wallet instance vs. random
    characters: $characterSet // (optional) override the character set used by the wallet
);
```
WARNING 1: If ContinuID is enabled on the node, you will need to use a specific wallet, and therefore will first need to query the node to retrieve the position for that wallet.

WARNING 2: The Knish.IO protocol mandates that all C and M transactions be signed with a USER token wallet.

Build your molecule with:

$molecule = new Molecule(
    secret: $secret,
    sourceWallet: $sourceWallet, // (optional) wallet for signing
    remainderWallet: $remainderWallet, // (optional) wallet to receive remainder tokens
    cellSlug: $cellSlug // (optional) used to point a transaction to a specific branch of the ledger
);

Either use one of the shortcut methods provided by the Molecule class (which will build Atom instances for you), or create Atom instances yourself.

DIY example:

// This example records a new Wallet on the ledger

// Define metadata for our new wallet
$newWalletMeta = [
    'address' => $newWallet->address,
    'token' => $newWallet->token,
    'bundle' => $newWallet->bundle,
    'position' => $newWallet->position,
    'batchId' => $newWallet->batchId,
];

// Build the C isotope atom
$walletCreationAtom = new Atom(
    position: $sourceWallet->position,
    walletAddress: $sourceWallet->address,
    isotope: 'C',
    token: $sourceWallet->token,
    metaType: 'wallet',
    metaId: $newWallet->address,
    meta: $newWalletMeta,
    index: $molecule->generateIndex()
);

// Add the atom to our molecule
$molecule->addAtom($walletCreationAtom);

// Adding a ContinuID / remainder atom
$molecule->addContinuIdAtom();

Molecule shortcut method example:

// This example commits metadata to some Meta Asset

// Defining our metadata
$metadata = [
    'foo' => 'Foo',
    'bar' => 'Bar'
];

$molecule->initMeta(
    meta: $metadata,
    metaType: 'MyMetaType',
    metaId: 'MetaId123'
);

Sign the molecule with the stored user secret:
```
$molecule->sign();
```

Make sure everything checks out by verifying the molecule:

try {
    $molecule->check();
    // If we're validating a V isotope transaction,
    // add the source wallet as a parameter
    $molecule->check($sourceWallet);
    echo "Molecule validation passed!\n";
} catch (\Exception $e) {
    echo "Molecule check failed: " . $e->getMessage() . "\n";
    // Handle the error
}

Broadcast the molecule to a Knish.IO node:

use WishKnish\KnishIO\Client\Mutation\MutationProposeMolecule;

// Build our mutation object using the KnishIOClient wrapper
$mutation = new MutationProposeMolecule($client, $molecule);

// Send the mutation to the node and get a response
$response = $client->executeQuery($mutation);

Inspect the response...
```
// For basic queries, we look at the data property:
print_r($response->data());

// For mutations, check if the molecule was accepted by the ledger:
echo $response->success() ? "Success" : "Failed";

// We can also check the reason for rejection
echo $response->reason();

// Some queries may also produce a payload, with additional data:
print_r($response->payload());
```
Payloads are provided by responses to the following queries:
1. QueryBalance and QueryContinuId -> returns a Wallet instance
2. QueryWalletList -> returns a list of Wallet instances
3. MutationProposeMolecule, MutationRequestAuthorization, MutationCreateIdentifier, MutationLinkIdentifier, MutationClaimShadowWallet, MutationCreateToken, MutationRequestTokens, and MutationTransferTokens -> returns molecule metadata

Getting Help

Knish.IO is under active development, and our team is ready to assist with integration questions. The best way to seek help is to stop by our Telegram Support Channel. You can also send us a contact request via our website.

wishknish / knishio-client-php

Maintainers

Package info

Statistics

Security