Skip to content

Commit e89f7fd

Browse files
joaquim-vergesjoaquim-verges
committed
add docs
1 parent e1d10c2 commit e89f7fd

File tree

4 files changed

+167
-22
lines changed

4 files changed

+167
-22
lines changed

‎Assets/Thirdweb/Scripts/ERC1155.cs

+64-9
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,18 @@ public class ERC1155
1111
{
1212
public string chain;
1313
public string address;
14+
/// <summary>
15+
/// Handle signature minting functionality
16+
/// </summary>
1417
public ERC1155Signature signature;
18+
/// <summary>
19+
/// Query claim conditions
20+
/// </summary>
1521
public ERC1155ClaimConditions claimConditions;
1622

23+
/// <summary>
24+
/// Interact with any ERC1155 compatible contract.
25+
/// </summary>
1726
public ERC1155(string chain, string address)
1827
{
1928
this.chain = chain;
@@ -22,38 +31,54 @@ public ERC1155(string chain, string address)
2231
this.claimConditions = new ERC1155ClaimConditions(chain, address);
2332
}
2433

25-
/// READ FUNCTIONS
34+
// READ FUNCTIONS
2635

36+
/// <summary>
37+
/// Get a NFT in this contract by its ID
38+
/// </summary>
2739
public async Task<NFT> Get(string tokenId)
2840
{
2941
return await Bridge.InvokeRoute<NFT>(getRoute("get"), Utils.ToJsonStringArray(tokenId));
3042
}
3143

44+
/// <summary>
45+
/// Get a all NFTs in this contract
46+
/// </summary>
3247
public async Task<List<NFT>> GetAll()
3348
{
3449
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getAll"), new string[] { });
3550
}
3651

37-
public async Task<List<NFT>> GetOwned()
38-
{
39-
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getOwned"), new string[] { });
40-
}
41-
42-
public async Task<List<NFT>> GetOwned(string address)
52+
/// <summary>
53+
/// Get a all NFTs owned by the connected wallet
54+
/// </summary>
55+
/// <param name="address">Optional wallet address to query NFTs of</param>
56+
public async Task<List<NFT>> GetOwned(string address = null)
4357
{
4458
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getOwned"), Utils.ToJsonStringArray(address));
4559
}
4660

61+
/// <summary>
62+
/// Get the balance of the given NFT for the connected wallet
63+
/// </summary>
4764
public async Task<string> Balance(string tokenId)
4865
{
4966
return await Bridge.InvokeRoute<string>(getRoute("balance"), new string[] { });
5067
}
5168

69+
/// <summary>
70+
/// Get the balance of the given NFT for the given wallet address
71+
/// </summary>
5272
public async Task<string> BalanceOf(string address, string tokenId)
5373
{
5474
return await Bridge.InvokeRoute<string>(getRoute("balanceOf"), Utils.ToJsonStringArray(address, tokenId));
5575
}
5676

77+
/// <summary>
78+
/// Check whether the given contract address has been approved to transfer NFTs on behalf of the given wallet address
79+
/// </summary>
80+
/// <param name="address">The wallet address</param>
81+
/// <param name="contractAddress">The contract address to check approval for</param>
5782
public async Task<string> IsApprovedForAll(string address, string approvedContract)
5883
{
5984
return await Bridge.InvokeRoute<string>(getRoute("isApproved"), Utils.ToJsonStringArray(address, approvedContract));
@@ -64,59 +89,89 @@ public async Task<int> TotalCount()
6489
return await Bridge.InvokeRoute<int>(getRoute("totalCount"), new string[] { });
6590
}
6691

92+
/// <summary>
93+
/// Get the total suppply in circulation for thge given NFT
94+
/// </summary>
6795
public async Task<int> TotalSupply(string tokenId)
6896
{
6997
return await Bridge.InvokeRoute<int>(getRoute("totalUnclaimedSupply"), Utils.ToJsonStringArray(tokenId));
7098
}
7199

72-
/// WRITE FUNCTIONS
100+
// WRITE FUNCTIONS
73101

102+
/// <summary>
103+
/// Set approval to the given contract to transfer NFTs on behalf of the connected wallet
104+
/// </summary>
74105
public async Task<TransactionResult> SetApprovalForAll(string contractToApprove, bool approved)
75106
{
76107
return await Bridge.InvokeRoute<TransactionResult>(getRoute("isApproved"), Utils.ToJsonStringArray(contractToApprove, approved));
77108
}
78109

110+
/// <summary>
111+
/// Transfer NFTs to the given address
112+
/// </summary>
79113
public async Task<TransactionResult> Transfer(string to, string tokenId, int amount)
80114
{
81115
return await Bridge.InvokeRoute<TransactionResult>(getRoute("transfer"), Utils.ToJsonStringArray(to, tokenId, amount));
82116
}
83117

118+
/// <summary>
119+
/// Burn NFTs
120+
/// </summary>
84121
public async Task<TransactionResult> Burn(string tokenId, int amount)
85122
{
86123
return await Bridge.InvokeRoute<TransactionResult>(getRoute("burn"), Utils.ToJsonStringArray(tokenId, amount));
87124
}
88125

126+
/// <summary>
127+
/// Claim NFTs from a Drop contract
128+
/// </summary>
89129
public async Task<TransactionResult[]> Claim(string tokenId, int amount)
90130
{
91131
return await Bridge.InvokeRoute<TransactionResult[]>(getRoute("claim"), Utils.ToJsonStringArray(tokenId, amount));
92132
}
93133

134+
/// <summary>
135+
/// Claim NFTs from a Drop contract and send them to the given address
136+
/// </summary>
94137
public async Task<TransactionResult[]> ClaimTo(string address, string tokenId, int amount)
95138
{
96139
return await Bridge.InvokeRoute<TransactionResult[]>(getRoute("claimTo"), Utils.ToJsonStringArray(address, tokenId, amount));
97140
}
98141

142+
/// <summary>
143+
/// Mint an NFT (requires minting permission)
144+
/// </summary>
99145
public async Task<TransactionResult> Mint(NFTMetadataWithSupply nft)
100146
{
101147
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mint"), Utils.ToJsonStringArray(nft));
102148
}
103149

150+
/// <summary>
151+
/// Mint an NFT and send it to the given wallet (requires minting permission)
152+
/// </summary>
104153
public async Task<TransactionResult> MintTo(string address, NFTMetadataWithSupply nft)
105154
{
106155
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintTo"), Utils.ToJsonStringArray(address, nft));
107156
}
108157

158+
/// <summary>
159+
/// Mint additional supply of a given NFT (requires minting permission)
160+
/// </summary>
109161
public async Task<TransactionResult> MintAdditionalSupply(string tokenId, int additionalSupply)
110162
{
111163
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintAdditionalSupply"), Utils.ToJsonStringArray(tokenId, additionalSupply, additionalSupply));
112164
}
113165

166+
/// <summary>
167+
/// Mint additional supply of a given NFT and send it to the given wallet (requires minting permission)
168+
/// </summary>
114169
public async Task<TransactionResult> MintAdditionalSupplyTo(string address, string tokenId, int additionalSupply)
115170
{
116171
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintAdditionalSupplyTo"), Utils.ToJsonStringArray(address, tokenId, additionalSupply));
117172
}
118173

119-
/// PRIVATE
174+
// PRIVATE
120175

121176
private string getRoute(string functionPath) {
122177
return this.address + ".erc1155." + functionPath;

‎Assets/Thirdweb/Scripts/ERC20.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class ERC20
1515
/// </summary>
1616
public ERC20Signature signature;
1717
/// <summary>
18-
/// Fetch claim conditions for a given ERC20 drop contract
18+
/// Query claim conditions
1919
/// </summary>
2020
public ERC20ClaimConditions claimConditions;
2121

‎Assets/Thirdweb/Scripts/ERC721.cs

+75-12
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,24 @@
55
namespace Thirdweb
66
{
77
/// <summary>
8-
/// Interact with any <c>ERC721</c> compatible contract.
8+
/// Interact with any ERC721 compatible contract.
99
/// </summary>
1010
public class ERC721
1111
{
1212
public string chain;
1313
public string address;
14+
/// <summary>
15+
/// Handle signature minting functionality
16+
/// </summary>
1417
public ERC721Signature signature;
18+
/// <summary>
19+
/// Query claim conditions
20+
/// </summary>
1521
public ERC721ClaimConditions claimConditions;
1622

23+
/// <summary>
24+
/// Interact with any ERC721 compatible contract.
25+
/// </summary>
1726
public ERC721(string chain, string address)
1827
{
1928
this.chain = chain;
@@ -22,96 +31,150 @@ public ERC721(string chain, string address)
2231
this.claimConditions = new ERC721ClaimConditions(chain, address);
2332
}
2433

25-
/// READ FUNCTIONS
34+
// READ FUNCTIONS
2635

36+
/// <summary>
37+
/// Get a NFT in this contract by its ID
38+
/// </summary>
2739
public async Task<NFT> Get(string tokenId)
2840
{
2941
return await Bridge.InvokeRoute<NFT>(getRoute("get"), Utils.ToJsonStringArray(tokenId));
3042
}
3143

44+
/// <summary>
45+
/// Get a all NFTs in this contract
46+
/// </summary>
3247
public async Task<List<NFT>> GetAll()
3348
{
3449
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getAll"), new string[] { });
3550
}
3651

37-
public async Task<List<NFT>> GetOwned()
38-
{
39-
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getOwned"), new string[] { });
40-
}
41-
42-
public async Task<List<NFT>> GetOwned(string address)
52+
/// <summary>
53+
/// Get a all NFTs owned by the connected wallet
54+
/// </summary>
55+
/// <param name="address">Optional wallet address to query NFTs of</param>
56+
public async Task<List<NFT>> GetOwned(string address = null)
4357
{
4458
return await Bridge.InvokeRoute<List<NFT>>(getRoute("getOwned"), Utils.ToJsonStringArray(address));
4559
}
4660

61+
/// <summary>
62+
/// Get the owner of a NFT in this contract
63+
/// </summary>
4764
public async Task<string> OwnerOf(string tokenId)
4865
{
4966
return await Bridge.InvokeRoute<string>(getRoute("ownerOf"), Utils.ToJsonStringArray(tokenId));
5067
}
5168

69+
/// <summary>
70+
/// Get the balance of NFTs in this contract for the connected wallet
71+
/// </summary>
5272
public async Task<string> Balance()
5373
{
5474
return await Bridge.InvokeRoute<string>(getRoute("balance"), new string[] { });
5575
}
5676

77+
/// <summary>
78+
/// Get the balance of NFTs in this contract for the given wallet address
79+
/// </summary>
5780
public async Task<string> BalanceOf(string address)
5881
{
5982
return await Bridge.InvokeRoute<string>(getRoute("balanceOf"), Utils.ToJsonStringArray(address));
6083
}
6184

62-
public async Task<string> IsApprovedForAll(string address, string approvedContract)
85+
/// <summary>
86+
/// Check whether the given contract address has been approved to transfer NFTs on behalf of the given wallet address
87+
/// </summary>
88+
/// <param name="address">The wallet address</param>
89+
/// <param name="contractAddress">The contract address to check approval for</param>
90+
public async Task<bool> IsApprovedForAll(string address, string approvedContract)
91+
{
92+
return await Bridge.InvokeRoute<bool>(getRoute("isApproved"), Utils.ToJsonStringArray(address, approvedContract));
93+
}
94+
95+
/// <summary>
96+
/// Get the total suppply in circulation
97+
/// </summary>
98+
public async Task<int> TotalCount()
6399
{
64-
return await Bridge.InvokeRoute<string>(getRoute("isApproved"), Utils.ToJsonStringArray(address, approvedContract));
100+
return await Bridge.InvokeRoute<int>(getRoute("totalCount"), new string[] { });
65101
}
66102

103+
/// <summary>
104+
/// Get the total claimed suppply for Drop contracts
105+
/// </summary>
67106
public async Task<int> TotalClaimedSupply()
68107
{
69108
return await Bridge.InvokeRoute<int>(getRoute("totalClaimedSupply"), new string[] { });
70109
}
71110

111+
/// <summary>
112+
/// Get the total unclaimed suppply for Drop contracts
113+
/// </summary>
72114
public async Task<int> TotalUnclaimedSupply()
73115
{
74116
return await Bridge.InvokeRoute<int>(getRoute("totalUnclaimedSupply"), new string[] { });
75117
}
76118

77-
/// WRITE FUNCTIONS
119+
// WRITE FUNCTIONS
78120

121+
/// <summary>
122+
/// Set approval to the given contract to transfer NFTs on behalf of the connected wallet
123+
/// </summary>
79124
public async Task<TransactionResult> SetApprovalForAll(string contractToApprove, bool approved)
80125
{
81126
return await Bridge.InvokeRoute<TransactionResult>(getRoute("isApproved"), Utils.ToJsonStringArray(contractToApprove, approved));
82127
}
83128

129+
/// <summary>
130+
/// Transfer a given NFT to the given address
131+
/// </summary>
84132
public async Task<TransactionResult> Transfer(string to, string tokenId)
85133
{
86134
return await Bridge.InvokeRoute<TransactionResult>(getRoute("transfer"), Utils.ToJsonStringArray(to, tokenId));
87135
}
88136

137+
/// <summary>
138+
/// Burn a given NFT
139+
/// </summary>
89140
public async Task<TransactionResult> Burn(string tokenId)
90141
{
91142
return await Bridge.InvokeRoute<TransactionResult>(getRoute("burn"), Utils.ToJsonStringArray(tokenId));
92143
}
93144

145+
/// <summary>
146+
/// Claim NFTs from a Drop contract
147+
/// </summary>
94148
public async Task<TransactionResult[]> Claim(int quantity)
95149
{
96150
return await Bridge.InvokeRoute<TransactionResult[]>(getRoute("claim"), Utils.ToJsonStringArray(quantity));
97151
}
98152

153+
/// <summary>
154+
/// Claim NFTs from a Drop contract and send them to the given address
155+
/// </summary>
99156
public async Task<TransactionResult[]> ClaimTo(string address, int quantity)
100157
{
101158
return await Bridge.InvokeRoute<TransactionResult[]>(getRoute("claimTo"), Utils.ToJsonStringArray(address, quantity));
102159
}
103160

161+
/// <summary>
162+
/// Mint an NFT (requires minting permission)
163+
/// </summary>
104164
public async Task<TransactionResult> Mint(NFTMetadata nft)
105165
{
106166
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mint"), Utils.ToJsonStringArray(nft));
107167
}
108168

169+
/// <summary>
170+
/// Mint an NFT and send it to the given wallet (requires minting permission)
171+
/// </summary>
109172
public async Task<TransactionResult> MintTo(string address, NFTMetadata nft)
110173
{
111174
return await Bridge.InvokeRoute<TransactionResult>(getRoute("mintTo"), Utils.ToJsonStringArray(address, nft));
112175
}
113176

114-
/// PRIVATE
177+
// PRIVATE
115178

116179
private string getRoute(string functionPath) {
117180
return this.address + ".erc721." + functionPath;

0 commit comments

Comments
 (0)