Class ClaimSettlementModule`Alpha`

Hierarchy

default
- ClaimSettlementModule

Constructors

constructor

new ClaimSettlementModule(ethersProvider: JsonRpcProvider, signer?: Signer): ClaimSettlementModule
Parameters
- ethersProvider: JsonRpcProvider
- Optional signer: Signer
Returns ClaimSettlementModule
Overrides SafeModule.constructor
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:38

Properties

safeSalt

safeSalt: string = 'cardstack-cs-create-safe'

moduleSalt

moduleSalt: string = 'cardstack-cs-deploy-module'

abi

abi: ({
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
    name?: undefined;
    anonymous?: undefined;
    outputs?: undefined;
} | {
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    type: string;
    stateMutability?: undefined;
    anonymous?: undefined;
    outputs?: undefined;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    type: string;
    stateMutability?: undefined;
    outputs?: undefined;
} | {
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
    anonymous?: undefined;
})[] = ClaimSettlementABI

name

name: AddressKeys

`Protected` ethersProvider

ethersProvider: JsonRpcProvider

`Protected` `Optional` signer

signer?: Signer

Methods

setupArgs

setupArgs(safeAddress: string): SetupArgs
Parameters
- safeAddress: string
Returns SetupArgs
Overrides SafeModule.setupArgs
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:41

isValidator

isValidator(moduleAddress: string, possibleValidator: string): Promise<any>
Parameters
- moduleAddress: string
- possibleValidator: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:47

getValidators

getValidators(moduleAddress: string): Promise<any>
Parameters
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:52

isValidState

isValidState(claim: Claim, moduleAddress: string): Promise<any>
Parameters
- claim: Claim
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:57

isValidCaller

isValidCaller(claim: Claim, moduleAddress: string, caller: string): Promise<any>
Parameters
- claim: Claim
- moduleAddress: string
- caller: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:62

isUsed

isUsed(claim: Claim, moduleAddress: string): Promise<any>
Parameters
- claim: Claim
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:67

hasBalance

hasBalance(claim: Claim, moduleAddress: string): Promise<any>
Parameters
- claim: Claim
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:72

addValidator

