massa-web3

Massa-web3 is a TypeScript library that allow you to interact with the Massa blockchain through a local or remote Massa node. In particular the massa-web3 library will allow you to call the JSON-RPC API, but also to fetch and poll events from smart contracts on the Massa blockchain, deploy smart contracts and much more.

Usage

Massa-web3 could be used as a library for frameworks or as a stand-alone bundled js file which can be easily loaded into the browser.

Library (Node.js/React/Vue.js) usage

npm install @massalabs/massa-web3

Browser usage

Add the following script to your html file:

<script type='text/javascript' src="https://cdn.jsdelivr.net/npm/@massalabs/massa-web3@x.x.x/bundle.js"></script>

whereby the x.x.x is one of the available released versions under Massa-web3's releases page:

In your code, once the script is fully loaded, just use window.massa to access all massa-web3 exports.

<script>
    console.log("Massa Web3 ", window.massa);
</script>

Requirements

NodeJS 14+
npm / yarn (see package.json)

Web3 Client initialization

There are two types of client initialization. The first one is connecting to Massa's public rpc node using a so-called default client. Please note that specifying a base account is only optional at this point. The code below illustrates how to do that:

import {
    ClientFactory,
    Client,
    DefaultProviderUrls,
    IAccount,
    IProvider,
    ProviderType 
} from "@massalabs/massa-web3";

// create a base account for signing transactions
const baseAccount = {
  address: 'A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1',
  secretKey: 'S12tw4YShWtjWfy7YBQ9Erbcg6DYgWnMgb5hGjn9hAKGtgrLNa7L',
  publicKey: 'P1hG8zRRJF2v3qkwyZ2fnHJeaVw9uT4huCkwcWJVvgypEz6D2aR'
} as IAccount;

// initialize a testnet client
const testnetClient: Client = await ClientFactory.createDefaultClient(
    DefaultProviderUrls.TESTNET,
    true,
    baseAccount
);

The second way is to create a custom client connecting to a node whose ip and ports are to be specified by the user.

import {
    ClientFactory,
    Client,
    DefaultProviderUrls,
    IAccount,
    IProvider,
    ProviderType 
} from "@massalabs/massa-web3";

// create a base account for signing transactions
const baseAccount = {
  address: 'A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1',
  secretKey: 'S12tw4YShWtjWfy7YBQ9Erbcg6DYgWnMgb5hGjn9hAKGtgrLNa7L',
  publicKey: 'P1hG8zRRJF2v3qkwyZ2fnHJeaVw9uT4huCkwcWJVvgypEz6D2aR'
} as IAccount;

// initialize a custom client using an own provider
const providers: Array<IProvider> = [
    {
        url: "http://127.0.0.1:33035",
        type: ProviderType.PUBLIC
    } as IProvider,
    {
        url: "http://127.0.0.1:33034",
        type: ProviderType.PRIVATE
    } as IProvider
];

const customClient: Client = await ClientFactory.createCustomClient(
    providers,
    baseAccount
);

Please note that connecting to a locally running node could be easily done using the factory method:

const testnetClient: Client = await ClientFactory.createDefaultClient(
    DefaultProviderUrls.LOCALNET,
    true,
    baseAccount
);

Once there is an initialized client instance, it is straightforward to call methods on it:

import { IStatus, IAddressInfo } from "@massalabs/massa-web3";

const addressesResp: Array<IAddressInfo> = await web3Client
    .publicApi()
    .getAddresses(["some_address"]);

Client exposed APIs

The client exposes several APIs which could be used on its own (also initialized as stand-alone) if one needs to:

web3Client.publicApi()      -> sub-client for public api                    (interface: PublicApiClient)
web3Client.privateApi()     -> sub-client for private api                   (interface: PrivateApiClient)
web3Client.wallet()         -> sub-client for wallet-related operations     (interface: WalletClient)
web3Client.smartContracts() -> sub-client for smart contracts interaction   (interface: SmartContractsClient)
web3Client.vault()          -> sub-client for vault interaction [mainly used by massa-wallet] (interface: VaultClient)

Client public API

Client public API operations are accessible under the public sub-client, which is accessible via the publicApi() method on the client.

Example:

// get block info
const blocks: Array<IBlockInfo> = await web3Client
    .publicApi()
    .getBlocks(["q2XVw4HrRfwtX8FGXak2VwtTNkBvYtLVW67s8pTCVPdEEeG6J"]);

