MultiConomy

Examples ▸
- Static members
- .How to load the library
Classes
Wallet ▸
- Static members
- .convertToBigInt
- Instance members
- #_addHistory
- #serializeBalance
- #hasFunds
- #addBalance
- #setBalance
- #removeBalance
- #getBalance
- #getOwner
- #getHistory
Bank ▸
- Instance members
- #queueSave
- #flushQueue
- #_createWallet
- #getWallet
- #getHistory
DefaultStore ▸
- Instance members
- #reset
- #getBalance
- #getAllBalances
- #getHistory
- #getAllHistory
- #addHistory
- #setBalance
- #updateNicks
- #getNicknames
- #getAllNicknames
- #getTopList
Exports
getCurrencySign
getCurrencyName
getWallet
getBalance
getBalances
getTopList

Need help reading this?

Classes

Definition for Classes

Wallet

creates a new wallet

new Wallet(bankHandle: Bank, uid: string, balance: (bigint | number | string))

Parameters

bankHandle (Bank) the bank to which the wallet belongs to

uid (string) the uid to who the wallet belongs to

balance ((bigint | number | string)) the amount of funds a wallet has

Static Members

▸ convertToBigInt(num)

Converts a number to a BigInt, this will remove any floating point

convertToBigInt(num: (bigint | number | string)): bigint

Parameters

num ((bigint | number | string)) the number which should be parsed to a bigint

Returns

bigint: returns the converted bigint

Instance Members

▸ _addHistory(change, reason)

Queues a history update

_addHistory(change: bigint, reason: string)

Parameters

change (bigint) the amount which had changed

reason (string) the text wich should be used in the log

▸ serializeBalance()

Serializes the balace and uid of the Wallet

serializeBalance(): Object

Returns

Object: returns a JSON.stringify able object

▸ hasFunds(amount)

Checks if a user has enough funds to do a transaction

hasFunds(amount: (bigint | number | string)): boolean

Parameters

amount ((bigint | number | string)) checks if a user has the amount of funds

Returns

boolean: returns true when the user has at least as much funds

▸ addBalance(amount, reason = "")

Adds an amount of funds to the wallet

addBalance(amount: (bigint | number | string), reason: string?): Wallet

Parameters

amount ((bigint | number | string)) the amount of funds which should be added

reason

(string?
            = "")

the reason which gets logged inside the transaction history

Returns

Wallet: returns this to chain functions

▸ setBalance(amount, reason = "")

Sets the amount of funds in the wallet

setBalance(amount: (bigint | number | string), reason: string?): Wallet

Parameters

amount ((bigint | number | string)) the amount of funds which should be set

reason

(string?
            = "")

the reason which gets logged inside the transaction history

Returns

Wallet: returns this to chain functions

▸ removeBalance(amount, reason = "")

Removes an amount of funds from the wallet

removeBalance(amount: (bigint | number | string), reason: string?): Wallet

Parameters

amount ((bigint | number | string)) the amount of funds which should be removed

reason

(string?
            = "")

the reason which gets logged inside the transaction history

Returns

Wallet: returns this to chain functions

▸ getBalance()

Retrieve the current balance

getBalance(): string

Returns

string: returns the current balance as string

▸ getOwner()

Retrieve the owner of the wallet

getOwner(): string

Returns

string: returns the uid of the wallet owner

▸ getHistory(limit)

Retrieves the transaction history

getHistory(limit: number): Array<Promise>

Parameters

limit

(number
            = 25)

the amount of entries which should get retrieved

Returns

Array<Promise>: returns a Promise which has an array with the last n transactions

Bank

Bank manages wallets of multiple users

new Bank(storeHandle: object, saveInterval: object)

Parameters

storeHandle (object) the store object from where transactions get handled

saveInterval (object) timeout until data gets saved to the store

Instance Members

▸ queueSave(wallet)

Adds a new wallet to the saving Queue

queueSave(wallet: Wallet)

Parameters

wallet (Wallet) the wallet which should get saved

▸ flushQueue()

Forces the save of all wallets in the queue

flushQueue()

▸ _createWallet(args)

Creates a wallet and returns it

_createWallet(args: ...any): Wallet

Parameters

args (...any) the arguments which will passed to the Wallet constructor

Returns

Wallet: returns the created wallet

▸ getWallet(uid)

Retrieves a wallet instance of the owner with the given uid

getWallet(uid: string): Promise

Parameters

uid (string) the uid from who the wallet should get retrieved

Returns

