Lamden Vault Controller API 🔗︎
walletController.js 🔗︎
constructor([connectionRequest]) 🔗︎
Lamden Vault Controller Class
This Class interfaces with the Lamden Vault's content script. It provides helper methods for creating a connection, getting wallet info, sending transactions and retrieving tx information.
The connection information for your Dapp can be supplied now or later by calling "sendConnection" manually.
IMPORTANT: The window object needs to be available when creating this instance as it will attempt to create listeners.
Parameters 🔗︎
Name | Type | Description | |
---|---|---|---|
connectionRequest | Object |
A connection request object | Optional |
connectionRequest.appName | string |
The name of your dApp | |
connectionRequest.version | string |
Connection version. Older version will be over-written in the users's wallet. | |
connectionRequest.contractName | string |
The smart contract your Dapp will transact to | |
connectionRequest.networkType | string |
Which Lamden network the approval is for (mainnet or testnet) are the only options | |
connectionRequest.networkName | string |
Should always be 'arko' | |
connectionRequest.logo | string |
The relative path of an image on your webserver to use as a logo for your Lamden Vault Linked Account | |
connectionRequest.background | string |
The relative path of an image on your webserver to use as a background for your Lamden Vault Linked Account | Optional |
connectionRequest.charms.name | string |
Charm name | Optional |
connectionRequest.charms.variableName | string |
Smart contract variable to pull data from | Optional |
connectionRequest.charms.key | string |
Key associated to the value you want to lookup | Optional |
connectionRequest.charms.formatAs | string |
What format the data is | Optional |
connectionRequest.charms.iconPath | string |
An icon to display along with your charm | Optional |
Returns 🔗︎
WalletController
getInfo() 🔗︎
Creates a "lamdenWalletGetInfo" CustomEvent to ask the Lamden Vault for the current information. This will fire the "newInfo" events.on event
walletIsInstalled() 🔗︎
Check if the Lamden Vault extension is installed in the user's browser.
This will fire the "newInfo" events.on event
Returns 🔗︎
Promise
Wallet is Installed.
sendConnection([connectionRequest]) 🔗︎
Send a connection to the Lamden Vault for approval. If the connectionRequest object wasn't supplied to the constructor then it must be supplied here.
This will fire the "newInfo" events.on event
Parameters 🔗︎
Name | Type | Description | |
---|---|---|---|
connectionRequest | Object |
A connection request object | Optional |
connectionRequest.appName | string |
The name of your dApp | |
connectionRequest.version | string |
Connection version. Older version will be over-written in the users's wallet. | |
connectionRequest.contractName | string |
The smart contract your dApp will transact through | |
connectionRequest.networkType | string |
Which Lamden network the approval is for (Mainnet or testnet) | |
connectionRequest.networkName | string |
Blank is Legacy Lamden, 'arko' for new Arko network | |
connectionRequest.background | string |
A relative path to an image to override the default Lamden Vault account background | Optional |
connectionRequest.logo | string |
A relative path to an image to use as a logo in the Lamden Vault | |
connectionRequest.charms.name | string |
Charm name | Optional |
connectionRequest.charms.variableName | string |
Smart contract variable to pull data from | Optional |
connectionRequest.charms.key | string |
Key associated to the value you want to lookup | Optional |
connectionRequest.charms.formatAs | string |
What format the data is | Optional |
connectionRequest.charms.iconPath | string |
An icon to display along with your charm | Optional |
Returns 🔗︎
Promise
The User's Lamden Vault Account details or errors from the wallet
sendTransaction(tx[, callback]) 🔗︎
Creates a "lamdenWalletSendTx" event to send a transaction request to the Lamden Vault.
If a callback is specified here then it will be called with the transaction result.
This will fire the "txStatus" events.on event
Parameters 🔗︎
Name | Type | Description | |
---|---|---|---|
tx | Object |
A connection request object | |
tx.networkType | string |
Which Lamden network the tx is for (Mainnet or testnet) | |
tx.networkName | string |
Blank is Legacy Lamden, 'arko' for new Arko network, other name for custom network | |
tx.stampLimit | string |
The max Stamps this tx is allowed to use. Cannot be more but can be less. | |
tx.methodName | string |
The method on your approved smart contract to call | |
tx.kwargs | Object |
A keyword object to supply arguments to your method | |
callback | Function |
A function that will called and passed the tx results. | Optional |
constructor(connectionRequest) 🔗︎
Wallet Connection Request Class Validates and stores the information from a connectionRequest object. See WalletController constructor for connection request params.
Parameters 🔗︎
Name | Type | Description | |
---|---|---|---|
connectionRequest | Object |
- request object |
Returns 🔗︎
WalletConnectionRequest
getInfo() 🔗︎
Get a JSON string of the approval request information
Returns 🔗︎
string
- JSON string of all request information