npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@overgold/light-client

v0.0.19

Published

## Установка переменных

Downloads

87

Readme

light client

Установка переменных


MAIN_SERVER_ENDPOINT=https://api.chain.overgold.app/
MAIN_WALLET_ENDPOINT=https://overgold.app

BASE_BIP44_PATH="m/44'/118'/0'/0"
BLOCKCHAIN_URL=https://rpc.chain.overgold.app
BECH32_PREFIX=ovg
ASSET=ovg

Установка

npm install --save @overgold/light-client
yarn add @overgold/light-client

Использование

import * as lightClient from '@overgold/light-client';

Получить сессию из мнемоники

type Session = (mnemonic:string) => Promise<{
    data: null;
    error: {
        status: number;
        message: string;
        statusText?: undefined;
    };
} | {
    data: ISession;
    error: null;
} | {
    data: null;
    error: {
        status: number;
        statusText: string;
        message?: undefined;
    };
}>;

interface ISession {
    BECH32_PREFIX: string;
    BLOCKCHAIN_URL: string;
    ASSET: string;
    mnemonic: string;
    signer: AccountData;
    account: DirectSecp256k1HdWallet;
    signingClient: SigningStargateClient;
    message: IBuiltinMessagesFactory;
    getKeyPair: (index?: number) => ECPairInterface;
    getAddress: (index?: number) => string;
    toKeyStoreObject: (password: string) => object;
    toKeyStoreString: (password: string) => string;
}

  const session:Session = await lightClient.getSessionFromMnemonic(mnemonic);

Получить адрес из мнемоники

  type Address = (mnemonic:string) => Promise<{
    data: null;
    error: {
        status: number;
        message: string;
    };
} | {
    data: {address:string};
    error: null;
}>

  const address:Address = await lightClient.getAccountAddressFromMnemonic(mnemonic);

Получить балансы по адресу

type Balance = (address:string) => Promise<BalanceResponse>

interface BalanceResponse {
  ovg: {
    amount: number;
  };
  stovg: {
    amount: number;
    stakeAmount: number;
    sellAmount: number;
  };
}

  const balance:Balance = await lightClient.getAccountAllBalance(address);

Валидация адреса

  type AddressIsValid = (address:string) => boolean

  const accountAddressIsValid:AddressIsValid = lightClient.accountAddressIsValid(address);

Валидация мнемоники

  type MnemonicIsValid = (mnemonic:string) => boolean

  const mnemonicIsValid:MnemonicIsValid = lightClient.mnemonicIsValid(mnemonic);

Получить транзакцию из блокчейн по хешу

  type TransactionByHash = (txHash:string) =>Promise<any>

  const getTransactionByHash:TransactionByHash = lightClient.getTransactionByHash(txHash);

Получить курс OVG в указанной валюте

 interface BalanceResponse {
  price: string;
  date: string;
  currency: string;
}

export type Price = (
  currency?: string,//default 'eur'
) =>Promise<{
    data: null;
    error: {
        status: number;
        message: string;
    };
} | {
    data: {
        gas: BalanceResponse;
        hash: string | null;
    };
    error: null;
}>;

  const getPrice:Price =await lightClient.getPrice(currency);

Запрос информации по ордеру (cardio-to-stake)


export type Info = (hash: string) => Promise<{
    data: {
      id:number;
      tx_hash:string;
      amount_stake:number;
      amount_eur:number;
      account_address:string;
      status:string;
      email:string;
    };
    error: null;
} | {
    data: null;
    error: {
        status: number;
        statusText: string;
    };
}>;

  const getOrderInfo:Info =await lightClient.getOrderInfo(hash);

Создаем заявку на обмен (cardio-to-stake)

 interface ConfirmRequest {
  hash: string;
  email: string;
  address: string;
}

export type Confirm = (payload: ConfirmRequest) => Promise<{
    data: {
      tx_hash:string;
    };
    error: null;
} | {
    data: null;
    error: {
        status: number;
        statusText: string;
    };
}>;

  const confirmStakeToCardio:Confirm =await lightClient.confirmStakeToCardio(payload);

Подписать и отправить трансфер по отправке ovg


interface MakeTransactionSendProps {
  mnemonic: string;
  toAddress: string;
  amount: string;
  denom?: string; //default 'ovg'
  memo?: string; //default ''
  isSimulate?: boolean; //default false
}

type SendOVG = (payload : MakeTransactionSendProps) => Promise<{
    data: null;
    error: {
        status: number;
        message: string;
    };
} | {
    data: {
        gas: number;
        hash: string | null;
    };
    error: null;
}>

const sendOVG:SendOVG = await lightClient.makeTransactionSendOVG({
    mnemonic,
    toAddress,
    amount,
    });

Подписать трансфер по отправке stovg (user-to-stake). Пользователь может отправить только свободный стейк (тот что стоит на выкупе - не может).

interface MakeTransactionFromUserProps {
  mnemonic: string;
  amount: string;
  memo?: string; //default ''
  isSimulate?: boolean; //default false
}

type SendStOVG = (payload : MakeTransactionFromUserProps) => Promise<{
    data: null;
    error: {
        status: number;
        message: string;
        statusText?: undefined;
    };
} | {
    data: null;
    error: {
        status: number;
        statusText: string;
        message?: undefined;
    };
} | {
    data: {
        gas: number;
        hash: string | null;
    };
    error: null;
}>

  const sendStOVG:SendStOVG = await lightClient.makeTransactionFromUser({
    mnemonic,
    amount,
  })