From 2f0baa5f09e29ee597f34ad203eb09450cc7877c Mon Sep 17 00:00:00 2001 From: Sahil-Gujrati Date: Thu, 19 Dec 2024 20:54:01 +0530 Subject: [PATCH] docs: Update docs --- .../contract.SafeSubscriptions.md | 2 +- .../interface.ISafeSubscriptions.md | 86 ++++++++++++++++++- 2 files changed, 86 insertions(+), 2 deletions(-) diff --git a/docs/src/src/SafeSubscriptions.sol/contract.SafeSubscriptions.md b/docs/src/src/SafeSubscriptions.sol/contract.SafeSubscriptions.md index 9289489..66ac312 100644 --- a/docs/src/src/SafeSubscriptions.sol/contract.SafeSubscriptions.md +++ b/docs/src/src/SafeSubscriptions.sol/contract.SafeSubscriptions.md @@ -1,5 +1,5 @@ # SafeSubscriptions -[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/ee23a85b61e1a2fcb6f4711abea433f68c6a08e4/src/SafeSubscriptions.sol) +[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/7655498651b4e9751995b9d5f9d47397b3b97bd0/src/SafeSubscriptions.sol) **Inherits:** EIP712, [ISafeSubscriptions](/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md) diff --git a/docs/src/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md b/docs/src/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md index d429b30..9f7cb86 100644 --- a/docs/src/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md +++ b/docs/src/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md @@ -1,7 +1,91 @@ # ISafeSubscriptions -[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/ee23a85b61e1a2fcb6f4711abea433f68c6a08e4/src/interfaces/ISafeSubscriptions.sol) +[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/7655498651b4e9751995b9d5f9d47397b3b97bd0/src/interfaces/ISafeSubscriptions.sol) +## Functions +### createSubscription + + +```solidity +function createSubscription( + Subscription memory _subscription, + uint256 _deadline, + uint256 _nonce, + bytes memory _signatures +) + external + returns (bytes32); +``` + +### cancelSubscription + + +```solidity +function cancelSubscription( + bytes32 _subscriptionDataHash, + uint256 _deadline, + uint256 _nonce, + bytes memory _signatures +) + external; +``` + +### withdrawFromSubscription + + +```solidity +function withdrawFromSubscription(bytes32 _subscriptionDataHash) external; +``` + +### getSafe + + +```solidity +function getSafe() external view returns (address); +``` + +### getNextNonce + + +```solidity +function getNextNonce() external view returns (uint256); +``` + +### getSubscriptionData + + +```solidity +function getSubscriptionData(bytes32 _subscriptionDataHash) external view returns (Subscription memory); +``` + +### isSubscriptionCancelled + + +```solidity +function isSubscriptionCancelled(bytes32 _subscriptionDataHash) external view returns (bool); +``` + +### getEncodedSubscriptionDataAndHash + + +```solidity +function getEncodedSubscriptionDataAndHash( + Subscription memory _subscription, + uint256 _deadline, + uint256 _nonce +) + external + view + returns (bytes memory, bytes32); +``` + +### getSubscriptionDataHash + + +```solidity +function getSubscriptionDataHash(Subscription memory _subscription) external pure returns (bytes32); +``` + ## Events ### SubscriptionCreated