- Preparing search index...
- The search index is not available
cardstack
Class ScheduledPaymentModule
Properties
Private Optional signer
signer?: Signer
Methods
createSafeWithModuleAndGuardTx
createSafeWithModuleAndGuardEstimation
- createSafeWithModuleAndGuardEstimation(contractOptions?: ContractOptions): Promise<BigNumber>
-
Parameters
-
Optional contractOptions: ContractOptions
Returns Promise<BigNumber>
createSafeWithModuleAndGuard
generateEnableModuleTxs
- generateEnableModuleTxs(safeAddress: string, safeOwners?: string[]): Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
-
Parameters
-
safeAddress: string
-
safeOwners: string[] = []
Returns Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
generateSetGuardTxs
- generateSetGuardTxs(safeAddress: string): Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
-
Returns Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
getSafeAddressFromTxn
- getSafeAddressFromTxn(txnHash: string): Promise<string>
-
Returns Promise<string>
getModuleAndGuardAddressFromTxn
estimateExecutionGas
- estimateExecutionGas(moduleAddress: string, tokenAddress: string, amount: string, payeeAddress: string, maxGasPrice: string, gasTokenAddress: string, salt: string, gasPrice: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number, feeFixedUSD?: null | number, feePercentage?: null | number): Promise<number>
-
Parameters
-
moduleAddress: string
-
tokenAddress: string
-
amount: string
-
payeeAddress: string
-
maxGasPrice: string
-
gasTokenAddress: string
-
salt: string
-
gasPrice: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
-
Optional feeFixedUSD: null | number
-
Optional feePercentage: null | number
Returns Promise<number>
estimateExecutionGasWithNoAmount
- estimateExecutionGasWithNoAmount(moduleAddress: string, tokenAddress: string, payeeAddress: string, gasTokenAddress: string, salt: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number): Promise<number>
-
Parameters
-
moduleAddress: string
-
tokenAddress: string
-
payeeAddress: string
-
gasTokenAddress: string
-
salt: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
Returns Promise<number>
cancelScheduledPaymentOnChain
- cancelScheduledPaymentOnChain(txnHash: string): Promise<SuccessfulTransactionReceipt>
-
Returns Promise<SuccessfulTransactionReceipt>
- cancelScheduledPaymentOnChain(safeAddress: string, moduleAddress: string, spHash: string, gasTokenAddress: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<void>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
spHash: string
-
gasTokenAddress: string
-
-
Optional contractOptions: ContractOptions
Returns Promise<void>
createSpHash
- createSpHash(moduleAddress: string, tokenAddress: string, amount: string, payeeAddress: string, executionGas: number, maxGasPrice: string, gasTokenAddress: string, salt: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number): Promise<string>
-
Parameters
-
moduleAddress: string
-
tokenAddress: string
-
amount: string
-
payeeAddress: string
-
executionGas: number
-
maxGasPrice: string
-
gasTokenAddress: string
-
salt: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
Returns Promise<string>
Private generateSchedulePaymentTxParams
- generateSchedulePaymentTxParams(safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string): Promise<{
nonce: BN;
estimate: Estimate;
payload: string;
signature: Signature;
}>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
Returns Promise<{
nonce: BN;
estimate: Estimate;
payload: string;
signature: Signature;
}>
Private generateCancelPaymentTxParams
- generateCancelPaymentTxParams(safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string): Promise<{
nonce: BN;
estimate: Estimate;
payload: string;
signature: Signature;
}>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
Returns Promise<{
nonce: BN;
estimate: Estimate;
payload: string;
signature: Signature;
}>
Private schedulePaymentOnChainAndUpdateCrank
- schedulePaymentOnChainAndUpdateCrank(hubRootUrl: string, authToken: string, scheduledPaymentId: string, safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string, txnParams: TransactionParams, listener?: SchedulePaymentProgressListener): Promise<void>
-
Parameters
-
hubRootUrl: string
-
authToken: string
-
scheduledPaymentId: string
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
-
-
Returns Promise<void>
Private cancelPaymentOnChainAndUpdateCrank
- cancelPaymentOnChainAndUpdateCrank(hubRootUrl: string, authToken: string, scheduledPaymentId: string, safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string, txnParams: TransactionParams): Promise<void>
-
Parameters
-
hubRootUrl: string
-
authToken: string
-
scheduledPaymentId: string
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
-
Returns Promise<void>
cancelScheduledPayment
- cancelScheduledPayment(scheduledPaymentId: string, hubRootUrl?: string, authToken?: string): Promise<any>
-
Parameters
-
scheduledPaymentId: string
-
Optional hubRootUrl: string
-
Optional authToken: string
Returns Promise<any>
schedulePaymentOnChain
- schedulePaymentOnChain(txnHash: string): Promise<SuccessfulTransactionReceipt>
-
Returns Promise<SuccessfulTransactionReceipt>
- schedulePaymentOnChain(safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string, txnParams?: TransactionParams, txnOptions?: TransactionOptions): Promise<SuccessfulTransactionReceipt>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
-
-
Returns Promise<SuccessfulTransactionReceipt>
schedulePayment
- schedulePayment(scheduledPaymentId: string): Promise<void>
-
Parameters
-
scheduledPaymentId: string
Returns Promise<void>
- schedulePayment(safeAddress: string, moduleAddress: string, tokenAddress: string, amount: string, payeeAddress: string, privateMemo: null | string, executionGas: number, maxGasPrice: string, gasTokenAddress: string, salt: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number, options?: null | SchedulePaymentOptions): Promise<void>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
tokenAddress: string
-
amount: string
-
payeeAddress: string
-
privateMemo: null | string
-
executionGas: number
-
maxGasPrice: string
-
gasTokenAddress: string
-
salt: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
-
Returns Promise<void>
estimateSchedulePaymentInGasToken
- estimateSchedulePaymentInGasToken(safeAddress: string, moduleAddress: string, tokenAddress: string, amount: string, payeeAddress: string, executionGas: number, maxGasPrice: string, gasTokenAddress: string, salt: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number): Promise<BigNumber>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
tokenAddress: string
-
amount: string
-
payeeAddress: string
-
executionGas: number
-
maxGasPrice: string
-
gasTokenAddress: string
-
salt: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
Returns Promise<BigNumber>
cancelPaymentOnChain
- cancelPaymentOnChain(txnHash: string): Promise<SuccessfulTransactionReceipt>
-
Returns Promise<SuccessfulTransactionReceipt>
- cancelPaymentOnChain(safeAddress: string, moduleAddress: string, gasTokenAddress: string, spHash: string, txnParams?: TransactionParams, txnOptions?: TransactionOptions): Promise<SuccessfulTransactionReceipt>
-
Parameters
-
safeAddress: string
-
moduleAddress: string
-
gasTokenAddress: string
-
spHash: string
-
-
Returns Promise<SuccessfulTransactionReceipt>
executeScheduledPayment
- executeScheduledPayment(txnHash: string): Promise<SuccessfulTransactionReceipt>
-
Returns Promise<SuccessfulTransactionReceipt>
- executeScheduledPayment(moduleAddressOrTxnHash: string, tokenAddress: string, amount: string, payeeAddress: string, feeFixedUSD: number, feePercentage: number, executionGas: number, maxGasPrice: string, gasTokenAddress: string, salt: string, gasPrice: string, payAt?: null | number, recurringDayOfMonth?: null | number, recurringUntil?: null | number, txnOptions?: TransactionOptions): Promise<SuccessfulTransactionReceipt>
-
Parameters
-
moduleAddressOrTxnHash: string
-
tokenAddress: string
-
amount: string
-
payeeAddress: string
-
feeFixedUSD: number
-
feePercentage: number
-
executionGas: number
-
maxGasPrice: string
-
gasTokenAddress: string
-
salt: string
-
gasPrice: string
-
Optional payAt: null | number
-
Optional recurringDayOfMonth: null | number
-
Optional recurringUntil: null | number
-
Returns Promise<SuccessfulTransactionReceipt>
estimateGas
- estimateGas(scenario: "create_safe_with_module" | "execute_one_time_payment" | "execute_recurring_payment", options: {
safeAddress?: null | string;
tokenAddress?: null | string;
gasTokenAddress?: null | string;
hubUrl?: null | string;
}): Promise<GasEstimationResult>
-
Parameters
-
scenario: "create_safe_with_module" | "execute_one_time_payment" | "execute_recurring_payment"
-
options: {
safeAddress?: null | string;
tokenAddress?: null | string;
gasTokenAddress?: null | string;
hubUrl?: null | string;
}
-
Optional safeAddress?: null | string
-
Optional tokenAddress?: null | string
-
Optional gasTokenAddress?: null | string
-
Optional hubUrl?: null | string
getValidForDays
- getValidForDays(): Promise<number>
-
Returns Promise<number>
getUsdToken
- getUsdToken(): Promise<string>
-
Returns Promise<string>
Private composeFees
- composeFees(feeFixedUSD: number, feePercentage: number): {
fixedUSD: {
value: string;
};
percentage: {
value: string;
};
}
-
Parameters
-
feeFixedUSD: number
-
feePercentage: number
Returns {
fixedUSD: {
value: string;
};
percentage: {
value: string;
};
}
-
fixedUSD: {
value: string;
}
-
percentage: {
value: string;
}