Available methods are:

getNodeStatus

const nodeStatus: INodeStatus = await web3Client
    .publicApi()
    .getNodeStatus();

getAddresses

const addressesResp: Array<IAddressInfo> = await web3Client
    .publicApi()
    .getAddresses(["A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1"]);

getBlocks

const blocks: Array<IBlockInfo> = await web3Client
    .publicApi()
    .getBlocks(["nKifcnGbd9zu8nu1hb94XEmMGwgoWbjj3DutzrobeHDdUtEuM"]);

getEndorsements

const endorsements: Array<IEndorsement> = await web3Client
    .publicApi()
    .getEndorsements(["q2XVw4HrRfwtX8FGXak2VwtTNkBvYtLVW67s8pTCVPdEEeG6J"]);

getOperations

const operations: Array<IOperationData> = await web3Client
    .publicApi()
    .getOperations(["z1cNsWAdgvoASq5RnN6MRbqqo634RRJbgwV9n3jNx3rQrQKTt"]);

getCliques

const cliques: Array<IClique> = await web3Client.publicApi().getCliques();

getStakers

const stakers: Array<IStakingAddresses> = await web3Client
    .publicApi()
    .getStakers();

getDatastoreEntries

const datastoreEntries: Array<IContractStorageData> = await web3Client
    .publicApi()
    .getDatastoreEntries([{ address: smartContractAddress, key: "some_key" } as IDatastoreEntry]);

getBlockcliqueBlockBySlot

const blockcliqueBlockBySlot: IBlockcliqueBlockBySlot = await web3Client
    .publicApi()
    .getBlockcliqueBlockBySlot([{ period: 12345, thread: 20 } as ISlot]);

getGraphInterval

const graphInterval: IGraphInterval = await web3Client
    .publicApi()
    .getGraphInterval([{ start: Date.now() - 2000, end: Date.now() } as IGetGraphInterval]);

Client private API

Client private API operations are accessible under the private sub-client, which is accessible via the privateApi() method on the client.

Example:

// stop the node
await web3Client.privateApi().nodeStop();

Available methods are:

stopNode

await web3Client.privateApi().nodeStop();

nodeBanById

await web3Client.privateApi().nodeBanById("P1bZhWZQ2KW8DoaEqXyRXoy198wjhCsTFxSP53mLgdvx5C4WMDE");

nodeBanByIpAddress

await web3Client.privateApi().nodeBanByIpAddress("90.110.239.231");

nodeUnbanById

await web3Client.privateApi().nodeUnbanById("P1bZhWZQ2KW8DoaEqXyRXoy198wjhCsTFxSP53mLgdvx5C4WMDE");

nodeUnbanByIpAddress

await web3Client.privateApi().nodeUnbanByIpAddress("90.110.239.231");

nodeGetStakingAddresses

const stakingAddresses = await web3Client
    .privateApi()
    .nodeGetStakingAddresses();

nodeRemoveStakingAddresses

await web3Client
    .privateApi()
    .nodeRemoveStakingAddresses([
        "A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1",
    ]);

nodeAddStakingPrivateKeys

await web3Client
    .privateApi()
    .nodeAddStakingSecretKeys([
        "S12tw4YShWtjWfy7YBQ9Erbcg6DYgWnMgb5hGjn9hAKGtgrLNa7L",
    ]);

nodeSignMessage

const message = "hello world";
const msgBuf = new TextEncoder().encode(message);
const signedMessage = await web3Client.privateApi().nodeSignMessage(msgBuf);

nodeWhitelist

await web3Client.privateApi().nodeWhitelist("90.110.239.231");

nodeRemoveFromWhitelist

await web3Client.privateApi().nodeRemoveFromWhitelist("90.110.239.231");

Wallet operations

Wallet operations are accessible under the wallet sub-client which is accessible via the wallet() method on the client.

Example:

// generate new wallet
const newWalletAccount = await web3Client.wallet().walletGenerateNewAccount();

Available class methods are:

addPrivateKeysToWallet

const addedAccounts: Array<IAccount> = await web3Client
    .wallet()
    .addSecretKeysToWallet([
        "2SPTTLK6Vgk5zmZEkokqC3wgpKgKpyV5Pu3uncEGawoGyd4yzC",
    ]);

removeAddressesFromWallet

