Kaspa integration

Welcome to KasWare's integration documentation. This documentation is for learning to integrate KasWare wallet with your applications. Please note : The integration API may be modified if relevant standards are officially released by kaspa core team one day in the future.

Getting Started

First of all, install KasWare Wallet on your development machine. Once KasWare Wallet is installed and running, you should find that new browser tabs have a window.kasware object available in the developer console. This is how your website will interact with KasWare Wallet.

Demo Code

Demo source code

Browser Detection

To verify if the browser is running KasWare Wallet, copy and paste the code snippet below in the developer console of your web browser:

if (typeof window.kasware !== "undefined") {
  console.log("KasWare Wallet is installed!");
}

You can review the full API for the window.kasware object here.

Connecting to KasWare Wallet

"Connecting" or "logging in" to KasWare Wallet effectively means "to access the user's Kaspa account(s)".

You should only initiate a connection request in response to direct user action, such as clicking a button. You should always disable the "connect" button while the connection request is pending. You should never initiate a connection request on page load.

We recommend that you provide a button to allow the user to connect KasWare Wallet to your dapp. Clicking this button should call the following method:

kasware.requestAccounts();

​​

Methods

requestAccounts

kasware.requestAccounts();

Connect the current account.

Parameters

none

Returns

• Promise returns string[] : Address of current account.

Example

try {
  let accounts = await window.kasware.requestAccounts();
  console.log('connect success', accounts);
} catch (e) {
  console.log('connect failed');
}
> connect success ['kaspa:qzhkxxaully72gk23lyn7z3d9tdzdpw48ujsavrwlulekyk7pkxzzxj26hcsq']

getAccounts

kasware.getAccounts();

Get address of current account. It's also used to certify if the user is connected, which should be called first.

Parameters

none

Returns

• Promise - string: address of current account

Example

try {
  let res = await window.kasware.getAccounts();
  console.log(res)
} catch (e) {
  console.log(e);
}
> ["kaspa:qzhkxxaully72gk23lyn7z3d9tdzdpw48ujsavrwlulekyk7pkxzzxj26hcsq"]

getVersion

kasware.getVersion();

get wallet version

Parameters

none

Returns

• Promise - string: wallet version

Example

