ApprovalsProtocol
Defined in: protocols/approvals.ts:132
Base class for approvals modules.
Extends
Section titled “Extends”ProtocolBase<TConfig>
Type Parameters
Section titled “Type Parameters”TConfig
Section titled “TConfig”TConfig extends object = Record<string, never>
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ApprovalsProtocol<
TConfig>(account,config?):ApprovalsProtocol<TConfig>
Defined in: protocols/approvals.ts:136
Parameters
Section titled “Parameters”account
Section titled “account”IWalletAccountReadOnly | IWalletAccount
config?
Section titled “config?”TConfig = ...
Returns
Section titled “Returns”ApprovalsProtocol<TConfig>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_account
Section titled “_account”
protectedreadonly_account:IWalletAccountReadOnly|IWalletAccount
Defined in: protocols/base.ts:8
Inherited from
Section titled “Inherited from”_config
Section titled “_config”
protectedreadonly_config:TConfig
Defined in: protocols/base.ts:9
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”describeActivity()
Section titled “describeActivity()”describeActivity(
_tx,_ctx):ActivityItem|null
Defined in: protocols/base.ts:24
Recognize one of this protocol’s own transactions in an address’s history and
describe it for the wallet’s activity feed (“Supplied 100 USDC · Aave v3”).
Return null when the transaction is not this protocol’s: the kit then asks the
next module and finally falls back to send / receive / approve / contract call.
Must be pure and synchronous: no network, no account state. The conformance
suite feeds every module its recorded fixtures through this method.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ActivityItem | null
Inherited from
Section titled “Inherited from”getApprovals()
Section titled “getApprovals()”getApprovals(
_o?):Promise<ApprovalsResult>
Defined in: protocols/approvals.ts:140
Live approvals of the account, with risks and scan coverage.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ApprovalsResult>
Implementation of
Section titled “Implementation of”IApprovalsProtocol.getApprovals
getSupportedStandards()
Section titled “getSupportedStandards()”getSupportedStandards():
Promise<ApprovalStandard[]>
Defined in: protocols/approvals.ts:139
Approval kinds this module can find and revoke.
Returns
Section titled “Returns”Promise<ApprovalStandard[]>
Implementation of
Section titled “Implementation of”IApprovalsProtocol.getSupportedStandards
quoteRevoke()
Section titled “quoteRevoke()”quoteRevoke(
_a):Promise<{fee:bigint; }>
Defined in: protocols/approvals.ts:141
Network fee of revoking one approval.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<{ fee: bigint; }>
Implementation of
Section titled “Implementation of”IApprovalsProtocol.quoteRevoke
requireSigningAccount()
Section titled “requireSigningAccount()”
protectedrequireSigningAccount(methodName):IWalletAccount
Defined in: protocols/base.ts:29
The account, narrowed to a signing one, or a ReadOnlyAccountError naming the caller.
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ProtocolBase.requireSigningAccount
revoke()
Section titled “revoke()”revoke(
_a):Promise<RevokeResult>
Defined in: protocols/approvals.ts:142
Revoke one approval.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<RevokeResult>
Implementation of
Section titled “Implementation of”revokeAll()
Section titled “revokeAll()”revokeAll(
_a):Promise<RevokeResult[]>
Defined in: protocols/approvals.ts:143
Revoke several, batching where the standard allows. Continues past failures; each result
carries its own error.
Parameters
Section titled “Parameters”Approval[]
Returns
Section titled “Returns”Promise<RevokeResult[]>