status-im/dappconnect-vote-poll-sdk
2
0
Fork 0
mirror of https://github.com/status-im/dappconnect-vote-poll-sdk.git synced 2025-02-04 17:34:08 +00:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Franck 2021-12-22 11:06:55 +11:00
parent 1fe89fe8a9
commit b081895cb2
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 1 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
packages/mainnet-poll-example/README.md
View File

@ -1,72 +1 @@
# DappConnect Poll SDK Example
This package is example usage of WakuPolling
Example uses usedapp for exposing web3 provider
For using usedapp please see usedapp docs
## creating WakuPolling object
to create waku polling object you can just use react hook
```
const wakuPolling = useWakuPolling(
appName,
tokenaddress,
library,
multicallAddress
)
```
it is a good idea for token address and multicall address to be dependent on current chainId.
useWakuPolling creates a new WakuPolling object whenever chainId changes.
## creating new poll
to create new poll you can use `createTimedPoll` function from WakuPolling class
```
wakuPolling.createTimedPoll(
question,
answers,
selectedType,
undefined,
endTime
)
```
If you want you can use already created modal component for creating polls
```
const [showPollCreation, setShowPollCreation] = useState(false)
.
.
.
{showPollCreation && (
<PollCreation wakuPolling={wakuPolling} setShowPollCreation={setShowPollCreation} theme={theme} />
)}
```
### showing polls
to show list of polls you can either use `PollList` component from polling-component
```
<PollList wakuPolling={wakuPolling} account={account} theme={theme} />
```
If you want to create your own react component please use
```
usePollList(wakuPolling: WakuPolling | undefined)
```
Which returns memoized DetailedTimedPoll[] array.
Waku polling also exposes `getDetailedTimedPolls`
```
const DetailedTimedPolls = await wakuPolling.getDetailedTimedPolls()
```
# Mainnet DappConnect Poll SDK Example