try {
  let res = await window.kasware.getVersion();
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> '0.7.5.4'

getNetwork

kasware.getNetwork();

get network

Parameters

none

Returns

• Promise - string: the network. livenet and testnet

Example

try {
  let res = await window.kasware.getNetwork();
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> 0

switchNetwork

kasware.switchNetwork(network);

switch network It's disable in the mobile app.

Parameters

• network - string: the network. mainnet/testnet/devnet

Returns

none

Example

try {
  let res = await window.kasware.switchNetwork("mainnet");
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> 0

disconnect

kasware.disconnect(origin);

disconnect kasware wallet

Parameters

• origin - string: website origin url

Returns

none

Example

try {
  let origin = window.location.origin;
  await kasware.disconnect(origin);
} catch (e) {
  console.log(e);
}
​
> 0

getPublicKey

kasware.getPublicKey();

Get publicKey of current account.

Parameters

none

Returns

• Promise - string: publicKey

Example

try {
  let res = await window.kasware.getPublicKey();
  console.log(res)
} catch (e) {
  console.log(e);
}
> 03cbaedc26f03fd3ba02fc936f338e980c9e2172c5e23128877ed46827e935296f

getBalance

kasware.getBalance();

Get KAS balance

Parameters

none

Returns

• Promise - Object:

  • confirmed - number : the confirmed sompi

  • unconfirmed - number : the unconfirmed sompi

  • total - number : the total sompi

Example

try {
  let res = await window.kasware.getBalance();
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> {
    "confirmed":0,
    "unconfirmed":100000,
    "total":100000
  }

getKRC20Balance

kasware.getKRC20Balance();

Get KRC20 token balance

Parameters

none

Returns

• Promise - Array of Object:

  • balance: string;

  • dec: string;

  • locked: string;

  • opScoreMod: string;

  • tick: string;

Example

try {
  let res = await window.kasware.getKRC20Balance();
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> {
    balance: "287999890000000"
    dec: "8"
    locked: "0"
    opScoreMod: "905940300025"
    tick: "XXXX"
  }

getUtxoEntries

kasware.getUtxoEntries();

Get UTXO entries

Parameters

none

Returns

• Promise - Array of Object:

Example

try {
  let res = await window.kasware.getUtxoEntries();
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> [
    {
        "entry": {
            "address": {
                "version": "PubKey",
                "prefix": "kaspa",
                "payload": "qp2vyqkuanrqn38362wa5ja93e3se4cv3zqa8yhjalrj24n3g2t52hwx299ku"
            },
            "outpoint": {
                "transactionId": "3219574931ae6d7a3152c7708443c41861292347e8729a0e59b5058357935d38",
                "index": 0
            },
            "amount": 639799290,
            "scriptPublicKey": {
                "version": 0,
                "script": "2054c202dcecc609c4f1d29dda4ba58e630cd70c8881d392f2efc7255671429745ac"
            },
            "blockDaaScore": 109555764,
            "isCoinbase": false
        },
        "outpoint": {
            "transactionId": "3219574931ae6d7a3152c7708443c41861292347e8729a0e59b5058357935d38",
            "index": 0
        },
        "address": {
            "version": "PubKey",
            "prefix": "kaspa",
            "payload": "qp2vyqkuanrqn38362wa5ja93e3se4cv3zqa8yhjalrj24n3g2t52hwx299ku"
        },
        "amount": 639799290,
        "isCoinbase": false,
        "blockDaaScore": 109555764,
        "scriptPublicKey": {
            "version": 0,
            "script": "2054c202dcecc609c4f1d29dda4ba58e630cd70c8881d392f2efc7255671429745ac"
        }
    }
]

sendKaspa

kasware.sendKaspa(toAddress, sompi, options);

Send KAS

Parameters

• toAddress - string: the address to send

• sompi - number: the sompi to send

• options - object: (optional)

  • priorityFee - number: the network prioity fee. default is 0. Unit is sompi

  • payload - string: payload for transactions

Returns

• Promise - string: txid

Example

try {
  let txid = await window.kasware.sendKaspa(
    "kaspa:qzhkxxaully72gk23lyn7z3d9tdzdpw48ujsavrwlulekyk7pkxzzxj26hcsq",
    1000
  );
  console.log(txid);
} catch (e) {
  console.log(e);
}

signPskt

kasware.signPskt({ txJsonString, options });

sign Pskt

Parameters

• txJsonString - string: a pskt json string

• options - object:

  • signInputs - object array.

    • index - number: index of input to sign

    • sighashType - number: the sighash type.

Returns

• Promise - string: signed tx json string

Example

try {
    /**
   * Kaspa Sighash types allowed by consensus
   * @category Consensus https://kaspa-mdbook.aspectron.com/transactions/sighashes.html
   */
  enum SighashType {
    All = 0b00000001, // 1
    None = 0b00000010, // 2
    Single = 0b00000100, // 4
    AllAnyOneCanPay = 0b10000001, // 128 + 1 = 129
    NoneAnyOneCanPay = 0b10000010, // 128 + 2 = 130
    SingleAnyOneCanPay = 0b10000100, // 128 + 4 = 132
  }
  const pskt = `{"id":"6664c0a75a041dd1f591c5ecc539875a99e5a49aaacb2e1ef04e354d0e69c271","version":0,"inputs":[{"transactionId":"006866a332181f4e3aab471af6435a645f5ca33697633fa20233af59ae4e8b2f","index":1,"sequence":"0","sigOpCount":1,"signatureScript":"","utxo":{"address":"kaspatest:qz9dvce5d92czd6t6msm5km3p5m9dyxh5av9xkzjl6pz8hhvc4q7wqg8njjyp","amount":"99986271","scriptPublicKey":"0000208ad66334695581374bd6e1ba5b710d365690d7a758535852fe8223deecc541e7ac","blockDaaScore":"87857448","isCoinbase":false}},{"transactionId":"c46a6fcd4746bbe60a68bf2efb543a65685f81b72440fcaa271cf86b25720d31","index":0,"sequence":"0","sigOpCount":1,"signatureScript":"","utxo":{"address":"kaspatest:qz9dvce5d92czd6t6msm5km3p5m9dyxh5av9xkzjl6pz8hhvc4q7wqg8njjyp","amount":"49100001963","scriptPublicKey":"0000208ad66334695581374bd6e1ba5b710d365690d7a758535852fe8223deecc541e7ac","blockDaaScore":"87513486","isCoinbase":false}}],"outputs":[{"value":"110000000","scriptPublicKey":"000020ab4b389073830cb400647fb8dc116e6b8a71c17e1c09ba7eaef2ddd78616f306ac"},{"value":"49089970826","scriptPublicKey":"0000208ad66334695581374bd6e1ba5b710d365690d7a758535852fe8223deecc541e7ac"}],"subnetworkId":"0000000000000000000000000000000000000000","lockTime":"0","gas":"0","mass":"3154","payload":""}`
 const signature = await (window as any).kasware.signPskt({
       txJsonString: pskt,
       options: {
                signInputs: [
                  {
                    index: 0,
                    sighashType: SighashType.All,
                  },
                  {
                    index: 1,
                    sighashType: SighashType.All,
                  },
                ],
              },
       });
  console.log("signed tx", signature);
} catch (e) {
  console.log(e);
}

buildScript

kasware.buildScript({ type, data });

build inscription script

Parameters

• type - string: script type. "KRC20" | "KNS" | "KSPR_KRC721"

• data - string: the data to inscribe

Returns

• Promise - object: inscription string and p2sh address

Example

try {

    enum BuildScriptType {
      KRC20 = "KRC20",
      KNS = "KNS",
      KSPR_KRC721 = "KSPR_KRC721",
    }
    const json = {
      p: "krc-20",
      op: "mint",
      tick: "test",
    };
    const data = JSON.stringify(data, null, 0);
    const { script, p2shAddress } = await (window as any).kasware.buildScript({
      type: BuildScriptType.KRC20,
      data: data,
    });
  console.log("inscription script and p2sh address", script, p2shAddress);
} catch (e) {
  console.log(e);
}

submitCommitReveal

kasware.submitCommitReveal(commit, reveal, script, networkId);

Demo Code For submitCommitReveal

Demo Code For KRC20 Marketplace

Demo Code For KRC20 Marketplace

createKRC20Order

kasware.createKRC20Order({ krc20Tick, krc20Amount, kasAmount, psktExtraOutput, priorityFee });

Create a KRC20 Order to sell KRC20 token

Parameters

• krc20Tick - string: krc20 token tick

• krc20Amount - number || string: the amount of KRC20 token to sell, Unit is KRC20 token

• kasAmount - number: total selling price. Unit is kas

• psktExtraOutput - {address:string; amount: number }[]:(optional) use psktExtraOutput to create a service fee or other things

• priorityFee - number:(optional) the network prioity fee. default is 0. Unit is kas.

Returns

• Promise - { txJsonString: string, sendCommitTxId:string }: txJsonString is the pskt json string, sendCommitTxId is the commit transaction id of Send OP

Example:

try {
      const krc20Tick = "aaaa";
      const krc20Amount = 10;
      const kasAmount = 490;
      const psktExtraOutput = [
        { address: "kaspatest:qrpygfgeq45h68wz5pk4rtay02w7fwlhax09x4rsqceqq6s3mz6uctlh3a695", amount: 0.2 },
      ];
      const priorityFee = 0;
      const { txJsonString, sendCommitTxId } = await (window as any).kasware.createKRC20Order({
        krc20Tick,
        krc20Amount,
        kasAmount,
        psktExtraOutput,
        priorityFee,
      });

} catch (e) {
  console.log(e);
}

buyKRC20Token

Demo Code For buyKRC20Token()

kasware.buyKRC20Token({ txJsonString, extraOutput, priorityFee });

Parameters

• txJsonString - string: a pskt json string from the createKRC20Order() function

• extraOutput - {address:string; amount: number }[]: (optional) use extraOutput to create a service fee or other things

• priorityFee - number: (optional) the network prioity fee. default is 0. Unit is kas.

Returns

• Promise - txId: transaction id

cancelKRC20Order

Demo Code For cancelKRC20Order()

kasware.cancelKRC20Order({ krc20Tick, txJsonString, sendCommitTxId });

Parameters

• krc20Tick - string: krc20 token tick

• txJsonString - string: (optional) a pskt json string from the createKRC20Order() function

• sendCommitTxId - string: (optional) sendCommitTxId is the commit transaction id of Send OP from the createKRC20Order() function

Returns

• Promise - txId: transaction id

signMessage

Demo Code For signMessage()

kasware.signMessage(msg, { type, noAuxRand });

sign message

Parameters

• msg - string: a string to sign

• type - string: (Optional) "auto" | "schnorr" | "ecdsa". default is "auto"

• noAuxRand - boolean: (Optional) if true, do not use aux rand. default is false

Returns

• Promise - string: the signature.

Example

// sign by auto (current address type)
try {
  let res = await window.kasware.signMessage("abcdefghijk123456789");
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> G+LrYa7T5dUMDgQduAErw+i6ebK4GqTXYVWIDM+snYk7Yc6LdPitmaqM6j+iJOeID1CsMXOJFpVopvPiHBdulkE=
​

const pubkey = "026887958bcc4cb6f8c04ea49260f0d10e312c41baf485252953b14724db552aac";
const message = "abcdefghijk123456789";
const signature = "G+LrYa7T5dUMDgQduAErw+i6ebK4GqTXYVWIDM+snYk7Yc6LdPitmaqM6j+iJOeID1CsMXOJFpVopvPiHBdulkE=";
const resultSchnorr = kasware.verifyMessage(pubkey,message,signature);
console.log(resultSchnorr);
const resultECDSA = kasware.verifyMessageECDSA(pubkey,message,signature);
console.log(resultECDSA);


> true
​
// sign by ECDSA
try {
  let res = await window.kasware.signMessage("abcdefghijk123456789", { type:"ecdsa" });
  console.log(res)
} catch (e) {
  console.log(e);
}
​
> AkcwRAIgeHUcjr0jODaR7GMM8cenWnIj0MYdGmmrpGyMoryNSkgCICzVXWrLIKKp5cFtaCTErY7FGNXTFe6kuEofl4G+Vi5wASECaIeVi8xMtvjATqSSYPDRDjEsQbr0hSUpU7FHJNtVKqw=

signKRC20Transaction

kasware.signKRC20Transaction(inscribeJsonString, type, destAddr, priorityFee);

Sign KRC20 Transaction

Parameters

• inscribeJsonString - string: stringified json object

• type - number: 2 for deployment, 3 for mint, 4 for transfer

• destAddr - string:(optional) the address to transfer. it's an optional parameter. only used for transfer

• priorityFee - number:(optional) the network prioity fee. default is 0. Unit is kas.

Returns

• Promise - string: txid

Example-1: deploy a KRC20 token

try {
  const deployJsonString =
    '{"p":"KRC-20","op":"deploy","tick":"BBBB","max":"21000000000000000000000000000000","lim":"100000000000000000000", "pre":"100000000000000000000"}';
  const type = 2;
  let txid = await window.kasware.signKRC20Transaction(inscribeJsonString, type);
  console.log(txid);
} catch (e) {
  console.log(e);
}

Example-2: mint a KRC20 token

try {
  const inscribeJsonString = '{"p":"KRC-20","op":"mint","tick":"XXXX"}';
  const type = 3;
  let txid = await window.kasware.signKRC20Transaction(inscribeJsonString, type);
  console.log(txid);
} catch (e) {
  console.log(e);
}

Example-3: transfer a KRC20 token

try {
  const transferJsonString =
    '{"p":"KRC-20","op":"transfer","tick":"RBMV","amt":"10000000000","to":"kaspa:qzhkxxaully72gk23lyn7z3d9tdzdpw48ujsavrwlulekyk7"}';
  const type = 4;
  const destAddr = "kaspa:qzhkxxaully72gk23lyn7z3d9tdzdpw48ujsavrwlulekyk7";
  let txid = await window.kasware.signKRC20Transaction(inscribeJsonString, type, destAddr);
  console.log(txid);
} catch (e) {
  console.log(e);
}

Events

accountsChanged

kasware.on('accountsChanged', handler: (accounts: Array<string>) => void);
kasware.removeListener('accountsChanged', handler: (accounts: Array<string>) => void);

The accountsChanged will be emitted whenever the user's exposed account address changes.

networkChanged

kasware.on('networkChanged', handler: (network: string) => void);
kasware.removeListener('networkChanged', handler: (network: string) => void);

The networkChanged will be emitted whenever the user's network changes.

balanceChanged

kasware.on('balanceChanged', handler: (balance: IBalance) => void);
kasware.removeListener('balanceChanged', handler: (balance: IBalance) => void);;

The balaneChanged will be emitted whenever the user's balance changes.

Example

kasware.on('balanceChanged', (balance) => {
  console.log(balance);
  // example
    {
        address: "kaspa:qp2vyqkuanrqn38362wa5ja93e3se4cv3zqa8yhjalrj24n3g2t52hwx299ku",
        balance: {
            mature: 1699956916,
            pending: 199988333,
            outgoing: 0,
            matureUtxoCount: 1,
            pendingUtxoCount: 1,
            stasisUtxoCount: 0
        }
    }
});

transactionReplacementResponse

kasware.on('transactionReplacementResponse', handler: (response: { transactionId:string, replacedTransactionId:string }) => void);
kasware.removeListener('transactionReplacementResponse', handler: (response: transactionId:string, replacedTransactionId:string ) => void);;

The transactionReplacementResponse will be emitted whenever the user pushes a rbf transaction.

Example

kasware.on('transactionReplacementResponse', (res) => {
  console.log(res);
  // example
    {
        transactionId: "c353c038d18a2455b72ea02ed47b4e34a60577435f6eba88f940c591c6405ca5",
        replacedTransactionId: "40a6fa1b3611bb4d34f9d8d91a90f46b3e0b6a5f1b0663de8bbe58bec2f3ecdg"
    }
});