This package has been deprecated

Author message:

Deprecated library, use dcorejs-sdk instead

dcorejs

Quick look into DECENT

The new way of publishing

Our intention is to revolutionize digital distribution across the Internet.

DCore Network is a content distribution platform that is decentralized, open-source and uses Blockchain technology. Blockchain technology guarantees trust and security by embedding encryption at the lowest level. Perhaps the greatest benefit of this implementation of blockchain technology is invariant storage for published content which can eliminate manipulation and influence by any sort of middleman (eg. publisher). In short content can now be created and delivered directly with any fees collected solely by the seller at the point of sale. In addition to the technological side, there are the economical and social protocols that will govern real-world interactions across the network. In order to make transactions viable and user friendly a crypto-token, the DCT, has been implemented. The encrypted DCT tokens help mitigate attacks, promote funding and ensure transaction validation. One last thing of note, unlike other content distribution platforms underdevelopment, there are virtually no limitations as to the type of media that can be published on Dcore Network. It could be songs, books, articles, videos, source code, or anything really and in almost any format.

dcorejs

Javascript library for browser and node.js to work with Dcore blockchain network. Supported browsers versions:

• Chrome - > 54
• Firefox - > 58
• Safari - > 11
• Edge - > 41

Quick start

Installation

1. Install Node.js >6 and npm >3 globally

2. For Windows you need to install node-gyp build tool.

3. Change directory to project root dir

4. Install npm install dcorejs

### Customization

In case you want to customize library and generate documentation for code use command npm run generate-docs. Documentation will be generated in ./dist/docs folder.

Initialize library

Server

import * as dcorejs from 'dcorejs';
 
const config = {
    dcoreNetworkWSPaths: ['wss://your.dcore.daemon:8090'],
    chainId: 'your-dcore-chain-id'
};
 
dcorejs.initialize(config);

NOTE: If running server from localhost add NODE_TLS_REJECT_UNAUTHORIZED=0 before library initialization.

If you want debug logs during development, before running your application set ENVIRONMENT variable to DEV. For websocket debug logs set WS_ENV variable to DEV.

Browser

    <script src="./dcorejs.umd.js" type="text/javascript"></script> 
    <script type="text/javascript">
        var testConnection = false;
        var chainId = 'your-dcore-chain-id';
        var dcoreNetworkAddresses = ['wss://your.dcore.daemon:8090'];
        
        dcorejs.initialize(
            {
                chainId: chainId, 
                dcoreNetworkWSPaths: dcoreNetworkAddresses
            }, 
            testConnection);
    </script> 

NOTE: Use testConnection = false if CORS problem appear.

Replace dcoreNetworkWSPaths with active dcore daemon instance and chainId with blockchain id which you are about to work on.

Usage

Once dcore lib is initialized, you can access methods using dcorejs with any of submodule - account(), asset(), content(), explorer(), messaging(), mining(), proposal(), seeding() or subscription()

Connection control

Library dcorejs offer methods to control connection.

import * as dcorejs from 'dcorejs';
 
const connection = dcorejs.connection();
 
// ...
 
connection.closeConnection();
 
// ...
 
connection.openConnection()
    .then(res => {
        // connection opened, connection.isConnected === true
    })

Create account

There is two ways how to create account in DCore network: Account.registerAccount and Account.createAccountWithBrainkey.
Recomended way to create account is using Account.registerAccount method, because there is option to set keys to be different. Also can use Account.createAccountWithBrainkey, but keys generated from brainkey for ownerKey, activeKey and memoKey will be the same, which is not recommended for security reasons.

import * as dcorejs from 'dcorejs';
import { KeyPrivate, KeyPublic, Utils } from 'dcorejs';
 
let sequenceNumber = 0;
const brainKey = dcorejs.account().suggestBrainKey();
// owner key is generated with sequenceNumber = 0
const [, publicOwnerKey]: [KeyPrivate, KeyPublic] = Utils.generateKeys(brainKey);
const privateActiveKey: KeyPrivate = Utils.derivePrivateKey(brainKey, sequenceNumber + 1);
const privateMemoKey: KeyPrivate = Utils.derivePrivateKey(brainKey, sequenceNumber + 2);
const registrarPrivateKey = '5KcA6ky4Hs9VoDUSdTF4o3a2QDgiiG5gkpLLysRWR8dy6EAgTni';
 
