Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Commit 7d223eb

Browse files
authored
Update feature snippets (#128)
1 parent 304f968 commit 7d223eb

18 files changed

+293
-300
lines changed

docs/docs/contract-metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class ContractMetadata(Generic[TMetadataABI, TContractSchema])
1818
def get() -> TContractSchema
1919
```
2020

21-
Get the metadata associated with this contract.
21+
Get the contract metadata
2222

2323
```python
2424
metadata = contract.metadata.get()
@@ -37,7 +37,7 @@ metadata associated with this contract
3737
def set(metadata: TContractSchema) -> TxReceipt
3838
```
3939

40-
Set the metadata associated with this contract.
40+
Set the contract metadata
4141

4242
```python
4343
from thirdweb.types import ContractMetadataSchema

docs/docs/contract-platform-fee.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class ContractPlatformFee(Generic[TPlatformFeeABI])
1818
def get() -> ContractPlatformFeeSchema
1919
```
2020

21-
Get the platform fee of this contract.
21+
Get the contract platform fees
2222

2323
```python
2424
platform_fees = contract.platform_fee.get()
@@ -38,7 +38,7 @@ the platform fee.
3838
def set(platform_fee_info: ContractPlatformFeeSchema) -> TxReceipt
3939
```
4040

41-
Set the platform fee of this contract.
41+
Set the contract platform fees
4242

4343
```python
4444
from thirdweb.types import ContractPlatformFeeSchema

docs/docs/contract-roles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ list of members of the role
6565
def grant(role: Role, address: str) -> TxReceipt
6666
```
6767

68-
Grant a role to an address.
68+
Grant a role to a wallet
6969

7070
```python
7171
from thirdweb.constants.role import Role
@@ -93,7 +93,7 @@ transaction receipt of granting the role
9393
def revoke(role: Role, address: str) -> TxReceipt
9494
```
9595

96-
Revoke a role from an address.
96+
Revoke a role from a wallet
9797

9898
```python
9999
from thirdweb.constants.role import Role

docs/docs/contract-royalty.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class ContractRoyalty(Generic[TRoyaltyABI])
1818
def get_default_royalty_info() -> ContractRoyaltySchema
1919
```
2020

21-
Get the default royalty information for this contract.
21+
Get the royalty recipient and fee
2222

2323
```python
2424
royalty_info = contract.royalties.get_default_royalty_info()
@@ -37,7 +37,7 @@ the default royalty information.
3737
def get_token_royalty_info(token_id: int) -> ContractRoyaltySchema
3838
```
3939

40-
Get the royalty information for a specific token.
40+
Get the royalty recipient and fee for a specific token
4141

4242
```python
4343
token_id = 0
@@ -62,7 +62,7 @@ the royalty information for the token.
6262
def set_default_royalty_info(royalty_data: ContractRoyaltySchema) -> TxReceipt
6363
```
6464

65-
Set the default royalty information for this contract.
65+
Set the royalty recipient and fee
6666

6767
```python
6868
from thirdweb.types import ContractRoyaltySchema
@@ -92,7 +92,7 @@ def set_token_royalty_info(token_id: int,
9292
royalty_data: ContractRoyaltySchema) -> TxReceipt
9393
```
9494

95-
Set the royalty information for a specific token.
95+
Set the royalty recipient and fee for a specific token
9696

9797
```python
9898
from thirdweb.types import ContractRoyaltySchema

docs/docs/contract-sales.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class ContractPrimarySale(Generic[TPrimarySaleABI])
1818
def get_recipient() -> str
1919
```
2020

21-
Get the primary sale recipient of this contract.
21+
Get the contract primary sale recipient
2222

2323
```python
2424
primary_sale_recipient = contract.sales.get_recipient()
@@ -37,7 +37,7 @@ the address of the primary sale recipient.
3737
def set_recipient(recipient: str) -> TxReceipt
3838
```
3939

40-
Set the primary sale recipient of this contract
40+
Set the contract primary sale recipient
4141

4242
```python
4343
primary_sale_recipient = "{{wallet_address}}"

docs/docs/erc1155.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class ERC1155(Generic[TERC1155], BaseContract[TERC1155])
1818
def get(token_id: int) -> EditionMetadata
1919
```
2020

21-
Get metadata for a token
21+
Get an NFT
2222

2323
```python
2424
nft = contract.erc1155.get(0)
@@ -42,7 +42,7 @@ def get_all(query_params: QueryAllParams = QueryAllParams()
4242
) -> List[EditionMetadata]
4343
```
4444

45-
Get the metadata for all tokens on the contract
45+
Get all NFTs
4646

4747
```python
4848
metadatas = contract.erc1155.get_all()
@@ -65,7 +65,7 @@ list of metadata for all tokens
6565
def get_total_count() -> int
6666
```
6767

68-
Get the total number of NFTs on the contract
68+
Get the total number of NFTs
6969

7070
```python
7171
total_count = contract.erc1155.get_total_count()
@@ -84,7 +84,7 @@ total number of tokens on the contract
8484
def get_owned(address: str = "") -> List[EditionMetadataOwner]
8585
```
8686

87-
Get the metadata for all the tokens owned by an address
87+
Get NFTs owned by a specific wallet
8888

8989
```python
9090
address = "{{wallet_address}}"
@@ -108,7 +108,7 @@ list of metadata for all tokens owned by the address
108108
def total_supply(token_id: int) -> int
109109
```
110110

111-
Get the total number of tokens on the contract
111+
Get the total number of NFTs
112112

113113
```python
114114
token_id = 0
@@ -129,7 +129,7 @@ total number of tokens on the contract
129129
def balance(token_id: int) -> int
130130
```
131131

132-
Get the connected wallets balance of a specific token
132+
Get NFT balance
133133

134134
```python
135135
token_id = 0
@@ -154,7 +154,7 @@ balance of the token
154154
def balance_of(address: str, token_id: int) -> int
155155
```
156156

157-
Get a specific wallets balance of a specific token
157+
Get NFT balance of a specific wallet
158158

159159
```python
160160
address = "{{wallet_address}}"
@@ -199,7 +199,7 @@ True if the contract is restricted, False otherwise
199199
def is_approved(address: str, operator: str) -> bool
200200
```
201201

202-
Check if an operator address is approved to manage a target addresses assets
202+
Check approval of a specific wallet
203203

204204
```python
205205
address = "{{wallet_address}}"
@@ -229,7 +229,7 @@ def transfer(to: str,
229229
data: Union[bytes, str] = b"0") -> TxReceipt
230230
```
231231

232-
Transfer a specified token from the connected wallet to a specified address.
232+
Transfer NFTs
233233

234234
```python
235235
to = "{{wallet_address}}"
@@ -257,7 +257,7 @@ transaction receipt of the transfer
257257
def burn(token_id: int, amount: int) -> TxReceipt
258258
```
259259

260-
Burn a specified amount of tokens from the connected wallet.
260+
Burn NFTs
261261

262262
```python
263263
token_id = 0
@@ -282,7 +282,7 @@ transaction receipt of the burn
282282
def set_approval_for_all(operator: str, approved: bool) -> TxReceipt
283283
```
284284

285-
Set the approval for an operator address to manage the connected wallets assets
285+
Set approval for all NFTs
286286

287287
```python
288288
operator = "{{wallet_address}}"
@@ -306,7 +306,7 @@ def mint(
306306
) -> TxResultWithId[EditionMetadata]
307307
```
308308

309-
Mint a new NFT to the connected wallet
309+
Mint a new NFT
310310

311311
```python
312312
from thirdweb.types.nft import NFTMetadataInput, EditionMetadataInput
@@ -346,7 +346,7 @@ def mint_to(
346346
) -> TxResultWithId[EditionMetadata]
347347
```
348348

349-
Mint a new NFT to the specified wallet
349+
Mint a new NFT to a specific wallet
350350

351351
```python
352352
from thirdweb.types.nft import NFTMetadataInput, EditionMetadataInput
@@ -387,7 +387,7 @@ def mint_additional_supply(
387387
additional_supply: int) -> TxResultWithId[EditionMetadata]
388388
```
389389

390-
Mint additional supply of a token to the connected wallet
390+
Mint additional supply of an NFT
391391

392392
```python
393393
token_id = 0
@@ -418,7 +418,7 @@ def mint_additional_supply_to(
418418
additional_supply: int) -> TxResultWithId[EditionMetadata]
419419
```
420420

421-
Mint additional supply of a token to the specified wallet
421+
Mint additional supply of an NFT to a specific wallet
422422

423423
```python
424424
to = "{{wallet_address}}"
@@ -451,7 +451,7 @@ def mint_batch(
451451
) -> List[TxResultWithId[EditionMetadata]]
452452
```
453453

454-
Mint a batch of NFTs to the connected wallet
454+
Mint many NFTs
455455

456456
```python
457457
from thirdweb.types.nft import NFTMetadataInput, EditionMetadataInput
@@ -501,7 +501,7 @@ def mint_batch_to(
501501
) -> List[TxResultWithId[EditionMetadata]]
502502
```
503503

504-
Mint a batch of NFTs to the specified wallet
504+
Mint many NFTs to a specific wallet
505505

506506
```python
507507
from thirdweb.types.nft import NFTMetadataInput, EditionMetadataInput
@@ -552,7 +552,7 @@ def create_batch(
552552
) -> List[TxResultWithId[NFTMetadata]]
553553
```
554554

555-
Create a batch of NFTs.
555+
Lazy mint NFTs
556556

557557
```python
558558
from thirdweb.types.nft import NFTMetadataInput, EditionMetadataInput
@@ -599,7 +599,7 @@ def claim_to(destination_address: str, token_id: int,
599599
quantity: int) -> TxReceipt
600600
```
601601

602-
Claim NFTs to a destination address.
602+
Claim NFTs to a specific wallet
603603

604604
```python
605605
address = {{wallet_address}}
@@ -631,7 +631,7 @@ tx receipt of the claim
631631
def claim(token_id: int, quantity: int) -> TxReceipt
632632
```
633633

634-
Claim NFTs.
634+
Claim NFTs
635635

636636
```python
637637
token_id = 0

0 commit comments

Comments
 (0)