From 4b2d7caedff0d7459ee13519ff067e50ea389696 Mon Sep 17 00:00:00 2001 From: chmanie Date: Fri, 3 May 2024 12:10:11 +0000 Subject: [PATCH] chore: generate docs --- .../StreamingPaymentsEvents__factory.md | 2 +- ...ngPaymentsEvents.ClaimWaivedEventObject.md | 21 ---- ...ingPaymentsEvents.EndTimeSetEventObject.md | 21 ---- ...gPaymentsEvents.StartTimeSetEventObject.md | 21 ---- ...gPaymentsEvents.StreamingPaymentsEvents.md | 6 -- ...Events.StreamingPaymentsEventsInterface.md | 99 ------------------- .../api/modules/StreamingPaymentsEvents.md | 39 -------- 7 files changed, 1 insertion(+), 208 deletions(-) delete mode 100644 packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md delete mode 100644 packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md delete mode 100644 packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md diff --git a/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md b/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md index b3e597387..30a5b8316 100644 --- a/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md +++ b/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md @@ -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 diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md deleted file mode 100644 index a55804dce..000000000 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: ClaimWaivedEventObject - -[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).ClaimWaivedEventObject - -## Properties - -### agent - -• **agent**: `string` - -___ - -### streamingPaymentId - -• **streamingPaymentId**: `BigNumber` - -___ - -### token - -• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md deleted file mode 100644 index 42c0e18c3..000000000 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: EndTimeSetEventObject - -[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).EndTimeSetEventObject - -## Properties - -### agent - -• **agent**: `string` - -___ - -### endTime - -• **endTime**: `BigNumber` - -___ - -### streamingPaymentId - -• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md deleted file mode 100644 index a7fdcfa15..000000000 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: StartTimeSetEventObject - -[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).StartTimeSetEventObject - -## Properties - -### agent - -• **agent**: `string` - -___ - -### startTime - -• **startTime**: `BigNumber` - -___ - -### streamingPaymentId - -• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md index b5de8487c..309baf334 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md @@ -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) | @@ -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) | diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md index a78114d0c..4d250fe9c 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md @@ -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` | @@ -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 diff --git a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md index e994e8468..ef05ff79a 100644 --- a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md +++ b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md @@ -2,14 +2,11 @@ ## 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) @@ -17,30 +14,6 @@ ## 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)\> @@ -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)\>