const publicActiveKey: KeyPublic = KeyPublic.fromPrivateKey(privateActiveKey)
const publicMemoKey: KeyPublic = KeyPublic.fromPrivateKey(privateMemoKey)
 
const accountId = '1.1.1'
 
dcorejs.account().registerAccount(
    'myNewAccountName',
    publicOwnerKey.stringKey,
    publicActiveKey.stringKey,
    publicMemoKey.stringKey,
    accountId,
    registrarPrivateKey)
    .then(res => {
        // account_create transaction was successfully broadcasted
    })
    .catch(err => {
        // error broadcasting transaction
    });

NOTE: Make sure, that sequenceNumber you generating keys with, was not used for generating keys for your accounts in past.

Submit content

import * as dcorejs from 'dcorejs';
 
const privateKey = '5KcA6ky4Hs9VoDUSdTF4o3a2QDgiiG5gkpLLysRWR8dy6EAgTni';
dcorejs.content().generateContentKeys(seederIds)
    .then((contentKeys: dcorejs.ContentKeys) => {
        const submitObject: SubmitObject = {
            authorId: "1.2.345",
            coAuthors: [["1.2.456", 1000]],
            seeders: [],
            fileName: "wallet-export.json",
            date: "2018-09-30T22:00:00.000Z",
            price: 134,
            size: 2386,
            URI: "http://test.uri.com",
            hash: "014abb5fcbb2db96baf317f2f039e736c95a5269",
            keyParts: [],
            synopsis: {
                title: "Foo book",
                description: "This book is about Fooing",
                content_type_id: "1.3.6.0"
            },
            assetId: "1.3.0",
            publishingFeeAsset: "1.3.0"
        };
        dcorejs.content().addContent(submitObject, privateKey)
            .then(res => {
                // content successfully submitted
            })
            .catch(err => {
                // error occured during content submition
            })
    })
    .catch(err => {
        // error occured during content uploading
    })

Example shown above is for case when content is already uploaded to seeders using DCore IPFS node. It is also possible to submit content uploaded to different storage (e.g. CDN). Then omit parameters seeders and keyParts, and use empty arrays instead.

Note following:

• Each newly submitted content must have unique URI.

• If submitting content with same URI, then parameters hash, author, date, seeders and keyParts must stay same. All other data are updated.

• Hash needs to be RIPEMD-160, and can be generated using dcorejs.Utils.ripemdHash() method

• Synopsis need to contain at least parameters title, description and content_type_id. content_type_id is composed of '<app_id>.<category>.<sub_category>.<is_adult_content>', for example 1.1.2.0.

Search content

import * as dcorejs from 'dcorejs';
 
const term = 'some phrase';
const order = dcorejs.SearchParamsOrder.createdDesc;
const user = '1.2.345';
const region_code = 'en';
const itemId = '0.0.0';
const category = '1';
const count = 4;
 
const searchParams: dcorejs.SearchParams = {
    term, 
    order,
    user, 
    region_code, 
    itemId, 
    category, 
    count 
}
 
dcorejs.content().searchContent(searchParams)
    .then((contents: dcorejs.Content[]) => {
        // process found content
    })
    .catch(err => {
        // handle error
    });

Replace all variables with your values to get requested content. Search browser example

Buy content

import * as dcorejs from 'dcorejs';
 
const contentId = '2.13.54';
const accountId = '1.2.45';
const privateKey = 'ac7b6876b8a7b68a7c6b8a7c6b8a7cb68a7cb78a6cb8';
const elGammalPublic = '704978309485720398475187405981709436818374592763459872645';
 
dcorejs.content()
    .buyContent(contentId,
                accountId,
                elGammalPublic,
                privateKey)
    .then(() => {
        // Content successfully bought
    })
    .catch(() => {
        // buy unsuccessful, handle buy error
    });

Replace variables with keys from your dcore account to buy content. Otherwise you will not be able to buy content. Private key must be in WIF(Wallet Import Format). Buy browser example

Download/Restore content

Method restoreContentKeys will restore your key generated during content submission, used to encrypt content.

import * as dcorejs from 'dcorejs';
 