Promise: fulfills with the Wallet of the given uid

▸ getHistory(uid, limit)

Retrieves the transaction history of a uid

getHistory(uid: string, limit: number): Promise

Parameters

uid (string) the uid for which the history should be retrieved

limit (number) the amount of entries which should be retrieved

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the transaction array as value

DefaultStore

Creates a new Store class

new DefaultStore()

Instance Members

▸ reset()

Resets and wipes the complete Store except the dump

reset(): Promise

Returns

Promise:

▸ getBalance(uids)

Retrieves the balance of multiple uids

getBalance(uids: Array<string>): Promise

Parameters

uids (Array<string>) takes an array of uids as argument

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the balance as value

▸ getAllBalances()

Retrieves the balance of all existing users in the db

getAllBalances(): Promise

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the balance as value

▸ getHistory(uid, limit)

Retrieves the transaction history of an uid

getHistory(uid: string, limit: number): Promise

Parameters

uid (string) the uid for which the history should be retrieved

limit (number) the amount of entries which should be retrieved

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the transaction array as value

▸ getAllHistory()

Retrieves the transaction history of an uid

getAllHistory(): Promise

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the transaction array as value

▸ addHistory(data)

Adds transaction to the transaction history of an uid

addHistory(data: Array<Object>): Promise

Parameters

data (Array<Object>) the transaction data which should be added

Name	Description
data[].uid `string`	the uid from the owner of the transaction
data[].change `number`	the value of how much the balance changed
data[].date `number`	the date as Date.now() format
data[].reason `string`	the reason text (max 255 chars)

Returns

Promise: returns a Promise which resolves on success

▸ setBalance(data)

Sets the balance of multiple uids to the given value

setBalance(data: Array<Object>): Promise

Parameters

data (Array<Object>) an array of objects

Name	Description
data[].uid `string`	the uid of the client
data[].balance `string`	the balance which should get saved

Returns

Promise: returns a Promise which resolves on success

▸ updateNicks(list)

Updates the nicknames and uid map

updateNicks(list: object): Promise

Parameters

list (object) a list of uids as key and their nickname as value which should get updated and stored

Returns

Promise: returns a Promise which resolves on success

▸ getNicknames(uids)

retrieves multiple nicknames from cache

getNicknames(uids: array): Promise

Parameters

uids (array) a list of uids which should get resolved

Returns

Promise: returns a promise which resolves with the found nicknames, returns the uid if no nickname has been found

▸ getAllNicknames()

Retrieves the transaction history of an uid

getAllNicknames(): Promise

Returns

Promise: returns a Promise which resolves to an object with the uids as key and the transaction array as value

▸ getTopList(offset, limit)

Retrieves the toplist of uids sorted by their balance

getTopList(offset: number, limit: number): Promise

Parameters

offset

(number
            = 0)

the offset from where the first user should be display

limit

(number
            = 10)

the amount of users which should be retrieved

Returns

Promise: returns a Promise which resolves to a sorted array of objects with uid and the balance amount

Exports

These Functions gets exported as object when imported through require("MultiConomy")

getCurrencySign

Retrieves the currency sign

getCurrencySign(): string

Returns

string: returns the set currency sign

getCurrencyName

Retrieves the currency name

getCurrencyName(): string

Returns

string: returns the currency name

getWallet

Retrieves a wallet from a client BEWARE, never cache the wallet on your side, always request a new wallet

getWallet(client: (client | string)): Promise

Parameters

client ((client | string)) takes a Sinusbot Client Object or uid which should be looked up

Returns

Promise: returns a Promise object which resolves to the wallet

getBalance

Retrieves the amount of money a client has

getBalance(client: (client | string)): Promise

Parameters

client ((client | string)) takes a Sinusbot Client Object or uid which should be looked up

Returns

Promise: returns a Promise object which returns the amount of money a client has

getBalances

Retrieves the amount of money multiple clients have

getBalances(clients: (Array<client> | Array<string>)): Promise

Parameters

clients ((Array<client> | Array<string>)) takes a mix of Sinusbot Clients and uids which should be looked up

Returns

Promise: returns a Promise object with an object of all client uids, nickname and their balance

getTopList

Retrieves the toplist of uids sorted by their balance

getTopList(offset: number, limit: number): Promise

Parameters

offset

(number
            = 0)

the offset from where the first user should be display

limit

(number
            = 10)

the amount of users which should be retrieved

Returns

Promise: returns a Promise which resolves to an array of objects with uid and the balance amount