@keepix/wallets-algo
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

Keepix.Wallets.Algo

Library that respects the WalletLibraryInterface.
This library is used to create wallets, hold coin and token balances and carry out transactions.

class Wallet {
    constructor({}: {
        password?: string
        mnemonic?: string
        privateKey?: string
        type: string
        keepixTokens?: { coins: any; tokens: any } // whitelisted coins & tokens
        rpc?: any
        privateKeyTemplate?: string
    }) {}

    getPrivateKey: () => string;
    getMnemonic: () => string | undefined;
    getAddress: () => string;
    getProdiver: () => Promise<any>;

    // returns like 1.01 (Always in readable value)
    getCoinBalance: (walletAddress?: string) => Promise<string>;
    // returns like 1.01 (Always in readable value)
    getTokenBalance: (tokenAddress: string, walletAddress?: string) => Promise<string>;

    // amount is always like 1.20 ALGO
    estimateCostSendCoinTo: (receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
    estimateCostSendTokenTo: (tokenAddress: string, receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
    sendCoinTo: (receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
    sendTokenTo: (tokenAddress: string, receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
}

export interface WalletLibraryInterface {
    Wallet: typeof Wallet;
};

Readme

Keywords

Package Sidebar

Install

npm i @keepix/wallets-algo

Weekly Downloads

1

Version

0.0.1

License

MIT

Unpacked Size

131 kB

Total Files

15

Last publish

Collaborators

  • jguyet