Flutter / Dart

#Get Started or Add to an Existing Project

Getting started with Kin is incredibly straightforward. Just follow the steps below to start transacting with Kin in your app.

#Installation

Add the package to your pubspec.yaml file below dependencies.

kinetic: ^1.0.0-rc.1

Visit pub.dev/packages/kinetic for other versions.

#Instantiate the Kinetic Client

The Kinetic Client will give you access to all the methods you need to work with Kin on the blockchain.

We recommend starting with Devnet before moving on to Mainnet.

KineticSdkConfig sdkConfig = KineticSdkConfig(
  index: 1,
  endpoint: 'https://sandbox.kinetic.host',
  environment: 'devnet',
  logger: Logger(),
);
KineticSdk sdk = await KineticSdk.setup(sdkConfig);

Don't have an App Index? Register your app on our Developer Portal so you can get your App Index that allows you to transact with our SDKs and earn via the KRE.

While you're waiting for confirmation of your App Index, use 1 on devnet so you can get started.

#Create Account

You can create accounts randomly or from existing mnemonics or secret keys. Below, we'll make a keypair and use that for creating an account on the blockchain.

You can also generate keypairs and create accounts on devnet via the Kin Laboratory.

Keypair owner = await Keypair.random();

CreateAccountOptions options = CreateAccountOptions(
  owner: owner,
  mint: mint,
  commitment: CreateAccountRequestCommitmentEnum.finalized,
  reference: 'test',
);

Transaction? transaction = await sdk.createAccount(options);

#Close Account

It's good practice to close unneeded accounts. You can only close accounts that you have created and are currently empty.

CloseAccountOptions options = CloseAccountOptions(
  account: owner.publicKey,
  commitment: CreateAccountRequestCommitmentEnum.finalized,
);
CloseAccountResponse? res = await sdk.closeAccount(options: options);

#Check Balance

Check a user balance by passing in the public key of the account you want to check.

The response object includes your total Kin balance as well as detailing all of the Mints and Tokens held by that Public Key.

GetBalanceOptions options = GetBalanceOptions(account: owner.publicKey);
BalanceResponse? res = await sdk.getBalance(options: options);
dynamic res = await kinetic.getBalance(kinetic.keypair.solanaPublicKey.toBase58());

#Airdrop Funds (devnet)

Send some test funds to a specific Public Key on Devnet.

Or visit the Kin Laboratory to do it with a click!

RequestAirdropOptions options = RequestAirdropOptions(
  account: owner.publicKey,
  mint: mint,
  amount: "10",
  commitment: RequestAirdropRequestCommitmentEnum.finalized,
);
RequestAirdropResponse? res = await sdk.requestAirdrop(options);

#Transfer Kin

Transfer Kin from a Keypair to any Public Key.

Make sure to include your Transaction Type if you want it to count towards the KRE.

Keypair alice = await Keypair.random();

MakeTransferOptions options = MakeTransferOptions(
  amount: "1.0",
  destination: alice.publicKey,
  commitment: MakeTransferRequestCommitmentEnum.finalized,
  mint: mint,
  owner: owner,
  reference: "some-ref",
  type: TransactionType.p2p,
  senderCreate: false,
);

Transaction? transaction = await sdk.makeTransfer(options);

#Get Transaction Details

Get the details of any transaction by passing in the transaction signature.

GetTransactionOptions options = GetTransactionOptions(signature: transaction.signature!)
GetTransactionResponse? res = await sdk.getTransaction(options);

#Get Solana Explorer URL

Solana Explorer

String? res = await sdk.getExplorerUrl("account or transaction id string");

#Get Account History

Get the full transaction history of any account by passing in the account's Public Key.

GetHistoryOptions options = GetHistoryOptions(account: alice.publicKey, mint: mint);
List<HistoryResponse>? res = await sdk.getHistory(options);

#Get Account Info

Easily get the main info of any account by passing in the account's Public Key.

GetAccountInfoOptions options = GetAccountInfoOptions(account: alice.publicKey, mint: mint);
List<AccountInfoResponse>? res = await sdk.getAccountInfo(options);

#Get Token Accounts

Get the full list of Token Accounts held by a Keypair on Solana.

GetTokenAccountsOptions options = GetTokenAccountsOptions(account: alice.publicKey, mint: mint);
List<TokenAccountsResponse>? res = await sdk.getTokenAccounts(options);

#Webhooks

Whether you are using Kinetic As A Service or Self-Hosting to connect to Kinetic, once you're up and running, you'll be able to access Kinetic Manager to manage your app's settings.

This includes allowing you to configure your app to use a number of webhooks.

#Balance Webhook

The balance webhook allows you to receive an alert when your app's hotwallet is running low on Sol so you can top it up and ensure your app can continue to keep transacting.

E.g. In a node express server:

app.use('/balance', async (req, res) => {
  const data = req.body
  // DO STUFF WITH THE BALANCE ALERT
  res.sendStatus(200)
})

#Event Webhook

The event webhook allows you to receive alerts when actions have been confirmed on the Solana blockchain.

E.g. In a node express server:

app.use('/events', async (req, res) => {
  const event = req.body
  // DO STUFF WITH THE EVENT DATA
  res.sendStatus(200)
})

#Verify Webhook

The verify webhook allows you to have fine-grained control over transactions, making sure they meet your own criteria before allowing them to proceed.

E.g. In a node express server return a 200 status code to approve the transaction or a 400 to reject it:

app.use('/verify', async (req, res) => {
  const transaction = req.body
  // CHECK THAT YOU WANT THIS TRANSACTION TO PROCEED
  // e.g.
  if (transaction.amount < 1000000) {
    res.sendStatus(200)
  }
  res.sendStatus(400)
})

#Demos and Starter Kits

Created to help get you up and running as quickly as possible, these projects can be a great reference point when you get stuck or even a starter for your own project. Happy coding!

#Ready for Production?

If your app is ready for production, this is the place for you!

#Earn Kin via the KRE

#Contribute

#What If I Get Stuck?

#Developer Best Practices

Once you're ready to code, have a quick look at our Developer Best Practices where we cover some useful topics that you'll want to keep in mind as you build out your Kin application.

---