Skip to content

Commit 0937bb2

Browse files
joaquim-vergesjoaquim-verges
committed
Introduce Routable pattern to consolidate assembling routes
1 parent e79fd1c commit 0937bb2

File tree

8 files changed

+95
-182
lines changed

8 files changed

+95
-182
lines changed

‎Assets/Thirdweb/Scripts/Common.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
namespace Thirdweb {
2+
public abstract class Routable {
3+
protected string baseRoute;
4+
5+
public Routable(string baseRoute) {
6+
this.baseRoute = baseRoute;
7+
}
8+
9+
protected string getRoute(string functionName) {
10+
return $"{baseRoute}.{functionName}";
11+
}
12+
}
13+
}

‎Assets/Thirdweb/Scripts/Common.cs.meta‎

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Assets/Thirdweb/Scripts/Contract.cs‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace Thirdweb
55
/// <summary>
66
/// Convenient wrapper to interact with any EVM contract
77
/// </summary>
8-
public class Contract
8+
public class Contract : Routable
99
{
1010
public string chain;
1111
public string address;
@@ -27,14 +27,14 @@ public class Contract
2727
/// </summary>
2828
public Marketplace marketplace;
2929

30-
public Contract(string chain, string address, string abi = "")
30+
public Contract(string chain, string address, string abi = null) : base(abi != null ? $"{address}#{abi}" : address)
3131
{
3232
this.chain = chain;
3333
this.address = address;
3434
this.abi = abi;
35-
this.ERC20 = new ERC20(chain, address, abi);
36-
this.ERC721 = new ERC721(chain, address, abi);
37-
this.ERC1155 = new ERC1155(chain, address, abi);
35+
this.ERC20 = new ERC20(baseRoute);
36+
this.ERC721 = new ERC721(baseRoute);
37+
this.ERC1155 = new ERC1155(baseRoute);
3838
this.marketplace = new Marketplace(chain, address);
3939
}
4040

@@ -65,10 +65,5 @@ public async Task<TransactionResult> Write(string functionName, params object[]
6565
Utils.ToJsonStringArray(args).CopyTo(argsEncoded, 1);
6666
return await Bridge.InvokeRoute<TransactionResult>(getRoute("call"), argsEncoded);
6767
}
68-
69-
private string getRoute(string functionPath)
70-
{
71-
return abi != "" ? this.address + "#" + abi + "." + functionPath : this.address + "." + functionPath;
72-
}
7368
}
7469
}

‎Assets/Thirdweb/Scripts/Deployer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public async Task<string> DeployTokenDrop(TokenContractDeployMetadata metadata)
5252
return await Bridge.InvokeRoute<string>(getRoute("deployTokenDrop"), Utils.ToJsonStringArray(metadata));
5353
}
5454

55-
public async Task<string> DeployTokenDrop(MarketplaceContractDeployMetadata metadata)
55+
public async Task<string> DeployMarketplace(MarketplaceContractDeployMetadata metadata)
5656
{
5757
return await Bridge.InvokeRoute<string>(getRoute("deployMarketplace"), Utils.ToJsonStringArray(metadata));
5858
}

‎Assets/Thirdweb/Scripts/ERC1155.cs‎