const elGamalPrivate = '32983749287349872934792739472387492387492834';
const elGamalPublic = '704978309485720398475187405981709436818374592763459872645';
const elGamalKeyPair = new dcorejs.KeyPair(elGamalPrivate, elGamalPublic);
const contentId = '2.13.312';
const accountId = '1.2.345';
 
// Content key restoration
dcorejs.content().restoreContentKeys(contentId, accountId, elGamalKeyPair)
    .then(key => {
        // ... now you are able to decrypt your content
    })
    .catch(err => {
        // error restoring key
    });

Download browser example

Blockchain event handling

dcorejs.subscribe((data: any) => {
    // handle fired event
}).then(subscription => {
    // subscription object
});
 
dcorejs.subscribePendingTransaction((data: dcorejs.Block.Transaction) => {
    // handle pending transaction event
}).then(subscription => {
    // subscription object
});
 
dcorejs.subscribeBlockApplied((data: number) => {
    // handle block applied event
}).then(subscription => {
    // subscription object
});

Custom transaction

In case you want to create custom transaction, see following example. Replace 'X' values and private key for your own.

import * as dcorejs from 'dcorejs';
 
const operation = new dcorejs.TransactionOperations.AssetFundPools(
    '1.2.X',
    {
        amount: 10,
        asset_id: '1.3.X'
    },
    {
        amount: 1,
        asset_id: '1.3.0'
    }
);
const privateKey = 'yourPrivateKey';
const transactionBuilder = dcorejs.transactionBuilder();
const result = transactionBuilder.addOperation(operation);
if (result === '') {
    transactionBuilder.broadcast(privateKey)
        .then(result => {
            console.log(result);
        })
        .catch(error => {
            console.log(error);
        });
} else {
    console.error(result);
}

More examples available here. To run examples, you need to clone repository and build with npm run build if folders dist and lib is not presented. Browser bundle can be found within dist/dcorejs.umd.js. Node version in lib/dcorejs.js.

All available methods

dcorejs

subscribe(callback: ChainSubscriptionCallback)
subscribeBlockApplied(callback: ChainSubscriptionBlockAppliedCallback) 
subscribePendingTransaction(callback: ChainSubscriptionCallback) 
content(): ContentModule 
account(): AccountModule 
explorer(): ExplorerModule 
asset(): AssetModule 
mining(): MiningModule 
subscription(): SubscriptionModule 
seeding(): SeedingModule 
proposal(): ProposalModule 
messaging(): MessagingModule 
transactionBuilder(): TransactionBuilder 
connection(): ApiConnector

Content