addValidator(txnHash: string): Promise<SuccessfulTransactionReceipt>
Parameters
- txnHash: string
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:89
addValidator(moduleAddress: string, avatarAddress: string, validatorAddress: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- moduleAddress: string
- avatarAddress: string
- validatorAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:90

removeValidator

removeValidator(txnHash: string): Promise<SuccessfulTransactionReceipt>
Parameters
- txnHash: string
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:163
removeValidator(moduleAddress: string, avatarAddress: string, validatorAddress: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- moduleAddress: string
- avatarAddress: string
- validatorAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:164

defaultStakingClaim

defaultStakingClaim(moduleAddress: string, payeeAddress?: string): Promise<Claim>
Parameters
- moduleAddress: string
- Optional payeeAddress: string
Returns Promise<Claim>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:237

stakingClaim

stakingClaim(moduleAddress: string, payeeAddress: string, tokenAddress: string, amountInEth: string, nftAddress: string, validitySeconds?: number): Promise<Claim>
Parameters
- moduleAddress: string
- payeeAddress: string
- tokenAddress: string
- amountInEth: string
- nftAddress: string
- validitySeconds: number = 86400
Returns Promise<Claim>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:245

checkValidity

checkValidity(claim: Claim, moduleAddress: string, callerAddress: string): Promise<void>
Parameters
- claim: Claim
- moduleAddress: string
- callerAddress: string
Returns Promise<void>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:269

executeEOA

executeEOA(moduleAddress: string, signedClaim: SignedClaim, txnOptions?: TransactionOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- moduleAddress: string
- signedClaim: SignedClaim
- Optional txnOptions: TransactionOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:284

executeSafe

executeSafe(txnHash: string): Promise<SuccessfulTransactionReceipt>
Parameters
- txnHash: string
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:306
executeSafe(moduleAddress: string, payeeSafeAddress: string, signedClaim: SignedClaim, gasTokenAddress?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- moduleAddress: string
- payeeSafeAddress: string
- signedClaim: SignedClaim
- Optional gasTokenAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:307

registerAccount

registerAccount(txnHash: string): Promise<SuccessfulTransactionReceipt>
Parameters
- txnHash: string
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:389
registerAccount(safeAddress: string, recipient?: string, gasTokenAddress?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- safeAddress: string
- Optional recipient: string
- Optional gasTokenAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:390

getDid

getDid(moduleAddress: string): Promise<any>
Parameters
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:468

getConfiguration

getConfiguration(moduleAddress: string): Promise<any>
Parameters
- moduleAddress: string
Returns Promise<any>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:473

setDid

setDid(txnHash: string): Promise<SuccessfulTransactionReceipt>
Parameters
- txnHash: string
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:478
setDid(moduleAddress: string, safeAddress: string, did: string, gasTokenAddress?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<SuccessfulTransactionReceipt>
Parameters
- moduleAddress: string
- safeAddress: string
- did: string
- Optional gasTokenAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<SuccessfulTransactionReceipt>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:479

getAccountRegistrationNfts

getAccountRegistrationNfts(ownerAddress: string): Promise<string[]>
Parameters
- ownerAddress: string
Returns Promise<string[]>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:559

isRegistered

isRegistered(address: string): Promise<boolean>
Parameters
- address: string
Returns Promise<boolean>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:571

sign

sign(claim: Claim): Promise<SignedClaim>
Parameters
- claim: Claim
Returns Promise<SignedClaim>
- Defined in packages/cardpay-sdk/sdk/claim-settlement-module.ts:576

createSafeWithModuleAndGuardEstimation

createSafeWithModuleAndGuardEstimation(contractOptions?: ContractOptions): Promise<BigNumber>
Parameters
- Optional contractOptions: ContractOptions
Returns Promise<BigNumber>
Inherited from SafeModule.createSafeWithModuleAndGuardEstimation
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:127

enableModuleAndGuard

enableModuleAndGuard(txnHash: string): Promise<EnableModuleAndGuardResult>
Parameters
- txnHash: string
Returns Promise<EnableModuleAndGuardResult>
Inherited from SafeModule.enableModuleAndGuard
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:188
enableModuleAndGuard(safeAddress: string, gasTokenAddress?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<EnableModuleAndGuardResult>
Parameters
- safeAddress: string
- Optional gasTokenAddress: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<EnableModuleAndGuardResult>
Inherited from SafeModule.enableModuleAndGuard
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:189

createSafeWithModuleAndGuardTx

createSafeWithModuleAndGuardTx(from: string): Promise<CreateSafeWithModuleAndGuardTx>
Parameters
- from: string
Returns Promise<CreateSafeWithModuleAndGuardTx>
Inherited from SafeModule.createSafeWithModuleAndGuardTx
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:285

createSafeWithModuleAndGuard

createSafeWithModuleAndGuard(txnHash?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<CreateSafeWithModuleAndGuardResult>
Parameters
- Optional txnHash: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<CreateSafeWithModuleAndGuardResult>
Inherited from SafeModule.createSafeWithModuleAndGuard
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:359

generateEnableModuleTxs

generateEnableModuleTxs(safeAddress: string, safeOwners?: string[]): Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
Parameters
- safeAddress: string
- safeOwners: string[] = []
Returns Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
Inherited from SafeModule.generateEnableModuleTxs
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:396

generateSetGuardTxs

generateSetGuardTxs(safeAddress: string): Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
Parameters
- safeAddress: string
Returns Promise<{
txs: Transaction[];
expectedModuleAddress: string;
}>
Inherited from SafeModule.generateSetGuardTxs
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:417

getSafeAddressFromTxn

getSafeAddressFromTxn(txnHash: string): Promise<string>
Parameters
- txnHash: string
Returns Promise<string>
Inherited from SafeModule.getSafeAddressFromTxn
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:445

getModuleAndGuardAddressFromTxn

getModuleAndGuardAddressFromTxn(txnHash: string): Promise<EnableModuleAndGuardResult>
Parameters
- txnHash: string
Returns Promise<EnableModuleAndGuardResult>
Inherited from SafeModule.getModuleAndGuardAddressFromTxn
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:451

getDetails

getDetails(moduleAddress: string): Promise<ModuleDetails>
Parameters
- moduleAddress: string
Returns Promise<ModuleDetails>
Inherited from SafeModule.getDetails
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:467

createSafeWithModule

createSafeWithModule(txnHash?: string, txnOptions?: TransactionOptions, contractOptions?: ContractOptions): Promise<CreateSafeWithModuleResult>
Parameters
- Optional txnHash: string
- Optional txnOptions: TransactionOptions
- Optional contractOptions: ContractOptions
Returns Promise<CreateSafeWithModuleResult>
Inherited from SafeModule.createSafeWithModule
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:479

createSafeWithModuleTx

createSafeWithModuleTx(from: string): Promise<CreateSafeWithModuleTx>
Parameters
- from: string
Returns Promise<CreateSafeWithModuleTx>
Inherited from SafeModule.createSafeWithModuleTx
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:513

isModuleEnabled

isModuleEnabled(safeAddress: string, moduleAddress: string): Promise<boolean>
Parameters
- safeAddress: string
- moduleAddress: string
Returns Promise<boolean>
Inherited from SafeModule.isModuleEnabled
- Defined in packages/cardpay-sdk/sdk/safe-module.ts:586

Class ClaimSettlementModuleAlpha

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ethersProvider: JsonRpcProvider

Optional signer: Signer

Returns ClaimSettlementModule

Properties

safeSalt

moduleSalt

abi

name

Protected ethersProvider

Protected Optional signer

Methods

setupArgs

Parameters

safeAddress: string

Returns SetupArgs

isValidator

Parameters

moduleAddress: string

possibleValidator: string

Returns Promise<any>

getValidators

Parameters

moduleAddress: string

Returns Promise<any>

isValidState

Parameters

claim: Claim

moduleAddress: string

Returns Promise<any>

isValidCaller

Parameters

claim: Claim

moduleAddress: string

caller: string

Returns Promise<any>

isUsed

Parameters

claim: Claim

moduleAddress: string

Returns Promise<any>

hasBalance

Parameters

claim: Claim

moduleAddress: string

Returns Promise<any>

addValidator

Parameters

txnHash: string

Returns Promise<SuccessfulTransactionReceipt>

Parameters

moduleAddress: string

avatarAddress: string

validatorAddress: string

Optional txnOptions: TransactionOptions

Optional contractOptions: ContractOptions

Returns Promise<SuccessfulTransactionReceipt>

removeValidator

Parameters

txnHash: string

Returns Promise<SuccessfulTransactionReceipt>

Parameters

moduleAddress: string

avatarAddress: string

validatorAddress: string

Optional txnOptions: TransactionOptions

Optional contractOptions: ContractOptions

Returns Promise<SuccessfulTransactionReceipt>

defaultStakingClaim

Parameters

moduleAddress: string

Optional payeeAddress: string

Class ClaimSettlementModule`Alpha`

`Optional` signer: Signer

`Protected` ethersProvider

`Protected` `Optional` signer

`Optional` txnOptions: TransactionOptions

`Optional` contractOptions: ContractOptions

`Optional` txnOptions: TransactionOptions

`Optional` contractOptions: ContractOptions

`Optional` payeeAddress: string

`Optional` txnOptions: TransactionOptions

`Optional` gasTokenAddress: string

`Optional` txnOptions: TransactionOptions

`Optional` contractOptions: ContractOptions

`Optional` recipient: string

`Optional` gasTokenAddress: string

`Optional` txnOptions: TransactionOptions

`Optional` contractOptions: ContractOptions

`Optional` gasTokenAddress: string

`Optional` txnOptions: TransactionOptions

`Optional` contractOptions: ContractOptions