@kyve/sdk
Version:
<p align="center"> <a href="https://kyve.network"> <img src="https://user-images.githubusercontent.com/62398724/137493477-63868209-a19b-4efa-9413-f06d41197d6d.png" style="border-radius: 50%" height="96"> </a> <h3 align="center"><code>@kyve/sdk</
233 lines (218 loc) • 6.96 kB
text/typescript
import {
KYVE_COSMOSTATION_CONFIG,
KYVE_DECIMALS,
KYVE_ENDPOINTS,
KYVE_KEPLR_CONFIG,
KYVE_NETWORK,
Network,
PREFIX,
SUPPORTED_WALLETS,
} from "./constants";
import { getSigningKyveClient } from "./clients/full-client";
import {
DirectSecp256k1HdWallet,
DirectSecp256k1Wallet,
} from "@cosmjs/proto-signing";
import {
RequestAccountResponse,
SignOptions,
} from "@cosmostation/extension-client/types/message";
import {
cosmostationMethods,
CosmostationSigner,
} from "./utils/cosmostation-helper";
import { createKyveLCDClient } from "./clients/lcd-client/client";
import { BigNumber } from "bignumber.js";
// @ts-ignore
import humanize from "humanize-number";
import KyveWebClient from "./clients/rpc-client/web.client";
import KyveClient from "./clients/rpc-client/client";
import { fromBase64, fromHex } from "@cosmjs/encoding";
import {
pubkeyToAddress,
Secp256k1HdWallet,
Secp256k1Wallet,
} from "@cosmjs/amino";
import { KeplrAminoSigner } from "./utils/keplr-helper";
import { verifyADR36Amino } from "@keplr-wallet/cosmos";
/** Class representing a KyveSDK. */
export class KyveSDK {
public readonly network: Network;
private walletSupports: Set<keyof typeof SUPPORTED_WALLETS>;
/**
* Create sdk instance.
* @param network - The network type, e.g mainnet, testnet, etc
*/
constructor(network: KYVE_NETWORK | Network) {
this.walletSupports = new Set<keyof typeof SUPPORTED_WALLETS>();
if (typeof network === "string") {
this.network = KYVE_ENDPOINTS[network];
} else {
this.network = network;
}
}
/**
* Create a client from mnemonic
* @param mnemonic
* @return Promise<KyveClient>
*/
async fromMnemonic(mnemonic: string): Promise<KyveClient> {
const aminoSigner = await Secp256k1HdWallet.fromMnemonic(mnemonic, {
prefix: PREFIX,
});
const signedClient = await DirectSecp256k1HdWallet.fromMnemonic(mnemonic, {
prefix: PREFIX,
});
return getSigningKyveClient(this.network.rpc, signedClient, aminoSigner);
}
/**
* create a client from private key
* @param privateKey - hex privateKey
* @return Promise<KyveClient>
*/
async fromPrivateKey(privateKey: string): Promise<KyveClient> {
const formattedKey = fromHex(
privateKey.startsWith("0x") ? privateKey.slice(2) : privateKey
);
const signedClient = await DirectSecp256k1Wallet.fromKey(
formattedKey,
PREFIX
);
const aminoSigner = await Secp256k1Wallet.fromKey(formattedKey, PREFIX);
return getSigningKyveClient(this.network.rpc, signedClient, aminoSigner);
}
/**
* Crate a client from Keplr wallet if installed
* @return Promise<KyveWebClient>
*/
async fromKeplr(): Promise<KyveWebClient> {
if (typeof window === "undefined") throw new Error("Unsupported.");
if (!window.keplr) throw new Error("Please install Keplr.");
await window.keplr.experimentalSuggestChain({
...KYVE_KEPLR_CONFIG,
rpc: this.network.rpc,
rest: this.network.rest,
chainId: this.network.chainId,
chainName: this.network.chainName,
});
await window.keplr.enable(this.network.chainId);
window.keplr.defaultOptions = {
sign: {
preferNoSetFee: true,
},
};
const signer = window.keplr.getOfflineSigner(this.network.chainId);
const walletName = (await window.keplr.getKey(this.network.chainId)).name;
const keplr = window.keplr;
const keplrAminoSigner = new KeplrAminoSigner(keplr, this.network);
const client = await getSigningKyveClient(
this.network.rpc,
signer,
keplrAminoSigner,
walletName
);
this.walletSupports.add(SUPPORTED_WALLETS.KEPLER);
return client;
}
/**
* Crate a client from Cosmostaion wallet if installed
* @return Promise<KyveWebClient>
*/
async fromCosmostation(config?: SignOptions): Promise<KyveWebClient> {
if (typeof window === "undefined") throw new Error("Unsupported.");
if (!window.cosmostation) throw new Error("Please install cosmostation.");
const chain = await cosmostationMethods.getSupportedChains();
let cosmostationAccount: RequestAccountResponse;
if (
chain.unofficial.includes(this.network.chainName.toLowerCase().trim())
) {
cosmostationAccount = await cosmostationMethods.requestAccount(
this.network.chainName
);
} else {
await cosmostationMethods.addChain({
...KYVE_COSMOSTATION_CONFIG,
restURL: this.network.rest,
chainId: this.network.chainId,
chainName: this.network.chainName,
});
cosmostationAccount = await cosmostationMethods.requestAccount(
this.network.chainName
);
}
const cosmostationSigner = new CosmostationSigner(
cosmostationAccount,
this.network,
config ? config : {}
);
const client = await getSigningKyveClient(
this.network.rpc,
cosmostationSigner,
null,
cosmostationAccount.name
);
this.walletSupports.add(SUPPORTED_WALLETS.COSMOSTATION);
return client;
}
/**
* Listener to detect if account in wallet changed, support fromKeplr and fromCosmostation instances
* @param cb
*/
async onAccountChange(cb: () => void) {
if (this.walletSupports.has(SUPPORTED_WALLETS.COSMOSTATION))
return window.cosmostation.tendermint.on("accountChanged", cb);
if (this.walletSupports.has(SUPPORTED_WALLETS.KEPLER))
return window.addEventListener("keplr_keystorechange", cb);
throw new Error("Need to initiate from wallet");
}
/**
* create LCD client to get data from Rest api
*/
createLCDClient() {
return createKyveLCDClient(this.network.rest);
}
/**
* generate KyveClient instance without mnemonic
*/
async generate() {
const signer = await DirectSecp256k1HdWallet.generate(24, {
prefix: PREFIX,
});
const aminoSigner = await Secp256k1HdWallet.fromMnemonic(signer.mnemonic, {
prefix: PREFIX,
});
return getSigningKyveClient(this.network.rpc, signer, aminoSigner);
}
static async generateMnemonic(): Promise<string> {
const signer = await DirectSecp256k1HdWallet.generate(24, {
prefix: PREFIX,
});
return signer.mnemonic;
}
static formatBalance(balance: string, decimals: number = 2): string {
return humanize(
new BigNumber(balance)
.dividedBy(new BigNumber(10).exponentiatedBy(KYVE_DECIMALS))
.toFixed(decimals)
);
}
static getAddressFromPubKey(pubKey: string) {
return pubkeyToAddress(
{ type: "tendermint/PubKeySecp256k1", value: pubKey },
PREFIX
);
}
static async verifyString(
signature: string,
data: string,
pubKey: string
): Promise<boolean> {
return verifyADR36Amino(
PREFIX,
KyveSDK.getAddressFromPubKey(pubKey),
new TextEncoder().encode(data),
fromBase64(pubKey),
fromBase64(signature)
);
}
}