Skip to content

Commit 2540e69

Browse files
committed
chore: set gitRevision to always be main to reduce changes in docs
1 parent ffeefd2 commit 2540e69

File tree

104 files changed

+372
-368
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+372
-368
lines changed

packages/sdk-react-provider/docs/generated/enumerations/OrderState.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
| Enumeration Member | Value | Defined in |
88
| ------------------ | ------------- | ----------------------- |
9-
| `pending` | `"pending"` | sdk/dist/index.d.ts:199 |
10-
| `placed` | `"placed"` | sdk/dist/index.d.ts:198 |
11-
| `processed` | `"processed"` | sdk/dist/index.d.ts:200 |
12-
| `rejected` | `"rejected"` | sdk/dist/index.d.ts:201 |
9+
| `pending` | `"pending"` | sdk/dist/index.d.ts:195 |
10+
| `placed` | `"placed"` | sdk/dist/index.d.ts:194 |
11+
| `processed` | `"processed"` | sdk/dist/index.d.ts:196 |
12+
| `rejected` | `"rejected"` | sdk/dist/index.d.ts:197 |

packages/sdk-react-provider/docs/generated/functions/MoneriumProvider.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,23 @@
22

33
# Function: MoneriumProvider()
44

5-
> **MoneriumProvider**(`params`: \{`children`: `ReactNode`;`clientId`: `'f99e629b-6dca-11ee-8aa6-5273f65ed05b'`;`environment`: `'sandbox'`;`redirectUrl`: `'http://localhost:5173'`; \}): `Element`
5+
> **MoneriumProvider**(`params`: \{`children`: `ReactNode`;`clientId`: `string`;`environment`: `'sandbox'`;`redirectUri`: `string`;`redirectUrl`: `string`; \}): `Element`
66
77
## Parameters
88

99
| Parameter | Type | Description |
1010
| --------------------- | ----------------------------- | -------------------------------- |
1111
| `params` | `object` | |
1212
| `params.children` | `ReactNode` | Rest of the application. |
13-
| `params.clientId`? | `string` | Monerium auth flow client id. |
13+
| `params.clientId` | `string` | Monerium auth flow client id. |
1414
| `params.environment`? | `"sandbox"` \| `"production"` | Monerium environment. |
15-
| `params.redirectUrl`? | `string` | Monerium auth flow redirect url. |
15+
| `params.redirectUri` | `string` | Monerium auth flow redirect url. |
16+
| `params.redirectUrl`? | `string` | **Deprecated** use redirectUri |
1617

1718
## Returns
1819

1920
`Element`
2021

2122
## Defined in
2223

23-
[sdk-react-provider/src/lib/provider.tsx:20](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/provider.tsx#L20)
24+
[sdk-react-provider/src/lib/provider.tsx:19](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/provider.tsx#L19)

packages/sdk-react-provider/docs/generated/functions/useAuth.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,11 @@
2323
const { authorize, isAuthorized, isLoading, error } = useAuth();
2424

2525
authorize(); // Redirects to the Monerium auth flow.
26+
27+
// To opt-in to automated wallet linking, pass the address, signature and chain.
28+
authorize({ address, signature, chain }).
2629
```
2730

2831
## Defined in
2932

30-
[sdk-react-provider/src/lib/hooks.tsx:82](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L82)
33+
[sdk-react-provider/src/lib/hooks.tsx:85](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L85)

packages/sdk-react-provider/docs/generated/functions/useAuthContext.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ const {
3838

3939
## Defined in
4040

41-
[sdk-react-provider/src/lib/hooks.tsx:122](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L122)
41+
[sdk-react-provider/src/lib/hooks.tsx:125](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L125)

packages/sdk-react-provider/docs/generated/functions/useBalances.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ const {
3939

4040
## Defined in
4141

42-
[sdk-react-provider/src/lib/hooks.tsx:334](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L334)
42+
[sdk-react-provider/src/lib/hooks.tsx:337](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L337)

packages/sdk-react-provider/docs/generated/functions/useLinkAddress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ const {
4141

4242
## Defined in
4343

44-
[sdk-react-provider/src/lib/hooks.tsx:600](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L600)
44+
[sdk-react-provider/src/lib/hooks.tsx:594](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L594)

packages/sdk-react-provider/docs/generated/functions/useOrder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ const {
3939

4040
## Defined in
4141

42-
[sdk-react-provider/src/lib/hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L389)
42+
[sdk-react-provider/src/lib/hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L389)

packages/sdk-react-provider/docs/generated/functions/useOrders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ const {
4343

4444
## Defined in
4545

46-
[sdk-react-provider/src/lib/hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L449)
46+
[sdk-react-provider/src/lib/hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L449)

packages/sdk-react-provider/docs/generated/functions/usePlaceOrder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ const {
4343

4444
## Defined in
4545

46-
[sdk-react-provider/src/lib/hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L510)
46+
[sdk-react-provider/src/lib/hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L510)

packages/sdk-react-provider/docs/generated/functions/useProfile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ const {
4141

4242
## Defined in
4343

44-
[sdk-react-provider/src/lib/hooks.tsx:175](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L175)
44+
[sdk-react-provider/src/lib/hooks.tsx:178](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L178)

0 commit comments

Comments
 (0)