Wrapper
Last updated
Was this helpful?
Last updated
Was this helpful?
daoAddress
The address of the DAO.
options
Wrapper options. (optional, default {}
)
options.provider
any The Web3 provider to use for blockchain communication. Defaults to web3.currentProvider
if web3 is injected, otherwise will fallback to (optional)
options.apm
Options for fetching information from aragonPM
options.apm.ensRegistryAddress
The address of the ENS registry
options.apm.ipfs
IPFS options for fetching information from aragonPM (optional)
options.apm.ipfs.gateway
The IPFS gateway to use for fetching information (optional)
options.apm.ipfs.fetchTimeout
The timeout before a request to IPFS is automatically failed in milliseconds (optional, default 10s)
options.cache
Cache options (optional)
options.cache.forceLocalStorage
On browser environments, downgrade to localStorage even if IndexedDB is available (optional)
Initialise the wrapper.
Parameters
Initialise user-controlled accounts.
Parameters
Initialise the ACL.
Parameters
Get proxy metadata (appId
, address of the kernel, ...).
Parameters
Check if an object is an app.
Parameters
Initialise apps observable.
Returns void
Initialise forwarder observable.
Returns void
Initialise connected network details observable.
Run an app.
Parameters
Get the available accounts for the current user.
Calculate the transaction path for a transaction to destination
that invokes methodName
with params
.
Parameters
Calculate the transaction path for a transaction to destination
that invokes methodName
with params
.
Parameters
Modify the identity metadata for an address using the highest priority provider.
Parameters
Resolve the identity metadata for an address using the highest priority provider.
Parameters
Request an identity modification using the highest priority provider.
Parameters
Remove specific local identities.
Parameters
Search identites using the highest priority provider.
Parameters
Set the current GUI style of the client to the apps.
Parameters
Returns void.
options
An optional options object for configuring the wrapper.
accounts
<string> Options object for
Returns <void>
Throws if the daoAddress
provided during constructor is detected to not be a instance
options
fetchFromWeb3
Whether accounts should also be fetched from the Web3 instance provided to the wrapper
providedAccounts
<string> An array of accounts that the user controls
Returns <void>
options
aclAddress
Address of the instance to use, defaults to the daoAddress
's default ACL
Returns <void>
proxyAddress
The address of the proxy to get metadata from
Returns <>
app
Returns
Returns <void>
sandbox
An object that is compatible with the PostMessage API.
proxyAddress
The address of the app proxy.
Returns
Returns <<>> An array of addresses
destination
methodName
params
<any>
Returns <> An array of Ethereum transactions that describe each step in the path
sender
destination
methodName
params
<any>
Returns <> An array of Ethereum transactions that describe each step in the path
address
Address to modify
metadata
Identity metadata
Returns a <void> that resolves if the modification was successful.
address
Address to resolve
Returns a <> that resolves with the identity or null if not found.
address
Address to request modification
Returns a <void> that delegates resolution to the handler.
addresses
<string> Addresses to remove from local identities
searchTerm
String to search for
Returns a <<>> which resolves with the found identities or an empty array.
appearance
Either light
or dark
. Other values could be passed in the future (e.g. black
for OLED screens). Apps should display a corresponding theme, unless theme
has also been set.
theme
An entire theme () that should be displayed by app frontends. It is optional and apps should respect it when present. If not possible, apps should respect the value of appearance
.