Lines changed: 24 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,8 @@ namespace Thirdweb
77
/// <summary>
88
/// Interact with any ERC1155 compatible contract.
99
/// </summary>
10-
public class ERC1155
10+
public class ERC1155 : Routable
1111
{
12-
public string chain;
13-
public string address;
14-
public string abi;
1512
/// <summary>
1613
/// Handle signature minting functionality
1714
/// </summary>
@@ -24,13 +21,10 @@ public class ERC1155
2421
/// <summary>
2522
/// Interact with any ERC1155 compatible contract.
2623
/// </summary>
27-
public ERC1155(string chain, string address, string abi = "")
24+
public ERC1155(string parentRoute) : base($"{parentRoute}.erc1155")
2825
{
29-
this.chain = chain;
30-
this.address = address;
31-
this.abi = abi;
32-
this.signature = new ERC1155Signature(chain, address, abi);
33-
this.claimConditions = new ERC1155ClaimConditions(chain, address, abi);
26+
this.signature = new ERC1155Signature(baseRoute);
27+
this.claimConditions = new ERC1155ClaimConditions(baseRoute);
3428
}
3529

3630
// READ FUNCTIONS
@@ -172,29 +166,15 @@ public async Task<TransactionResult> MintAdditionalSupplyTo(string address, stri
172166
{
173167
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintAdditionalSupplyTo"), Utils.ToJsonStringArray(address, tokenId, additionalSupply));
174168
}
175-
176-
// PRIVATE
177-
178-
private string getRoute(string functionPath)
179-
{
180-
return abi != "" ? this.address + "#" + abi + ".erc1155." + functionPath : this.address + ".erc1155." + functionPath;
181-
}
182169
}
183170

184171
/// <summary>
185172
/// Fetch claim conditions for a given ERC1155 drop contract
186173
/// </summary>
187-
public class ERC1155ClaimConditions
174+
public class ERC1155ClaimConditions : Routable
188175
{
189-
public string chain;
190-
public string address;
191-
public string abi;
192-
193-
public ERC1155ClaimConditions(string chain, string address, string abi = "")
176+
public ERC1155ClaimConditions(string parentRoute) : base($"{parentRoute}.claimConditions")
194177
{
195-
this.chain = chain;
196-
this.address = address;
197-
this.abi = abi;
198178
}
199179

200180
/// <summary>
@@ -228,16 +208,11 @@ public async Task<bool> GetClaimerProofs(string tokenId, string claimerAddress)
228208
{
229209
return await Bridge.InvokeRoute<bool>(getRoute("getClaimerProofs"), Utils.ToJsonStringArray(claimerAddress));
230210
}
231-
232-
private string getRoute(string functionPath)
233-
{
234-
return abi != "" ? this.address + "#" + abi + ".erc1155.claimConditions." + functionPath : this.address + ".erc1155.claimConditions." + functionPath;
235-
}
236211
}
237212

238213
// TODO switch to another JSON serializer that supports polymorphism
239214
[System.Serializable]
240-
#nullable enable
215+
#nullable enable
241216
public class ERC1155MintPayload
242217
{
243218
public string to;
@@ -327,19 +302,21 @@ public struct ERC1155SignedPayload
327302
public ERC1155SignedPayloadOutput payload;
328303
}
329304

330-
public class ERC1155Signature
305+
/// <summary>
306+
/// Generate, verify and mint signed mintable payloads
307+
/// </summary>
308+
public class ERC1155Signature : Routable
331309
{
332-
public string chain;
333-
public string address;
334-
public string abi;
335-
336-
public ERC1155Signature(string chain, string address, string abi = "")
310+
/// <summary>
311+
/// Generate, verify and mint signed mintable payloads
312+
/// </summary>
313+
public ERC1155Signature(string parentRoute) : base($"{parentRoute}.signature")
337314
{
338-
this.chain = chain;
339-
this.address = address;
340-
this.abi = abi;
341315
}
342316

317+
/// <summary>
318+
/// Generate a signed mintable payload. Requires minting permission.
319+
/// </summary>
343320
public async Task<ERC1155SignedPayload> Generate(ERC1155MintPayload payloadToSign)
344321
{
345322
return await Bridge.InvokeRoute<ERC1155SignedPayload>(getRoute("generate"), Utils.ToJsonStringArray(payloadToSign));
@@ -350,19 +327,20 @@ public async Task<ERC1155SignedPayload> GenerateFromTokenId(ERC1155MintAdditiona
350327
return await Bridge.InvokeRoute<ERC1155SignedPayload>(getRoute("generateFromTokenId"), Utils.ToJsonStringArray(payloadToSign));
351328
}
352329

330+
/// <summary>
331+
/// Verify that a signed mintable payload is valid
332+
/// </summary>
353333
public async Task<bool> Verify(ERC1155SignedPayload signedPayload)
354334
{
355335
return await Bridge.InvokeRoute<bool>(getRoute("verify"), Utils.ToJsonStringArray(signedPayload));
356336
}
357337

338+
/// <summary>
339+
/// Mint a signed mintable payload
340+
/// </summary>
358341
public async Task<TransactionResult> Mint(ERC1155SignedPayload signedPayload)
359342
{
360343
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mint"), Utils.ToJsonStringArray(signedPayload));
361344
}
362-
363-
private string getRoute(string functionPath)
364-
{
365-
return abi != "" ? this.address + "#" + abi + ".erc1155.signature." + functionPath : this.address + ".erc1155.signature." + functionPath;
366-
}
367345
}
368346
}

‎Assets/Thirdweb/Scripts/ERC20.cs‎

Lines changed: 9 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,8 @@ namespace Thirdweb
66
/// <summary>
77
/// Interact with any ERC20 compatible contract.
88
/// </summary>
9-
public class ERC20
9+
public class ERC20 : Routable
1010
{
11-
public string chain;
12-
public string address;
13-
public string abi;
1411
/// <summary>
1512
/// Handle signature minting functionality
1613
/// </summary>
@@ -23,13 +20,10 @@ public class ERC20
2320
/// <summary>
2421
/// Interact with any ERC20 compatible contract.
2522
/// </summary>
26-
public ERC20(string chain, string address, string abi = "")
23+
public ERC20(string parentRoute) : base($"{parentRoute}.erc20")
2724
{
28-
this.chain = chain;
29-
this.address = address;
30-
this.abi = abi;
31-
this.signature = new ERC20Signature(chain, address, abi);
32-
this.claimConditions = new ERC20ClaimConditions(chain, address, abi);
25+
this.signature = new ERC20Signature(baseRoute);
26+
this.claimConditions = new ERC20ClaimConditions(baseRoute);
3327
}
3428

3529
// READ FUNCTIONS
@@ -139,17 +133,9 @@ public async Task<TransactionResult> MintTo(string address, string amount)
139133
{
140134
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintTo"), Utils.ToJsonStringArray(address, amount));
141135
}
142-
143-
// PRIVATE
144-
145-
private string getRoute(string functionPath)
146-
{
147-
return abi != "" ? this.address + "#" + abi + ".erc20." + functionPath : this.address + ".erc20." + functionPath;
148-
}
149136
}
150137

151138
[System.Serializable]
152-
#nullable enable
153139
public class ERC20MintPayload
154140
{
155141
public string to;
@@ -199,20 +185,13 @@ public struct ERC20SignedPayload
199185
/// <summary>
200186
/// Fetch claim conditions for a given ERC20 drop contract
201187
/// </summary>
202-
public class ERC20ClaimConditions
188+
#nullable enable
189+
public class ERC20ClaimConditions : Routable
203190
{
204-
public string chain;
205-
public string address;
206-
public string abi;
207-
208-
public ERC20ClaimConditions(string chain, string address, string abi = "")
191+
public ERC20ClaimConditions(string parentRoute) : base($"{parentRoute}.claimConditions")
209192
{
210-
this.chain = chain;
211-
this.address = address;
212-
this.abi = abi;
213193
}
214194

215-
216195
/// <summary>
217196
/// Get the active claim condition
218197
/// </summary>
@@ -244,31 +223,19 @@ public async Task<bool> GetClaimerProofs(string claimerAddress)
244223
{
245224
return await Bridge.InvokeRoute<bool>(getRoute("getClaimerProofs"), Utils.ToJsonStringArray(claimerAddress));
246225
}
247-
248-
private string getRoute(string functionPath)
249-
{
250-
return abi != "" ? this.address + "#" + abi + ".erc20.claimConditions." + functionPath : this.address + ".erc20.claimConditions." + functionPath;
251-
}
252226
}
253227

254228

255229
/// <summary>
256230
/// Generate, verify and mint signed mintable payloads
257231
/// </summary>
258-
public class ERC20Signature
232+
public class ERC20Signature : Routable
259233
{
260-
public string chain;
261-
public string address;
262-
public string abi;
263-
264234
/// <summary>
265235
/// Generate, verify and mint signed mintable payloads
266236
/// </summary>
267-
public ERC20Signature(string chain, string address, string abi = "")
237+
public ERC20Signature(string parentRoute) : base($"{parentRoute}.signature")
268238
{
269-
this.chain = chain;
270-
this.address = address;
271-
this.abi = abi;
272239
}
273240

274241
/// <summary>
@@ -294,10 +261,5 @@ public async Task<TransactionResult> Mint(ERC20SignedPayload signedPayload)
294261
{
295262
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mint"), Utils.ToJsonStringArray(signedPayload));
296263
}
297-
298-
private string getRoute(string functionPath)
299-
{
300-
return abi != "" ? this.address + "#" + abi + ".erc20.signature." + functionPath : this.address + ".erc20.signature." + functionPath;
301-
}
302264
}
303265
}

0 commit comments

Comments
 (0)