Skip to content

Commit 92ecbe6

Browse files
fix: added comments and mock examplers in packages//README
1 parent b1584db commit 92ecbe6

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

packages/finoaconnect/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,20 @@ const onboard = Onboard({
2020
]
2121
})
2222

23+
// alternatively to connect to a localised development environment
24+
const onboard = Onboard({
25+
// ... other Onboard options
26+
wallets: [
27+
finoaConnectModule([
28+
{
29+
labelSuffix: 'localhost',
30+
url: 'http://localhost:8080',
31+
}
32+
])
33+
//... other wallets
34+
]
35+
})
36+
2337
const connectedWallets = await onboard.connectWallet()
2438
console.log(connectedWallets)
2539
```

packages/finoaconnect/src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
import { FinoaEIP1193Provider } from '@finoa/finoa-connect-sdk'
22
import type { Chain, WalletInit } from '@web3-onboard/common'
33

4+
/** Optional object provided to the initiation of the wallet connector.
5+
* When not included, the wallet connector service connects to FinoaConnect production systems.
6+
* @field {url} URL of the FinoaConnect backend systems to be used
7+
* @field {labelSuffix} arbitrary string label to denote the context of the URL field */
48
export interface FinoaWalletOption {
59
url?: string
610
labelSuffix?: string

yarn.lock

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1857,6 +1857,11 @@
18571857
dependencies:
18581858
keccak "^3.0.0"
18591859

1860+
"@finoa/finoa-connect-sdk@^1.0.2":
1861+
version "1.0.2"
1862+
resolved "https://registry.yarnpkg.com/@finoa/finoa-connect-sdk/-/finoa-connect-sdk-1.0.2.tgz#17dc743f1bb93bb365254f4ab262c1ebaf05fd80"
1863+
integrity sha512-RMpJjsic+xKz6CnasF+/JvMvtcfQphFjCS6H7OdPj2FSXCyimqVXMHbTzUFONKITgZO6iolxT+UY99ujEVHv0w==
1864+
18601865
"@formatjs/ecma402-abstract@1.11.3":
18611866
version "1.11.3"
18621867
resolved "https://registry.yarnpkg.com/@formatjs/ecma402-abstract/-/ecma402-abstract-1.11.3.tgz#f25276dfd4ef3dac90da667c3961d8aa9732e384"
@@ -15060,16 +15065,16 @@ typescript@*, typescript@^4.5.5:
1506015065
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.5.tgz#d8c953832d28924a9e3d37c73d729c846c5896f3"
1506115066
integrity sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==
1506215067

15068+
typescript@5.1.6, typescript@^5.1.6:
15069+
version "5.1.6"
15070+
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274"
15071+
integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==
15072+
1506315073
typescript@^4.6.2:
1506415074
version "4.6.4"
1506515075
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.6.4.tgz#caa78bbc3a59e6a5c510d35703f6a09877ce45e9"
1506615076
integrity sha512-9ia/jWHIEbo49HfjrLGfKbZSuWo9iTMwXO+Ca3pRsSpbsMbc7/IU8NKdCZVRRBafVPGnoJeFL76ZOAA84I9fEg==
1506715077

15068-
typescript@^5.1.6:
15069-
version "5.1.6"
15070-
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274"
15071-
integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==
15072-
1507315078
typescript@^5.2.2:
1507415079
version "5.2.2"
1507515080
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78"

0 commit comments

Comments
 (0)