Skip to content

Commit 1ad1bac

Browse files
committed
Fix incorrect name of caveats used in caveat factory functions
- erc20PeriodicEnforcer is now erc20PeriodTransferEnforcer - nativeTokenPeriodicEnforcer is now nativeTokenPeriodTransferEnforcer
1 parent 711a8f0 commit 1ad1bac

10 files changed

Lines changed: 54 additions & 52 deletions

File tree

packages/7715-permission-types/src/permissions/caveats/erc20TokenAllowance.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export function makeErc20TokenAllowanceDecoderConfig(
3434
): PermissionDecoderConfig {
3535
const {
3636
timestampEnforcer,
37-
erc20PeriodicEnforcer,
37+
erc20PeriodTransferEnforcer,
3838
valueLteEnforcer,
3939
nonceEnforcer,
4040
allowedCalldataEnforcer,
@@ -50,7 +50,7 @@ export function makeErc20TokenAllowanceDecoderConfig(
5050
allowedCalldataEnforcer, // payee rule
5151
],
5252
requiredEnforcers: {
53-
[erc20PeriodicEnforcer]: 1,
53+
[erc20PeriodTransferEnforcer]: 1,
5454
[valueLteEnforcer]: 1,
5555
[nonceEnforcer]: 1,
5656
},
@@ -70,7 +70,7 @@ function validateAndDecodeData(
7070
caveats: ChecksumCaveat[],
7171
contractAddresses: ChecksumEnforcersByChainId,
7272
): DecodedPermissionData<Erc20TokenAllowancePermission> {
73-
const { erc20PeriodicEnforcer, valueLteEnforcer } = contractAddresses;
73+
const { erc20PeriodTransferEnforcer, valueLteEnforcer } = contractAddresses;
7474

7575
const valueLteTerms = getTermsByEnforcer({
7676
caveats,
@@ -82,7 +82,7 @@ function validateAndDecodeData(
8282

8383
const terms = getTermsByEnforcer({
8484
caveats,
85-
enforcer: erc20PeriodicEnforcer,
85+
enforcer: erc20PeriodTransferEnforcer,
8686
});
8787

8888
const EXPECTED_TERMS_BYTELENGTH = 116; // 20 + 32 + 32 + 32
@@ -122,7 +122,7 @@ function validateAndDecodeData(
122122
*/
123123
export type Erc20TokenAllowanceEnforcers = Pick<
124124
ChecksumEnforcersByChainId,
125-
'erc20PeriodicEnforcer' | 'valueLteEnforcer'
125+
'erc20PeriodTransferEnforcer' | 'valueLteEnforcer'
126126
>;
127127

128128
/**
@@ -156,7 +156,7 @@ export function createErc20TokenAllowanceCaveats({
156156
}
157157

158158
const erc20PeriodCaveat: Caveat = {
159-
enforcer: contracts.erc20PeriodicEnforcer,
159+
enforcer: contracts.erc20PeriodTransferEnforcer,
160160
terms: createERC20TokenPeriodTransferTerms({
161161
tokenAddress,
162162
periodAmount: allowanceAmountBigInt,

packages/7715-permission-types/src/permissions/caveats/erc20TokenPeriodic.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export function makeErc20TokenPeriodicDecoderConfig(
3333
): PermissionDecoderConfig {
3434
const {
3535
timestampEnforcer,
36-
erc20PeriodicEnforcer,
36+
erc20PeriodTransferEnforcer,
3737
valueLteEnforcer,
3838
nonceEnforcer,
3939
allowedCalldataEnforcer,
@@ -49,7 +49,7 @@ export function makeErc20TokenPeriodicDecoderConfig(
4949
allowedCalldataEnforcer, // payee rule
5050
],
5151
requiredEnforcers: {
52-
[erc20PeriodicEnforcer]: 1,
52+
[erc20PeriodTransferEnforcer]: 1,
5353
[valueLteEnforcer]: 1,
5454
[nonceEnforcer]: 1,
5555
},
@@ -69,7 +69,7 @@ function validateAndDecodeData(
6969
caveats: ChecksumCaveat[],
7070
contractAddresses: ChecksumEnforcersByChainId,
7171
): DecodedPermissionData<Erc20TokenPeriodicPermission> {
72-
const { erc20PeriodicEnforcer, valueLteEnforcer } = contractAddresses;
72+
const { erc20PeriodTransferEnforcer, valueLteEnforcer } = contractAddresses;
7373

7474
const valueLteTerms = getTermsByEnforcer({
7575
caveats,
@@ -81,7 +81,7 @@ function validateAndDecodeData(
8181

8282
const terms = getTermsByEnforcer({
8383
caveats,
84-
enforcer: erc20PeriodicEnforcer,
84+
enforcer: erc20PeriodTransferEnforcer,
8585
});
8686

8787
const {
@@ -128,7 +128,7 @@ function validateAndDecodeData(
128128
*/
129129
export type Erc20TokenPeriodicEnforcers = Pick<
130130
ChecksumEnforcersByChainId,
131-
'erc20PeriodicEnforcer' | 'valueLteEnforcer'
131+
'erc20PeriodTransferEnforcer' | 'valueLteEnforcer'
132132
>;
133133

134134
/**
@@ -175,7 +175,7 @@ export function createErc20TokenPeriodicCaveats({
175175
}
176176

177177
const erc20PeriodCaveat: Caveat = {
178-
enforcer: contracts.erc20PeriodicEnforcer,
178+
enforcer: contracts.erc20PeriodTransferEnforcer,
179179
terms: createERC20TokenPeriodTransferTerms({
180180
tokenAddress,
181181
periodAmount: periodAmountBigInt,

packages/7715-permission-types/src/permissions/caveats/nativeTokenAllowance.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export function makeNativeTokenAllowanceDecoderConfig(
3434
): PermissionDecoderConfig {
3535
const {
3636
timestampEnforcer,
37-
nativeTokenPeriodicEnforcer,
37+
nativeTokenPeriodTransferEnforcer,
3838
exactCalldataEnforcer,
3939
nonceEnforcer,
4040
allowedTargetsEnforcer,
@@ -50,7 +50,7 @@ export function makeNativeTokenAllowanceDecoderConfig(
5050
allowedTargetsEnforcer, // payee rule
5151
],
5252
requiredEnforcers: {
53-
[nativeTokenPeriodicEnforcer]: 1,
53+
[nativeTokenPeriodTransferEnforcer]: 1,
5454
[exactCalldataEnforcer]: 1,
5555
[nonceEnforcer]: 1,
5656
},
@@ -70,7 +70,7 @@ function validateAndDecodeData(
7070
caveats: ChecksumCaveat[],
7171
contractAddresses: ChecksumEnforcersByChainId,
7272
): DecodedPermissionData<NativeTokenAllowancePermission> {
73-
const { nativeTokenPeriodicEnforcer, exactCalldataEnforcer } =
73+
const { nativeTokenPeriodTransferEnforcer, exactCalldataEnforcer } =
7474
contractAddresses;
7575

7676
const exactCalldataTerms = getTermsByEnforcer({
@@ -84,7 +84,7 @@ function validateAndDecodeData(
8484

8585
const terms = getTermsByEnforcer({
8686
caveats,
87-
enforcer: nativeTokenPeriodicEnforcer,
87+
enforcer: nativeTokenPeriodTransferEnforcer,
8888
});
8989

9090
const EXPECTED_TERMS_BYTELENGTH = 96; // 32 + 32 + 32
@@ -126,7 +126,7 @@ function validateAndDecodeData(
126126
*/
127127
export type NativeTokenAllowanceEnforcers = Pick<
128128
ChecksumEnforcersByChainId,
129-
'nativeTokenPeriodicEnforcer' | 'exactCalldataEnforcer'
129+
'nativeTokenPeriodTransferEnforcer' | 'exactCalldataEnforcer'
130130
>;
131131

132132
/**
@@ -160,7 +160,7 @@ export function createNativeTokenAllowanceCaveats({
160160
}
161161

162162
const nativeTokenPeriodTransferCaveat: Caveat = {
163-
enforcer: contracts.nativeTokenPeriodicEnforcer,
163+
enforcer: contracts.nativeTokenPeriodTransferEnforcer,
164164
terms: createNativeTokenPeriodTransferTerms({
165165
periodAmount: allowanceAmountBigInt,
166166
// delegation-core accepts bigint for encoding although the type is `number`.

packages/7715-permission-types/src/permissions/caveats/nativeTokenPeriodic.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export function makeNativeTokenPeriodicDecoderConfig(
2929
): PermissionDecoderConfig {
3030
const {
3131
timestampEnforcer,
32-
nativeTokenPeriodicEnforcer,
32+
nativeTokenPeriodTransferEnforcer,
3333
exactCalldataEnforcer,
3434
nonceEnforcer,
3535
allowedTargetsEnforcer,
@@ -45,7 +45,7 @@ export function makeNativeTokenPeriodicDecoderConfig(
4545
allowedTargetsEnforcer, // payee rule
4646
],
4747
requiredEnforcers: {
48-
[nativeTokenPeriodicEnforcer]: 1,
48+
[nativeTokenPeriodTransferEnforcer]: 1,
4949
[exactCalldataEnforcer]: 1,
5050
[nonceEnforcer]: 1,
5151
},
@@ -65,7 +65,7 @@ function validateAndDecodeData(
6565
caveats: ChecksumCaveat[],
6666
contractAddresses: ChecksumEnforcersByChainId,
6767
): DecodedPermissionData<NativeTokenPeriodicPermission> {
68-
const { nativeTokenPeriodicEnforcer, exactCalldataEnforcer } =
68+
const { nativeTokenPeriodTransferEnforcer, exactCalldataEnforcer } =
6969
contractAddresses;
7070

7171
const exactCalldataTerms = getTermsByEnforcer({
@@ -79,7 +79,7 @@ function validateAndDecodeData(
7979

8080
const terms = getTermsByEnforcer({
8181
caveats,
82-
enforcer: nativeTokenPeriodicEnforcer,
82+
enforcer: nativeTokenPeriodTransferEnforcer,
8383
});
8484
const {
8585
periodAmount,
@@ -123,7 +123,7 @@ function validateAndDecodeData(
123123
*/
124124
export type NativeTokenPeriodicEnforcers = Pick<
125125
ChecksumEnforcersByChainId,
126-
'nativeTokenPeriodicEnforcer' | 'exactCalldataEnforcer'
126+
'nativeTokenPeriodTransferEnforcer' | 'exactCalldataEnforcer'
127127
>;
128128

129129
/**
@@ -169,7 +169,7 @@ export function createNativeTokenPeriodicCaveats({
169169
}
170170

171171
const nativeTokenPeriodTransferCaveat: Caveat = {
172-
enforcer: contracts.nativeTokenPeriodicEnforcer,
172+
enforcer: contracts.nativeTokenPeriodTransferEnforcer,
173173
terms: createNativeTokenPeriodTransferTerms({
174174
periodAmount: periodAmountBigInt,
175175
periodDuration,

packages/7715-permission-types/src/permissions/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import type { Hex, PermissionTypes, Rule } from '../types';
77
*/
88
export type ChecksumEnforcersByChainId = {
99
erc20StreamingEnforcer: Hex;
10-
erc20PeriodicEnforcer: Hex;
10+
erc20PeriodTransferEnforcer: Hex;
1111
nativeTokenStreamingEnforcer: Hex;
12-
nativeTokenPeriodicEnforcer: Hex;
12+
nativeTokenPeriodTransferEnforcer: Hex;
1313
approvalRevocationEnforcer: Hex;
1414
exactCalldataEnforcer: Hex;
1515
valueLteEnforcer: Hex;

packages/7715-permission-types/src/permissions/utils.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,13 @@ export const getChecksumEnforcersByChainId = (
176176
const erc20StreamingEnforcer = getChecksumContractAddress(
177177
ENFORCER_CONTRACT_NAMES.ERC20StreamingEnforcer,
178178
);
179-
const erc20PeriodicEnforcer = getChecksumContractAddress(
179+
const erc20PeriodTransferEnforcer = getChecksumContractAddress(
180180
ENFORCER_CONTRACT_NAMES.ERC20PeriodTransferEnforcer,
181181
);
182182
const nativeTokenStreamingEnforcer = getChecksumContractAddress(
183183
ENFORCER_CONTRACT_NAMES.NativeTokenStreamingEnforcer,
184184
);
185-
const nativeTokenPeriodicEnforcer = getChecksumContractAddress(
185+
const nativeTokenPeriodTransferEnforcer = getChecksumContractAddress(
186186
ENFORCER_CONTRACT_NAMES.NativeTokenPeriodTransferEnforcer,
187187
);
188188
const approvalRevocationEnforcer = getChecksumContractAddress(
@@ -212,9 +212,9 @@ export const getChecksumEnforcersByChainId = (
212212

213213
return {
214214
erc20StreamingEnforcer,
215-
erc20PeriodicEnforcer,
215+
erc20PeriodTransferEnforcer,
216216
nativeTokenStreamingEnforcer,
217-
nativeTokenPeriodicEnforcer,
217+
nativeTokenPeriodTransferEnforcer,
218218
approvalRevocationEnforcer,
219219
exactCalldataEnforcer,
220220
valueLteEnforcer,

packages/7715-permission-types/test/permissions/caveats/erc20TokenAllowance.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ describe('erc20-token-allowance decoder config', () => {
3131
const contracts = DELEGATOR_CONTRACTS['1.3.0'][chainId];
3232
const {
3333
timestampEnforcer,
34-
erc20PeriodicEnforcer,
34+
erc20PeriodTransferEnforcer,
3535
valueLteEnforcer,
3636
nonceEnforcer,
3737
allowedCalldataEnforcer,
@@ -52,7 +52,7 @@ describe('erc20-token-allowance decoder config', () => {
5252
valueLteTerms: Hex = ZERO_32_BYTES,
5353
): ChecksumCaveat[] => [
5454
{
55-
enforcer: erc20PeriodicEnforcer,
55+
enforcer: erc20PeriodTransferEnforcer,
5656
terms: erc20PeriodicTerms,
5757
args: '0x',
5858
},
@@ -71,7 +71,7 @@ describe('erc20-token-allowance decoder config', () => {
7171
describe('static configuration', () => {
7272
it('exposes expected required enforcers', () => {
7373
expect(decoder.requiredEnforcers).toStrictEqual({
74-
[erc20PeriodicEnforcer]: 1,
74+
[erc20PeriodTransferEnforcer]: 1,
7575
[valueLteEnforcer]: 1,
7676
[nonceEnforcer]: 1,
7777
});
@@ -177,7 +177,7 @@ describe('createErc20TokenAllowanceCaveats()', () => {
177177
const startTime = 1729900800;
178178

179179
const contracts: Erc20TokenAllowanceEnforcers = {
180-
erc20PeriodicEnforcer: '0x7356Ed4321Ff9e7DAE246461829cDC170ff660Ab',
180+
erc20PeriodTransferEnforcer: '0x7356Ed4321Ff9e7DAE246461829cDC170ff660Ab',
181181
valueLteEnforcer: '0x5e12Ca712176E7557e4fAa1c8cc27382B60B5e39',
182182
};
183183

@@ -201,7 +201,7 @@ describe('createErc20TokenAllowanceCaveats()', () => {
201201

202202
expect(caveats).toStrictEqual([
203203
{
204-
enforcer: contracts.erc20PeriodicEnforcer,
204+
enforcer: contracts.erc20PeriodTransferEnforcer,
205205
terms: expectedTerms,
206206
args: '0x',
207207
},
@@ -302,7 +302,7 @@ describe('createErc20TokenAllowanceCaveats()', () => {
302302
});
303303
const erc20AllowanceTerms = caveats[0]?.terms as Hex;
304304

305-
expect(caveats[0]?.enforcer).toBe(contracts.erc20PeriodicEnforcer);
305+
expect(caveats[0]?.enforcer).toBe(contracts.erc20PeriodTransferEnforcer);
306306
expect(
307307
erc20AllowanceTerms.startsWith(`0x${alternateTokenAddress.slice(2)}`),
308308
).toBe(true);

packages/7715-permission-types/test/permissions/caveats/erc20TokenPeriodic.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ describe('erc20-token-periodic decoder config', () => {
3131
const contracts = DELEGATOR_CONTRACTS['1.3.0'][chainId];
3232
const {
3333
timestampEnforcer,
34-
erc20PeriodicEnforcer,
34+
erc20PeriodTransferEnforcer,
3535
valueLteEnforcer,
3636
nonceEnforcer,
3737
allowedCalldataEnforcer,
@@ -67,7 +67,7 @@ describe('erc20-token-periodic decoder config', () => {
6767
valueLteTerms: Hex = ZERO_32_BYTES,
6868
): ChecksumCaveat[] => [
6969
{
70-
enforcer: erc20PeriodicEnforcer,
70+
enforcer: erc20PeriodTransferEnforcer,
7171
terms,
7272
args: '0x',
7373
},
@@ -86,7 +86,7 @@ describe('erc20-token-periodic decoder config', () => {
8686
describe('static configuration', () => {
8787
it('exposes expected required enforcers', () => {
8888
expect(decoder.requiredEnforcers).toStrictEqual({
89-
[erc20PeriodicEnforcer]: 1,
89+
[erc20PeriodTransferEnforcer]: 1,
9090
[valueLteEnforcer]: 1,
9191
[nonceEnforcer]: 1,
9292
});
@@ -208,7 +208,7 @@ describe('createErc20TokenPeriodicCaveats()', () => {
208208
const startTime = 1729900800;
209209

210210
const contracts: Erc20TokenPeriodicEnforcers = {
211-
erc20PeriodicEnforcer: '0x7356Ed4321Ff9e7DAE246461829cDC170ff660Ab',
211+
erc20PeriodTransferEnforcer: '0x7356Ed4321Ff9e7DAE246461829cDC170ff660Ab',
212212
valueLteEnforcer: '0x5e12Ca712176E7557e4fAa1c8cc27382B60B5e39',
213213
};
214214

@@ -233,7 +233,7 @@ describe('createErc20TokenPeriodicCaveats()', () => {
233233

234234
expect(caveats).toStrictEqual([
235235
{
236-
enforcer: contracts.erc20PeriodicEnforcer,
236+
enforcer: contracts.erc20PeriodTransferEnforcer,
237237
terms: expectedTerms,
238238
args: '0x',
239239
},
@@ -369,7 +369,7 @@ describe('createErc20TokenPeriodicCaveats()', () => {
369369
});
370370
const erc20PeriodicTerms = caveats[0]?.terms as Hex;
371371

372-
expect(caveats[0]?.enforcer).toBe(contracts.erc20PeriodicEnforcer);
372+
expect(caveats[0]?.enforcer).toBe(contracts.erc20PeriodTransferEnforcer);
373373
expect(
374374
erc20PeriodicTerms.startsWith(`0x${alternateTokenAddress.slice(2)}`),
375375
).toBe(true);

0 commit comments

Comments
 (0)