@nft-blender/waxjs
v1.0.2
Published
Javascript API for integration with the WAX Cloud Wallet.
Downloads
6
Readme
waxjs
Javascript API for integration with the WAX Cloud Wallet.
Documentation
Check the WAX developer portal for full instructions
Installation
Browser
Grab the waxjs.js minified bundle in the dist-web folder of this repo, or build it yourself (see below). Check the demo code to see how to use it.
NPM
npm install @waxio/waxjs
YARN
yarn add @waxio/waxjs
Usage
0. Import (for NPM and Yarn installations)
React style apps using npm or yarn can import the library via:
import * as waxjs from "@waxio/waxjs/dist";
1. Instantiate
Instantiate the waxjs object with the WAX RPC server you wish to connect to.
const wax = new waxjs.WaxJS({
rpcEndpoint: 'https://wax.greymass.com'
});
The library can also be instantiated with the user account and the public keys. Due to the library contains the user information, the login step can be avoided.
const wax = new waxjs.WaxJS({
rpcEndpoint: 'https://wax.greymass.com',
userAccount: 'user1',
pubKeys: ['EOS7rC8jFvFrPYDqp3Nh3HdRfL79h11B1JhPEXy85enF5wwYzF3Hk']
});
If you want to handle the auto-login on your side with the isAutoLoginAvailable
function (to avoid waiting for the user to click a button), you can disable the auto-login function in the constructor (so it won't get called twice).
const wax = new waxjs.WaxJS({
rpcEndpoint: 'https://wax.greymass.com',
tryAutoLogin: false
});
2. Login
Log your user in so as to access their wax account name for creating transactions.
const userAccount = await wax.login();
Successful login will return the userAccount. It will also be available as the userAccount
member on the wax
instance. You can now use the eosjs api
member...
3. Use the eosjs Objects As Usual
Utilize the eosjs api
and rpc
members available on the wax
instance. They are instances of the regular eosjs objects, Api, and JsonRpc, so you can do anything with them that eosjs already provides. Check the eosjs docs and repo for more info.
The api method will not be initialized until you login your user, and remember that the user's account name is available as the userAccount
member on the wax
instance.
const result = await wax.api.transact({
actions: [{
account: 'eosio.token',
name: 'transfer',
authorization: [{
actor: wax.userAccount,
permission: 'active',
}],
data: {
from: wax.userAccount,
to: 'eosio',
quantity: '0.00000001 WAX',
memo: '',
},
}]
}, {
blocksBehind: 3,
expireSeconds: 1200,
});
Constructor Options
- rpcEndpoint: The WAX public node API endpoint URL you wish to connect to. Required
- tryAutoLogin: Always attempt to autologin when your dapp starts up. Default true
- userAccount: User account to start up with. Optional
- pubKeys: Public keys for the userAccount manually specified above. Optional.
- apiSigner: Custom signing logic. Note that free bandwidth will not be provided to custom signers. Default Optional
- eosApiArgs: Custom eosjs constructor arguments to use when instantiating eosjs. Optional
- freeBandwidth: Request bandwidth management from WAX. Default true
- verifyTx: Verification function that you can override to confirm that your transactions received from WAX are only modified with bandwidth management actions, and that your transaction is otherwise unaltered. The function signature is
(userAccount: string, originalTx: any, augmentedTx: any) => void
. WhereuserAccount
is the account being signed for,originalTx
is the tx generated by your dapp, andaugmentedTx
is the potentially bandwidth-managed altered tx you will receive from WAX. The default verifier does this for you, and you should check this to be confident that the verifier is sufficiently rigorous. Optional
Free Bandwidth
So long as waxjs is initialized with freeBandwidth = true
(this is the default), your dapp will take advantage of freebandwidth provided by WAX, up to 5ms of CPU and 5K words per user per 24 hours, and tentatively 50s per contract per 24 hrs.
Dapps that require more bandwidth will be able to register their own bandwidth via the bandwidth registration contract. More info on registering for extra bandwidth management can be found here.
Development
Generate docs
npm run docs
Run the demo
npm run serve
Run tests
Note - run the demo app first (as above), and then run the tests suite:
npm run test
Build lib
npm run build
Build for web
npm run build-web
Contributing
When making a pull request, please make sure to run npm run prettier
to make sure your code is as formatted as possible. Also, make sure npm run lint
runs without errors, since that is the final check before a new version is published to npm.