Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kinecosystem/kin-node
DEPRECATED! Please use Kinetic: https://developer.kin.org/docs/kinetic
https://github.com/kinecosystem/kin-node
Last synced: about 2 months ago
JSON representation
DEPRECATED! Please use Kinetic: https://developer.kin.org/docs/kinetic
- Host: GitHub
- URL: https://github.com/kinecosystem/kin-node
- Owner: kinecosystem
- License: mit
- Archived: true
- Created: 2020-08-17T17:20:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-21T19:00:25.000Z (almost 2 years ago)
- Last Synced: 2024-05-27T22:51:10.335Z (4 months ago)
- Language: TypeScript
- Homepage: https://developer.kin.org/docs/kinetic
- Size: 563 KB
- Stars: 16
- Watchers: 6
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Deprecation Warning
Kins's Agora powered SDKs have been deprecated and Agora replaced with Kinetic.
## Kinetic
Kinetic is an open-source suite of tools that make it easy to build apps that integrate Solana.
It provides a consistent and clean abstraction over the Solana SDKs and enhances it with some commonly requested features like paying Solana fees on behalf of the user, tracking and timing the users transactions and sending out webhooks.
Kinetic is aimed at developers that want to build crypto-experiences for the users of their app, hiding a lot of the details about the blockchain out of sight for both the developer and the end user.
Learn more about Kinetic [here](https://developer.kin.org/docs/kinetic).
See our new suite of Kinetic SDK's [here](https://developer.kin.org/docs/developers).
# Kin Node SDK
The Kin Node SDK enables developers use Kin inside their backend servers. It contains support for blockchain actions
such as creating accounts and sending payments, as well a webhook handler class to assist with implementing Agora webhooks. It is recommended that developers read the [website documentation](https://docs.kin.org) prior to using this SDK.
## Requirements
* Node supporting ES2015 or higher
## Installation
```
npm install @kinecosystem/kin-sdk-v2
```
```
yarn add @kinecosystem/kin-sdk-v2
```
Note: `stellar-base` uses `tweetnacl` and `sodium-native` as dependencies. If `sodium-native` cannot be built,
or is absent, `stellar-base` falls back to the slower `tweetnacl`. There are certain cases where `sodium-native`
may have issues. Notably:
1. Browser environments
2. Serverless functions with tight package sizing. For example, AWS Lambda has a 50 MiB limit, and `sodium-native`
takes up a majority of this space. Developers may wish to delete the `sodium_native` directory in `node_modules/`
to save space.
## Overview
The SDK contains two main components: the `Client` and webhook handlers. The `Client` is used for blockchain
actions, such as creating accounts sending payments, while the web hook handlers are meant for developers who wish to make
use of Agora Webhooks. For a high-level overview of using Agora, please refer to the [website documentation](https://docs.kin.org).
## Client
The main component of this library is the `Client` class, which facilitates access to the Kin blockchain.
### Initialization
At a minimum, the client needs to be instantiated with an `Environment`.
```typescript
import {Client, Environment} from "@kinecosystem/kin-sdk-v2";
const client = new Client(Environment.Test);
```
Apps with [registered](https://docs.kin.org/app-registration) app indexes should initialize the client with their index:
```typescript
import {Client, Environment} from "@kinecosystem/kin-sdk-v2";
const client = new Client(Environment.Test, {
appIndex: 1
});
```
Additional options include:
- `endpoint`: (optional) A specific endpoint to use in the client. This will be inferred by default from the Environment. Cannot be set if `internal` is set.
- `internal`: (optional) An `agora.client.InternalClient` instance to use in the client. This will created using default values if not included. Cannot be set if `endpoint` is set.
- `retryConfig`: A custom `agora.client.RetryConfig` to configure how the client retries requests.
- `defaultCommitment`: (Kin 4 only) The commitment requirement to use by default for Kin 4 Agora requests. See the [website documentation](https://docs.kin.org/solana#commitment) for more information.
### Usage
#### Create an Account
The `createAccount` method creates an account with the provided private key.
```typescript
const privateKey = PrivateKey.random();
await client.createAccount(privateKey);
```
In addition to the mandatory `key` parameter, `createAccount` has the following optional parameters:
- `commitment`: Indicates to Solana which bank state to query. See the [website documentation](https://docs.kin.org/solana#commitment) for more details.
- `subsidizer`: The private key of an account to use as the funder of the transaction instead of the subsidizer configured on Agora.
#### Get a Transaction
The `getTransaction` method gets transaction data by transaction id.
```typescript
// txId is either a 32-byte Stellar transaction hash or a 64-byte Solana transaction signature
const txId = bs58.decode(''); // solana transaction signature
const transactionData = await client.getTransaction(txId);
```
In addition to the mandatory `txId` parameter, `getTransaction` has the following optional parameters:
- `commitment`: Indicates to Solana which bank state to query. See the [website documentation](https://docs.kin.org/solana#commitment) for more details.
#### Get an Account Balance
The `getBalance` method gets the balance of the provided account, in [quarks](https://docs.kin.org/terms-and-concepts#quark)
```typescript
const publicKey = PublicKey.fromString("");
const balance = await client.getBalance(publicKey);
```
In addition to the mandatory `account` parameter, `getBalance` has the following optional parameters:
- `commitment`: Indicates to Solana which bank state to query. See the [website documentation](https://docs.kin.org/solana#commitment) for more details.
- `accountResolution`: Indicates which type of account resolution to use if the account is not found.
#### Submit a Payment
The `submitPayment` method submits the provided payment to Agora.
```typescript
const sender: PrivateKey;
const dest: PublicKey;
let txId = await client.submitPayment({
sender: sender,
destination: dest,
type: TransactionType.Earn,
quarks: kinToQuarks("1"),
});
```
A `Payment` has the following required properties:
- `sender`: The private key of the account from which the payment will be sent.
- `destination`: The public key of the account to which the payment will be sent.
- `type`: The transaction type of the payment.
- `quarks`: The amount of the payment, in [quarks](https://docs.kin.org/terms-and-concepts#quark).
Additionally, it has the following optional properties:
- `subsidizer`: The private key of an account to use as the funder of the transaction instead of the subsidizer configured on Agora.
- `invoice`: An [Invoice](https://docs.kin.org/how-it-works#invoices) to associate with this payment. Cannot be set if `memo` is set.
- `memo`: A text memo to include in the transaction. Cannot be set if `invoice` is set.
- `dedupeId`: A unique identifier used by the service to help prevent the accidental submission of the same intended transaction twice.
`submitPayment` also has the following optional parameters:
- `commitment`: Indicates to Solana which bank state to query. See the [website documentation](https://docs.kin.org/solana#commitment) for more details.
- `senderResolution`: Indicates which type of account resolution to use for the payment sender.
- `destinationResolution`: Indicates which type of account resolution to use for the payment destination.
- `senderCreate`: If set to `true` and the destination account is not found, the client will create a token account owned by the submitted destination account.
#### Submit an Earn Batch
The `submitEarnBatch` method submits a batch of earns to Agora from a single account. It batches the earns into fewer
transactions where possible and submits as many transactions as necessary to submit all the earns.
```typescript
const earns: Earn[] = [
{
destination: PublicKey.fromString("xx"),
quarks: kinToQuarks("1"),
},
{
destination: PublicKey.fromString("yy"),
quarks: kinToQuarks("1"),
}
];
const result = await client.submitEarnBatch({
sender: sender,
earns: earns,
})
```
A single `Earn` has the following properties:
- `destination`: The public key of the account to which the earn will be sent.
- `quarks`: The amount of the earn, in [quarks](https://docs.kin.org/terms-and-concepts#quark).
- `invoice`: (optional) An [Invoice](https://docs.kin.org/how-it-works#invoices) to associate with this earn.
An `EarnBatch` has the following parameters:
- `sender`: The private key of the account from which the earns will be sent.
- `earns`: The list of earns to send.
- `memo`: (optional) A text memo to include in the transaction. Cannot be used if the earns have invoices associated with them.
- `subsidizer`: (optional) The private key of an account to use as the funder of the transaction instead of the subsidizer configured on Agora.
- `dedupeId`: (optinoal) a unique identifier used by the service to help prevent the accidental submission of the same intended transaction twice.
`submitEarnBatch` also has the following optional parameters:
- `commitment`: Indicates to Solana which bank state to query. See the [website documentation](https://docs.kin.org/solana#commitment) for more details.
- `senderResolution`: Indicates which type of account resolution to use for the payment sender.
- `destinationResolution`: Indicates which type of account resolution to use for the payment destination.
### Examples
A few examples for creating an account and different ways of submitting payments and batched earns can be found in `examples/client`.
## Webhook Handlers
The SDK offers handler functions to assist developers with implementing the [Agora webhooks](https://docs.kin.org/how-it-works#webhooks).
Only apps that have been assigned an [app index](https://docs.kin.org/app-registration) can make use of Agora webhooks.
### Prerequisites
The handlers assume usage of the `express` framework, as the default `http` library does not offer
much support for body reading, and middleware.
### Usage
There are currently two handlers:
- [Events](https://docs.kin.org/how-it-works#events) with `EventsHandler`
- [Sign Transaction](https://docs.kin.org/how-it-works#sign-transaction) with `SignTransactionHandler`
When configuring a webhook, a [webhook secret](https://docs.kin.org/agora/webhook#authentication) can be specified.
#### Events Webhook
To consume events from Agora:
```typescript
import { express, json } from "express";
import { Event, EventsHandler } from "@kinecosystem/kin-sdk-v2/webhook";
// Note: if no secret is provided to the handler, all requests will be processed.
// otherwise, the request signature will be validated to ensure it came from agora.
const secret = "WEBHOOK_SECRET";
const app = express();
// json() properly reads the entire response body and transforms it into a
// object suitable for use by the EventsHandler.
app.use("/events", json());
app.use("/events", EventsHandler(events: []Event) => {
// processing logic
}, secret),
```
#### Sign Transaction Webhook
The sign transaction webhook is used to sign Kin 3 transactions with a whitelisted Kin 3 account to remove fees. On Kin 4, the webhook can be used to simply approve or reject transactions submitted by mobile clients.
To verify and sign transactions related to your app:
```typescript
import { express, json } from "express";
import {
SignTransactionRequest,
SignTransactionResponse,
SignTransactionHandler,
} from "@kinecosystem/kin-sdk-v2/webhook";
// Note: if no secret is provided to the handler, all requests will be processed.
// otherwise, the request signature will be validated to ensure it came from agora.
const secret = "WEBHOOK_SECRET";
const app = express();
// json() properly reads the entire response body and transforms it into a
// object suitable for use by the EventsHandler.
app.use("/sign_transaction", json());
app.use("/sign_transaction", SignTransactionHandler(req: SignTransactionRequest, resp: SignTransactionResponse) => {
// decide whether or not to sign() or reject() the request.
}, secret),
```
### Example Code
A simple example Express server implementing both the Events and Sign Transaction webhooks can be found in `examples/webhook/webhook.tx`. To run it, first install all required dependencies:
```
$ npm i
or
$ yarn install
```
Next, run it as follows from the root directory (it will run on port 8080):
```
export WEBHOOK_SECRET=yoursecrethere
export WEBHOOK_SEED=SXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
npx ts-node examples/webhook/webhook.ts
```