Merge pull request #677 from dev-protocol/add-examples

Add examples

Author: hhatto

.gitignore

@@ -63,6 +63,7 @@ typings/
 # build
 dist
 *.js
+!examples/*.js
 *.mjs
 *.d.ts
 *.ts.map

examples/README.md

@@ -0,0 +1,46 @@
+# dev-kit-js examples
+
+## Usage
+
+`package.json`
+
+```
+{
+  "name": "devkit-examples-sandbox",
+  "version": "0.0.1",
+  "type": "module",
+  "license": "MIT",
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "@devprotocol/dev-kit": "^5.8.1",
+    "ethers": "^5.5.2"
+  }
+}
+```
+
+copy the script file you want to run into index.js.
+Then `yarn install` to prepare for execution.
+
+```
+$ cp xxx.js index.js
+$ yarn install
+$ tree -L 1
+.
+├── index.js
+├── node_modules
+├── package.json
+└── yarn.lock
+```
+
+run example script (with local ethereum node. like this `http://localhost:8545`):
+
+```
+$ yarn start
+```
+
+run example script (with infura)
+```
+$ WEB3_PROVIDER_URL=https://mainnet.infura.io/v3/xxxx yarn start
+```

examples/get-property-info.js

@@ -0,0 +1,17 @@
+import { ethers } from 'ethers'
+import { contractFactory, addresses } from '@devprotocol/dev-kit'
+
+// use main net
+const registryContractAddress = addresses.eth.main.registry
+const provider = new ethers.providers.JsonRpcProvider(process.env.WEB3_PROVIDER_URL)
+const contract = contractFactory(provider)
+const propertyAddress = '0xac1AC9d00314aE7B4a7d6DbEE4860bECedF92309'
+const lockupContractAddress = await contract.registry(registryContractAddress).lockup()
+
+const propertyStakingAmount = await contract.lockup(lockupContractAddress).getPropertyValue(propertyAddress)
+const stakingAmount = ethers.BigNumber.from(propertyStakingAmount).div(new ethers.BigNumber.from(10).pow(18))
+console.log(`${propertyAddress}'s staking amount is ${stakingAmount.toBigInt()} DEV`)
+
+const propertyRewards = await contract.lockup(lockupContractAddress).calculateRewardAmount(propertyAddress)
+const reward = ethers.BigNumber.from(propertyRewards[0]).div(new ethers.BigNumber.from(10).pow(36))
+console.log(`${propertyAddress}'s rewards is ${reward.toBigInt()} DEV`)

examples/get-stats.js

@@ -0,0 +1,4 @@
+import { getStats } from '@devprotocol/dev-kit'
+
+const stats = await getStats()
+console.log(stats)

examples/get-stoken-info.js

@@ -0,0 +1,34 @@
+import { ethers } from 'ethers'
+import { contractFactory, addresses } from '@devprotocol/dev-kit'
+
+// use main net
+const contractAddress = addresses.eth.main.sTokens
+const provider = new ethers.providers.JsonRpcProvider(process.env.WEB3_PROVIDER_URL)
+const contract = contractFactory(provider)
+const propertyAddress = '0xac1AC9d00314aE7B4a7d6DbEE4860bECedF92309'
+
+const getSTokenIdsByPropertyAddress = async (contract, propertyAddress) => {
+  const res = await contract.sTokens(contractAddress).positionsOfProperty(propertyAddress)
+  return res
+}
+
+const getSTokenPositions = async (contract, sTokenId) => {
+  const res = await contract.sTokens(contractAddress).positions(sTokenId)
+  return res
+}
+
+const getSTokenRewards = (contract, sTokenId) => {
+  return contract.sTokens(contractAddress).rewards(sTokenId)
+}
+
+
+// get stoken ids
+const sTokenIds = await getSTokenIdsByPropertyAddress(contract, propertyAddress)
+
+// get postions data by stoken id
+const res = await Promise.all(sTokenIds.map(async (sTokenId) => {
+  const positions = await getSTokenPositions(contract, sTokenId)
+  const rewards = await getSTokenRewards(contract, sTokenId)
+  return { sTokenId, positions, rewards }
+}))
+console.log(res)