web3Client
    .wallet()
    .removeAddressesFromWallet([
        "A12rr1neHvp7uzGepfPRPguZX5JWC3EFW6H7ZQRazzNjBRMNvQB",
    ]);

getWalletAccounts

const walletAccounts: Array<IAccount> = web3Client.wallet().getWalletAccounts();

getWalletAccountByAddress

const walletAccount: IAccount | undefined = web3Client
    .wallet()
    .getWalletAccountByAddress(
        "A12rr1neHvp7uzGepfPRPguZX5JWC3EFW6H7ZQRazzNjBRMNvQB"
    );

addAccountsToWallet

await web3Client.wallet().addAccountsToWallet([
    {
        address: 'A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1',
        secretKey: 'S12tw4YShWtjWfy7YBQ9Erbcg6DYgWnMgb5hGjn9hAKGtgrLNa7L',
        publicKey: 'P1hG8zRRJF2v3qkwyZ2fnHJeaVw9uT4huCkwcWJVvgypEz6D2aR'
    },
]);

walletInfo

const walletInfo: Array<IFullAddressInfo> = await web3Client
    .wallet()
    .walletInfo();

sendTransaction

const sendTxIds: Array<string> = await web3Client.wallet().sendTransaction(
    {
        fee: 0, // int
        amount: "1", //MAS
        recipientAddress:
            "A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1",
    } as ITransactionData,
    baseAccount
);

buyRolls

const buyRollsIds: Array<string> = await web3Client.wallet().buyRolls(
    {
        fee: 0, // int
        amount: 1, //ROLLS
    } as IRollsData,
    baseAccount
);

sellRolls

const sellRollsIds: Array<string> = await web3Client.wallet().sellRolls(
    {
        fee: 0, // int
        amount: 1, //ROLLS
    } as IRollsData,
    baseAccount
);

getAccountBalance

const balance: IBalance = await web3Client.wallet().getAccountBalance("A12PWTzCKkkE9P5Supt3Fkb4QVZ3cdfB281TGaup7Nv1DY12a6F1");

In addition to the class methods, there are also static methods for direct use:

getAccountFromPrivateKey

const account: IAccount = await WalletClient.getAccountFromSecretKey("S12tw4YShWtjWfy7YBQ9Erbcg6DYgWnMgb5hGjn9hAKGtgrLNa7L");

walletGenerateNewAccount

const newWalletAccount: IAccount = await WalletClient.walletGenerateNewAccount();

walletSignMessage

const sig: ISignature = await WalletClient.walletSignMessage("hello", baseAccount);

Smart contract deployment

Once the smart contract WASM is available, it becomes quite straightforward to deploy a smart contract operation (a state changing operation):

// deploy smart contract
const opIds = await web3Client.smartContracts().deploySmartContract(
    {
        fee: 0,
        maxGas: 2000000,
        coins: 0,
        contractDataBinary: compiledScFromSource.binary,
    } as IContractData,
    baseAccount
);

The compiledScFromSource is the compiled smart contract code in binary form.

Smart contract event fetching and polling

Emitted smart contract events could directly be fetched via:

const eventsFilter = {
    start: null,
    end: null,
    original_caller_address:
        "A12rr1neHvp7uzGepfPRPguZX5JWC3EFW6H7ZQRazzNjBRMNvQB",
    original_operation_id: null,
    emitter_address: null,
} as IEventFilter;

const filteredEvents: Array<IEvent> = await web3Client.smartContracts().getFilteredScOutputEvents(eventFilterData);

Events could also be polled. Th 57AE e js sdk has two methods for doing this as shown below. In both, a filter, a web3 client and a poll interval which we can set in order to poll the events needs to be provided:

const onEventData = (events: Array<IEvent>) => {console.log("Event Data Received:" , events);}
const onEventDataError = (error: Error) => {console.log("Event Data Error:" , error);}

// poll smart contract events
const eventsFilter = {
    start: null,
    end: null,
    original_caller_address: "A12rr1neHvp7uzGepfPRPguZX5JWC3EFW6H7ZQRazzNjBRMNvQB",
    original_operation_id: null,
    emitter_address: null,
    is_final: null,
} as IEventFilter;

const eventPoller = EventPoller.startEventsPolling(
    eventsFilter,
    1000,
    web3Client
);
eventPoller.on(ON_MASSA_EVENT_DATA, onEventData);
eventPoller.on(ON_MASSA_EVENT_ERROR, onEventDataError);

//...do some work...

// cleanup and finish
eventPoller.stopPolling();