searchContent(searchParams?: SearchParams, convertAsset: boolean = false): Promise<Content[]>
getContent(id: string, convertAsset: boolean = false): Promise<ContentObject>
getContentURI(URI: string, convertAsset: boolean = false): Promise<ContentObject | null>
removeContent(contentId: string,
        authorId: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
restoreContentKeys(contentId: string, accountId: string, ...elGamalKeys: KeyPair[]): Promise<string>
generateContentKeys(seeders: string[]): Promise<ContentKeys>
addContent(content: SubmitObject, privateKey: string, broadcast: boolean = true): Promise<Operation>
getOpenBuying(convertAsset: boolean = false): Promise<BuyingContent[]>
getOpenBuyingByURI(URI: string, convertAsset: boolean = false): Promise<BuyingContent[]>
getOpenBuyingByConsumer(accountId: string, convertAsset: boolean = false): Promise<BuyingContent[]>
getBuyingByConsumerURI(accountId: string, URI: string, convertAsset: boolean = false): Promise<BuyingContent[] | null>
getBuyingHistoryObjectsByConsumer(accountId: string, convertAsset: boolean = false): Promise<BuyingContent[]>
buyContent(contentId: string,
        buyerId: string,
        elGammalPub: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
getSeeders(resultSize: number = 100): Promise<Seeder[]>
getPurchasedContent(accountId: string,
        order: SearchParamsOrder = SearchParamsOrder.createdDesc,
        startObjectId: string = '0.0.0',
        term: string = '',
        resultSize: number = 100): Promise<Content[]>
getRating(contentId: string, forUser: string, ratingStartId: string = '', count: number = 100): Promise<Array<BuyingContent>>
searchFeedback(accountId: string, contentURI: string, ratingStartId: string, count: number = 100): Promise<Array<BuyingContent>>
getAuthorCoAuthors(URI: string): Promise<[string, string[]] | null>
leaveCommentAndRating(contentURI: string,
        consumer: string,
        comment: string,
        rating: number,
        consumerPKey: string,
        broadcast: boolean = true): Promise<Operation>
 

Account

getAccountByName(name: string): Promise<Account>
getAccountById(id: string): Promise<Account>
getTransactionHistory(accountId: string,
        privateKeys: string[] = [],
        order: SearchAccountHistoryOrder = SearchAccountHistoryOrder.timeDesc,
        startObjectId: string = '0.0.0',
        resultLimit: number = 100): Promise<TransactionRecord[]>
searchAccountHistory(accountId: string,
        privateKeys: string[] = [],
        order: SearchAccountHistoryOrder = SearchAccountHistoryOrder.timeDesc,
        startObjectId: string = '0.0.0',
        resultLimit: number = 100,
        convertAssets: boolean = false): Promise<TransactionRecord[]>
transfer(amount: number,
        assetId: string,
        fromAccount: string,
        toAccount: string,
        memo: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
getBalance(accountId: string, assetId: string = '1.3.0', convertAsset: boolean = false): Promise<number>
isTransactionConfirmed(accountId: string, transactionId: string): Promise<boolean>
getAccountHistory(accountId: string, historyOptions?: HistoryOptions): Promise<HistoryRecord[]>
searchAccounts(searchTerm: string = '',
        order: AccountOrder = AccountOrder.none,
        id: string = '0.0.0',
        limit: number = 100): Promise<Account>
getAccountCount(): Promise<number>
registerAccount(name: string,
        ownerKey: string,
        activeKey: string,
        memoKey: string,
        registrar: string,
        registrarPrivateKey: string,
        broadcast: boolean = true): Promise<Operation>
createAccountWithBrainkey(brainkey: string, 
        accountName: string,
        registrar: string,
        registrarPrivateKey: string): Promise<Operation>
listAccounts(lowerBound: string = '', limit: number = 100): Promise<AccountNameIdPair[]>
listAccountBalances(id: string, convertAssets: boolean = false): Promise<Asset[]>
searchMinerVoting(accountName: string, 
        keyword: string,
        myVotes: boolean = true,
        sort: MinerOrder = MinerOrder.none,
        fromMinerId: string = '',
        limit: number = 1000): Promise<MinerInfo[]>
updateAccount(accountId: string, params: UpdateAccountParameters, privateKey: string, broadcast: boolean = true): Promise<Operation>
searchAccountBalanceHistory(accountId: string,
        assetList: string[] = [],
        partnerId: string = null,
        fromBlockNumber: number = null,
        toBlockNumber: number = null,
        offset: number = 0,
        limit: number = 100): Promise<HistoryBalanceObject[]>
getAccountBalanceForTransaction(accountId: string, historyId: string): Promise<HistoryBalanceObject>
getTransactionById(transactionId: string): Promise<any>

Asset

listAssets(lowerBoundSymbol: string,
        limit: number = 100,
        UIAOnly: boolean = false,
        formatAssets: boolean = false): Promise<AssetObject[]>
createUserIssuedAsset(issuer: string,
        symbol: string,
        precision: number,
        description: string,
        maxSupply: number,
        baseExchangeAmount: number,
        quoteExchangeAmount: number,
        isExchangeable: boolean,
        isSupplyFixed: boolean,
        issuerPrivateKey: string,
        broadcast: boolean = true): Promise<Operation>
issueAsset(assetSymbol: string,
        amount: number,
        issueToAccount: string,
        memo: string,
        issuerPKey: string,
        broadcast: boolean = true): Promise<Operation>
updateUserIssuedAsset(symbol: string,
        newInfo: UserIssuedAssetInfo,
        issuerPKey: string,
        broadcast: boolean = true): Promise<Operation>
fundAssetPools(fromAccountId: string,
        uiaAmount: number,
        uiaSymbol: string,
        dctAmount: number,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
assetReserve(payer: string,
        symbol: string,
        amountToReserve: number,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
assetClaimFees(issuer: string,
        uiaAmount: number,
        uiaSymbol: string,
        dctAmount: number,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
getAsset(assetId: string, formatAsset: boolean = false): Promise<DCoreAssetObject>
getAssets(assetIds: string[], formatAssets: boolean = false): Promise<DCoreAssetObject[]>
priceToDCT(symbol: string, amount: number): Promise<Asset>
publishAssetFeed(publishingAccount: string,
        symbol: string,
        exchangeBaseAmount: number,
        exchangeQuoteAmount: number,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
getFeedsByMiner(minerAccountId: string, limit: number = 100): Promise<any>
getRealSupply(): Promise<RealSupply>
getMonitoredAssetData(assetId: string): Promise<MonitoredAssetOptions | null>
createMonitoredAsset(issuer: string,
        symbol: string,
        precision: number,
        description: string,
        feedLifetimeSec: number,
        minimumFeeds: number,
        issuerPrivateKey: string,
        broadcast: boolean = true): Promise<Operation>
updateMonitoredAsset(symbol: string, 
        description: string, 
        feedLifetimeSec: number,
        minimumFeeds: number, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>

Explorer

getObject(objectId: string): Promise<any>
getAccount(id: string): Promise<Account>
getAsset(id: string): Promise<Block.Asset>
getWitness(id: string): Promise<Block.Miner>
getOperationHistory(id: string): Promise<Block.Transaction>
getVestingBalance(id: string): Promise<Block.VestingBalance>
getAssetDynamicDataType(id: string): Promise<Block.AssetDynamicProperty>
getAccountBalance(id: string): Promise<Block.AccountBalance>
getAccountStatistics(id: string): Promise<Block.AccountStatistics>
getBlockSummary(id: string): Promise<Block.BlockSummary>
getAccountTransactionHistory(id: string): Promise<Block.AccountTransactionHistory>
getChainProperty(id: string): Promise<Block.ChainProperty>
getMinerSchedule(id: string): Promise<Block.MinerSchedule>
getBudgetRecord(id: string): Promise<Block.BudgetReport>
getBuying(id: string): Promise<Block.Buying>
getContent(id: string): Promise<Block.Content>
getPublisher(id: string): Promise<Block.Publisher>
getSubscription(id: string): Promise<Block.Subscription>
getSeedingStatistics(id: string): Promise<Block.SeedingStatistics>
getTransactionDetail(id: string): Promise<Block.TransactionDetail>
getBlock(id: number): Promise<Block.Block>
getBlocks(id: number, count: number): Promise<Array<Block.Block>>
getAccounts(ids: string[]): Promise<Array<Account>>
getTransaction(blockNo: number, txNum: number): Promise<Block.Transaction>
getMiners(ids: string[]): Promise<Array<Miner>>
getMiner(id: string): Promise<Miner|null>

Mining

setDesiredMinerCount(accountId: string, 
        desiredNumOfMiners: number, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
createMiner(minerAccountId: string, 
        URL: string, 
        signingPublicKey: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
unvoteMiner(miner: string, account: string, privateKeyWif: string, broadcast: boolean = true): Promise<Operation>
unvoteMiners(miners: string[], account: string, privateKeyWif: string, broadcast: boolean = true): Promise<Operation>
voteForMiner(miner: string, account: string, privateKeyWif: string, broadcast: boolean = true): Promise<Operation>
voteForMiners(miners: string[], account: string, privateKeyWif: string, broadcast: boolean = true): Promise<Operation>
voteUnvoteMiners(voteMiners: string[], 
        unvoteMiners: string[], 
        accountId: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
getVestingBalances(accountId: string): Promise<VestingBalance[]>
updateMiner(minerId: string, 
        minerAccountId: string, 
        updateData: MinerUpdateData, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
withdrawVesting(vestinBalanceId: string,
        ownerId: string,
        amount: number,
        assetId: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
setVotingProxy(accountId: string, votingAccountId: string, privateKey: string, broadcast: boolean = true): Promise<Operation>
listMiners(fromId: string, limit: number = 100): Promise<MinerNameIdPair[]>
getMiner(minerId: string): Promise<Miner>

Proposal

getProposedTransactions(accountId: string): Promise<ProposalObject[]>
proposeTransfer(proposerAccountId: string, 
        fromAccountId: string, 
        toAccountId: string, 
        amount: number, 
        assetId: string, 
        memoKey: string,
        expiration: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
proposeParameterChange(proposerAccountId: string, 
        proposalParameters: ProposalParameters, 
        expiration: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
proposeFeeChange(proposerAccountId: string, 
        feesParameters: FeesParameters, 
        expiration: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
approveProposal(payingAccountId: string, 
        proposalId: string, 
        approvalsDelta: DeltaParameters, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>

Seeding

listSeedersByPrice(limit: number = 100): Promise<Seeder[]>
listSeedersByUpload(limit: number = 100): Promise<Seeder[]>
listSeedersByRegion(region: string): Promise<Seeder[]>
listSeedersByRating(limit: number = 100): Promise<Seeder[]>

Subscription

listActiveSubscriptionsByConsumer(consumerId: string, count: number = 100): Promise<SubscriptionObject[]> {
listSubscriptionsByConsumer(consumerId: string, count: number = 100): Promise<SubscriptionObject[]> {
listActiveSubscriptionsByAuthor(authorId: string, count: number = 100): Promise<SubscriptionObject[]> {
listSubscriptionsByAuthor(authorId: string, count: number = 100): Promise<SubscriptionObject[]> {
subscribeToAuthor(from: string, 
        to: string, 
        amount: number, 
        assetId: string, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
subscribeByAuthor(from: string, to: string, privateKey: string, broadcast: boolean = true): Promise<Operation> {
setAutomaticRenewalOfSubscription(accountId: string, 
        subscriptionId: string, 
        automaticRenewal: boolean, 
        privateKey: string, 
        broadcast: boolean = true): Promise<Operation>
setSubscription(accountId: string, 
        options: SubscriptionOptions,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>

Messaging

getSentMessages(sender: string, decryptPrivateKey: string = '', count: number = 100): Promise<IDCoreMessagePayload[]>
getMessages(receiver: string, decryptPrivateKey: string = '', count: number = 100): Promise<IDCoreMessagePayload[]>
getMessageObjects(sender: string = '',
sendMessage(sender: string,
        receiverId: string,
        message: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>
sendUnencryptedMessage(sender: string,
        receiverId: string,
        message: string,
        privateKey: string,
        broadcast: boolean = true): Promise<Operation>

Utils

formatToReadiblePrice(dctAmount: number): string
formatAmountForDCTAsset(amount: number): number
formatAmountForAsset(amount: number, asset: DCoreAssetObject): number
formatAmountToAsset(amount: number, asset: DCoreAssetObject): number
ripemdHash(fromBuffer: string): string
generateKeys(fromBrainKey: string): [KeyPrivate, KeyPublic]
getPublicKey(privateKey: string): KeyPublic
privateKeyFromWif(pkWif: string): KeyPrivate
publicKeyFromString(pubKeyString: string): KeyPublic
suggestBrainKey(): string
getBrainKeyInfo(brainKey: string): BrainKeyInfo
normalize(brainKey: string): string
generateNonce(): string
elGamalPublic(elGamalPrivate: string): string
elGamalPrivate(privateKeyWif: string): string
generateElGamalKeys(privateKeyWif: string): ElGamalKeys
generateBrainKeyElGamalKey(): [BrainKeyInfo, ElGamalKeys]
derivePrivateKey(brainKey: string, sequence: number): KeyPrivate

Crypto utils

encryptWithChecksum(message: string,
        privateKey: string,
        publicKey: string,
        nonce: string = ''): string
decryptWithChecksum(message: string,
        privateKey: string,
        publicKey: string,
        nonce: string = ''): string
ripemdHash(fromBuffer: string): string
md5(message: string): string
sha512(message: string): string
sha256(message: string): string
encrypt(message: string, password: string): string
decrypt(message: string, password: string): string | null
encryptToHexString(message: string | Buffer, password: string): string
decryptHexString(message: string, password: string): string

Transaction builder

addOperation(operation: Operation): void
propose(proposalParameters: ProposalCreateParameters): void
broadcast(privateKey: string, sign: boolean = true): Promise<void>
setTransactionFees(): Promise<void>
signTransaction(privateKey: KeyPrivate): void
replaceOperation(operationIndex: number, newOperation: Operation): boolean
previewTransaction(): any