@keepix/wallets-tezos
v0.0.1
Published
Wallets Tezos library
Readme
Keepix.Wallets.Tezos
Library that respects the WalletLibraryInterface.
This library is used to create wallets, hold coin and token balances and carry out transactions.
class Wallet {
constructor() {}
init: ({}: {
networkId: NETWORK
password?: string
mnemonic?: string
privateKey?: string
type: string
keepixTokens?: { coins: any; tokens: any } // whitelisted coins & tokens
rpc?: any
privateKeyTemplate?: string
}) => void;
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 XTZ
estimateCostSendCoinTo: (receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string | number }>;
estimateCostSendTokenTo: (tokenAddress: string, receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
sendCoinTo: (receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string | number }>;
sendTokenTo: (tokenAddress: string, receiverAddress: string, amount: string) => Promise<{ success: boolean, description: string }>;
}
export interface WalletLibraryInterface {
Wallet: typeof Wallet;
};