Alternatively, one could make direct use of callback functions as function arguments which would fire on event data received or generated errors:

const onEventData = (events: Array<IEvent>) => {console.log("Event Data Received:" , events);}
const onEventDataError = (error: Error) => {console.log("Event Data Error:" , error);}

const eventPoller: EventPoller = EventPoller.startEventsPolling(
    eventsFilter,
    1000,
    web3Client,
    onEventData,
    onEventDataError);

//...do some work...

// cleanup and finish
eventPoller.stopPolling();

The latter could easily be employed in smart contracts where we need to e.g. get the contract address. For example, this contract would emit the address at creation:

import { call, print, create_sc, generate_event } from "massa-sc-std";

export function main(_args: string): i32 {
    const sc_address = createContract();
    call(sc_address, "initialize", "", 0);
    print("Initialized, address:" + sc_address);
    generateEvent(`Address:${sc_address}`); //emit an event with the address
    ...
}

Smart contract blockchain status

Smart contracts undergo various transaction statuses before they reach block finality on chain. The public enum describing these statuses is:

EOperationStatus {
	INCLUDED_PENDING,
	AWAITING_INCLUSION,
	FINAL,
	INCONSISTENT,
	NOT_FOUND
}

The current smart contract status could be easily obtained via:

const status: EOperationStatus = await web3Client.smartContracts().getOperationStatus(deploymentOperationId);

There are however cases when one would require to await a given status and that could be done via. It is important to note here that the algorithm will giv up after a certain amount of time or a limited error count. These values have proven to be sufficient for most standard cases.

const status: EOperationStatus = await web3Client.smartContracts().awaitRequiredOperationStatus(deploymentOperationId, EOperationStatus.INCLUDED_PENDING);

Smart contract balance

Smart contract balances could be easily obtained via using the getContractBalance method:

const balance: IBalance|null = await web3Client.smartContracts().getContractBalance(contractAddress);

Smart contract read and write calls

Smart contract data could be read via readSmartContract method:

const data: Array<IContractReadOperationData> = await web3Client.smartContracts().readSmartContract({
            fee: 0,
            maxGas: 200000,
            targetAddress: scAddress,
            targetFunction: "getGameState",
            parameter: "some_stringified_data",
            callerAddress: baseAccount.address
        } as IReadData);

Please note that this method would currently only return data which is emitted as an event e.g. generateEvent(...). The returned event data is contained in an object of type IContractReadOperationData under the data key!

Smart contract state-changing operations could be executed via callSmartContract method:

const data: Array<string> = await web3Client.smartContracts().callSmartContract({
            fee: 0,
            maxGas: 200000,
            coins: 0,
            targetAddress: scAddress,
            functionName: "play",
            parameter: JSON.stringify({index : 1}),
        } as ICallData, baseAccount);

Smart contracts could also be constructed in order to read data from another contract. In that case one could use the code below to read the data via a proxy contract:

// read smart contract data
const data: Array<IExecuteReadOnlyResponse> = await web3Client.smartContracts().executeReadOnlySmartContract(
    {
        fee: 0,
        maxGas: 2000000,
        coins: 0,
        contractDataBinary: compiledScFromSource.binary,
    } as IContractData,
    baseAccount
);

Contributing and testing

Run yarn install to install all deps
Run yarn run build to build distribution content
Run yarn run test to run integration and unit tests

Name		Name	Last commit message	Last commit date
Latest commit History 250 Commits
.github/workflows		.github/workflows
examples		examples
src		src
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmignore		.npmignore
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
tslint.json		tslint.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

massa-web3

Usage

Library (Node.js/React/Vue.js) usage

Browser usage

Requirements

Web3 Client initialization

Client exposed APIs

Client public API

Client private API

Wallet operations

Smart contract deployment

Smart contract event fetching and polling

Smart contract blockchain status

Smart contract balance

Smart contract read and write calls

Contributing and testing

About

Uh oh!

Releases

Packages

Languages

T1l3/massa-web3

Folders and files

Latest commit

History

Repository files navigation

massa-web3

Usage

Library (Node.js/React/Vue.js) usage

Browser usage

Requirements

Web3 Client initialization

Client exposed APIs

Client public API

Client private API

Wallet operations

Smart contract deployment

Smart contract event fetching and polling

Smart contract blockchain status

Smart contract balance

Smart contract read and write calls

Contributing and testing

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages