Skip to content

Commit

Permalink
chore: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@chmanie @github-actions
chmanie authored and github-actions[bot] committed May 3, 2024
1 parent f126a0f commit 4b2d7ca
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 208 deletions.
2 changes: 1 addition & 1 deletion packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

### abi

▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [] ; `name`: ``"ExtensionInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"authority"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetAuthority"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetOwner"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address payable"`` ; `name`: ``"relayerAddress"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"functionSignature"`` ; `type`: ``"bytes"`` }] ; `name`: ``"MetaTransactionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentCreated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }] ; `name`: ``"ClaimWaived"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"endTime"`` ; `type`: ``"uint256"`` }] ; `name`: ``"EndTimeSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"startTime"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StartTimeSet"`` ; `type`: ``"event"`` }]
▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [] ; `name`: ``"ExtensionInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"authority"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetAuthority"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetOwner"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address payable"`` ; `name`: ``"relayerAddress"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"functionSignature"`` ; `type`: ``"bytes"`` }] ; `name`: ``"MetaTransactionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentCreated"`` ; `type`: ``"event"`` }]

## Methods

Expand Down
21 changes: 0 additions & 21 deletions packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md
View file

This file was deleted.

21 changes: 0 additions & 21 deletions packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md
View file

This file was deleted.

21 changes: 0 additions & 21 deletions ...ages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md
View file

This file was deleted.

6 changes: 0 additions & 6 deletions ...ages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,6 @@ ___

| Name | Type |
| :------ | :------ |
| `ClaimWaived` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``) => [`ClaimWaivedEventFilter`](../modules/StreamingPaymentsEvents.md#claimwaivedeventfilter) |
| `ClaimWaived(address,uint256,address)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``) => [`ClaimWaivedEventFilter`](../modules/StreamingPaymentsEvents.md#claimwaivedeventfilter) |
| `EndTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => [`EndTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#endtimeseteventfilter) |
| `EndTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => [`EndTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#endtimeseteventfilter) |
| `ExtensionInitialised` | () => [`ExtensionInitialisedEventFilter`](../modules/StreamingPaymentsEvents.md#extensioninitialisedeventfilter) |
| `ExtensionInitialised()` | () => [`ExtensionInitialisedEventFilter`](../modules/StreamingPaymentsEvents.md#extensioninitialisedeventfilter) |
| `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => [`LogSetAuthorityEventFilter`](../modules/StreamingPaymentsEvents.md#logsetauthorityeventfilter) |
Expand All @@ -110,8 +106,6 @@ ___
| `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => [`MetaTransactionExecutedEventFilter`](../modules/StreamingPaymentsEvents.md#metatransactionexecutedeventfilter) |
| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentTokenUpdatedEventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdatedeventfilter) |
| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentTokenUpdatedEventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdatedeventfilter) |
| `StartTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => [`StartTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#starttimeseteventfilter) |
| `StartTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => [`StartTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#starttimeseteventfilter) |
| `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`StreamingPaymentClaimedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentclaimedeventfilter) |
| `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`StreamingPaymentClaimedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentclaimedeventfilter) |
| `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => [`StreamingPaymentCreatedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentcreatedeventfilter) |
Expand Down
99 changes: 0 additions & 99 deletions ...docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,11 @@ ___

| Name | Type |
| :------ | :------ |
| `ClaimWaived(address,uint256,address)` | `EventFragment` |
| `EndTimeSet(address,uint256,uint256)` | `EventFragment` |
| `ExtensionInitialised()` | `EventFragment` |
| `LogSetAuthority(address)` | `EventFragment` |
| `LogSetOwner(address)` | `EventFragment` |
| `MetaTransactionExecuted(address,address,bytes)` | `EventFragment` |
| `PaymentTokenUpdated(address,uint256,address,uint256)` | `EventFragment` |
| `StartTimeSet(address,uint256,uint256)` | `EventFragment` |
| `StreamingPaymentClaimed(address,uint256,address,uint256)` | `EventFragment` |
| `StreamingPaymentCreated(address,uint256)` | `EventFragment` |

Expand Down Expand Up @@ -636,102 +633,6 @@ utils.Interface.getEvent

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"ClaimWaived"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"ClaimWaived(address,uint256,address)"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"EndTimeSet"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"EndTimeSet(address,uint256,uint256)"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"StartTimeSet"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nameOrSignatureOrTopic` | ``"StartTimeSet(address,uint256,uint256)"`` |

#### Returns

`EventFragment`

#### Overrides

utils.Interface.getEvent

___

### getEventTopic
Expand Down
39 changes: 0 additions & 39 deletions packages/sdk/docs/api/modules/StreamingPaymentsEvents.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,18 @@

## Interfaces

- [ClaimWaivedEventObject](../interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md)
- [EndTimeSetEventObject](../interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md)
- [ExtensionInitialisedEventObject](../interfaces/StreamingPaymentsEvents.ExtensionInitialisedEventObject.md)
- [LogSetAuthorityEventObject](../interfaces/StreamingPaymentsEvents.LogSetAuthorityEventObject.md)
- [LogSetOwnerEventObject](../interfaces/StreamingPaymentsEvents.LogSetOwnerEventObject.md)
- [MetaTransactionExecutedEventObject](../interfaces/StreamingPaymentsEvents.MetaTransactionExecutedEventObject.md)
- [PaymentTokenUpdatedEventObject](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md)
- [StartTimeSetEventObject](../interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md)
- [StreamingPaymentClaimedEventObject](../interfaces/StreamingPaymentsEvents.StreamingPaymentClaimedEventObject.md)
- [StreamingPaymentCreatedEventObject](../interfaces/StreamingPaymentsEvents.StreamingPaymentCreatedEventObject.md)
- [StreamingPaymentsEvents](../interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md)
- [StreamingPaymentsEventsInterface](../interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md)

## Type Aliases

### ClaimWaivedEvent

Ƭ **ClaimWaivedEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`ClaimWaivedEventObject`](../interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md)\>

___

### ClaimWaivedEventFilter

Ƭ **ClaimWaivedEventFilter**: `TypedEventFilter`<[`ClaimWaivedEvent`](StreamingPaymentsEvents.md#claimwaivedevent)\>

___

### EndTimeSetEvent

Ƭ **EndTimeSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`EndTimeSetEventObject`](../interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md)\>

___

### EndTimeSetEventFilter

Ƭ **EndTimeSetEventFilter**: `TypedEventFilter`<[`EndTimeSetEvent`](StreamingPaymentsEvents.md#endtimesetevent)\>

___

### ExtensionInitialisedEvent

Ƭ **ExtensionInitialisedEvent**: `TypedEvent`<[], [`ExtensionInitialisedEventObject`](../interfaces/StreamingPaymentsEvents.ExtensionInitialisedEventObject.md)\>
Expand Down Expand Up @@ -101,18 +74,6 @@ ___

___

### StartTimeSetEvent

Ƭ **StartTimeSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`StartTimeSetEventObject`](../interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md)\>

___

### StartTimeSetEventFilter

Ƭ **StartTimeSetEventFilter**: `TypedEventFilter`<[`StartTimeSetEvent`](StreamingPaymentsEvents.md#starttimesetevent)\>

___

### StreamingPaymentClaimedEvent

Ƭ **StreamingPaymentClaimedEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`, `BigNumber`], [`StreamingPaymentClaimedEventObject`](../interfaces/StreamingPaymentsEvents.StreamingPaymentClaimedEventObject.md)\>
Expand Down

0 comments on commit 4b2d7ca

Please sign in to comment.