GitBross Home Explore Help
Register Sign In
sol_Bo8des9o
/
openzeppelin-contracts
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 0dda004024
Branches Tags
openzeppelin-co...
/
docs
/
modules
/
api
/
pages
/
token
/
ERC1155.adoc

ERC1155.adoc 84 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545 
  1. :github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
    2. 

  2. :IERC1155: pass:normal[xref:token/ERC1155.adoc#IERC1155[`IERC1155`]]
    3. 

  3. :IERC1155MetadataURI: pass:normal[xref:token/ERC1155.adoc#IERC1155MetadataURI[`IERC1155MetadataURI`]]
    4. 

  4. :IERC1155Receiver: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver[`IERC1155Receiver`]]
    5. 

  5. :ERC1155: pass:normal[xref:token/ERC1155.adoc#ERC1155[`ERC1155`]]
    6. 

  6. :IERC1155: pass:normal[xref:token/ERC1155.adoc#IERC1155[`IERC1155`]]
    7. 

  7. :IERC1155MetadataURI: pass:normal[xref:token/ERC1155.adoc#IERC1155MetadataURI[`IERC1155MetadataURI`]]
    8. 

  8. :ERC1155Pausable: pass:normal[xref:token/ERC1155.adoc#ERC1155Pausable[`ERC1155Pausable`]]
    9. 

  9. :ERC1155Burnable: pass:normal[xref:token/ERC1155.adoc#ERC1155Burnable[`ERC1155Burnable`]]
    10. 

  10. :xref-IERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#IERC1155-balanceOf-address-uint256-
    11. 

  11. :xref-IERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#IERC1155-balanceOfBatch-address---uint256---
    12. 

  12. :xref-IERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#IERC1155-setApprovalForAll-address-bool-
    13. 

  13. :xref-IERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#IERC1155-isApprovedForAll-address-address-
    14. 

  14. :xref-IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    15. 

  15. :xref-IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    16. 

  16. :xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
    17. 

  17. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    18. 

  18. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    19. 

  19. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    20. 

  20. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    21. 

  21. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    22. 

  22. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
    23. 

  23. :IERC1155MetadataURI-uri: pass:normal[xref:token/ERC1155.adoc#IERC1155MetadataURI-uri-uint256-[`IERC1155MetadataURI.uri`]]
    24. 

  24. :xref-IERC1155MetadataURI-uri-uint256-: xref:token/ERC1155.adoc#IERC1155MetadataURI-uri-uint256-
    25. 

  25. :xref-IERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#IERC1155-balanceOf-address-uint256-
    26. 

  26. :xref-IERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#IERC1155-balanceOfBatch-address---uint256---
    27. 

  27. :xref-IERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#IERC1155-setApprovalForAll-address-bool-
    28. 

  28. :xref-IERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#IERC1155-isApprovedForAll-address-address-
    29. 

  29. :xref-IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    30. 

  30. :xref-IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    31. 

  31. :xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
    32. 

  32. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    33. 

  33. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    34. 

  34. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    35. 

  35. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    36. 

  36. :xref-ERC1155-constructor-string-: xref:token/ERC1155.adoc#ERC1155-constructor-string-
    37. 

  37. :xref-ERC1155-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155-supportsInterface-bytes4-
    38. 

  38. :xref-ERC1155-uri-uint256-: xref:token/ERC1155.adoc#ERC1155-uri-uint256-
    39. 

  39. :xref-ERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#ERC1155-balanceOf-address-uint256-
    40. 

  40. :xref-ERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#ERC1155-balanceOfBatch-address---uint256---
    41. 

  41. :xref-ERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#ERC1155-setApprovalForAll-address-bool-
    42. 

  42. :xref-ERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#ERC1155-isApprovedForAll-address-address-
    43. 

  43. :xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    44. 

  44. :xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    45. 

  45. :xref-ERC1155-_update-address-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_update-address-address-uint256---uint256---
    46. 

  46. :xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-
    47. 

  47. :xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-
    48. 

  48. :xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    49. 

  49. :xref-ERC1155-_setURI-string-: xref:token/ERC1155.adoc#ERC1155-_setURI-string-
    50. 

  50. :xref-ERC1155-_mint-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_mint-address-uint256-uint256-bytes-
    51. 

  51. :xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_mintBatch-address-uint256---uint256---bytes-
    52. 

  52. :xref-ERC1155-_burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155-_burn-address-uint256-uint256-
    53. 

  53. :xref-ERC1155-_burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_burnBatch-address-uint256---uint256---
    54. 

  54. :xref-ERC1155-_setApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#ERC1155-_setApprovalForAll-address-address-bool-
    55. 

  55. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    56. 

  56. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    57. 

  57. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    58. 

  58. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    59. 

  59. :xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-
    60. 

  60. :xref-IERC1155Errors-ERC1155InvalidSender-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidSender-address-
    61. 

  61. :xref-IERC1155Errors-ERC1155InvalidReceiver-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidReceiver-address-
    62. 

  62. :xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155MissingApprovalForAll-address-address-
    63. 

  63. :xref-IERC1155Errors-ERC1155InvalidApprover-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidApprover-address-
    64. 

  64. :xref-IERC1155Errors-ERC1155InvalidOperator-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidOperator-address-
    65. 

  65. :xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-
    66. 

  66. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
    67. 

  67. :IERC1155MetadataURI-uri: pass:normal[xref:token/ERC1155.adoc#IERC1155MetadataURI-uri-uint256-[`IERC1155MetadataURI.uri`]]
    68. 

  68. :IERC1155-balanceOf: pass:normal[xref:token/ERC1155.adoc#IERC1155-balanceOf-address-uint256-[`IERC1155.balanceOf`]]
    69. 

  69. :IERC1155-balanceOfBatch: pass:normal[xref:token/ERC1155.adoc#IERC1155-balanceOfBatch-address---uint256---[`IERC1155.balanceOfBatch`]]
    70. 

  70. :IERC1155-setApprovalForAll: pass:normal[xref:token/ERC1155.adoc#IERC1155-setApprovalForAll-address-bool-[`IERC1155.setApprovalForAll`]]
    71. 

  71. :IERC1155-isApprovedForAll: pass:normal[xref:token/ERC1155.adoc#IERC1155-isApprovedForAll-address-address-[`IERC1155.isApprovedForAll`]]
    72. 

  72. :IERC1155-safeTransferFrom: pass:normal[xref:token/ERC1155.adoc#IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-[`IERC1155.safeTransferFrom`]]
    73. 

  73. :IERC1155-safeBatchTransferFrom: pass:normal[xref:token/ERC1155.adoc#IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-[`IERC1155.safeBatchTransferFrom`]]
    74. 

  74. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    75. 

  75. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
    76. 

  76. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    77. 

  77. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
    78. 

  78. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    79. 

  79. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
    80. 

  80. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    81. 

  81. :IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
    82. 

  82. :xref-IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-
    83. 

  83. :xref-IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
    84. 

  84. :xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
    85. 

  85. :Pausable-_pause: pass:normal[xref:utils.adoc#Pausable-_pause--[`Pausable._pause`]]
    86. 

  86. :Pausable-_unpause: pass:normal[xref:utils.adoc#Pausable-_unpause--[`Pausable._unpause`]]
    87. 

  87. :AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
    88. 

  88. :Ownable: pass:normal[xref:access.adoc#Ownable[`Ownable`]]
    89. 

  89. :xref-ERC1155Pausable-_update-address-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155Pausable-_update-address-address-uint256---uint256---
    90. 

  90. :xref-Pausable-paused--: xref:utils.adoc#Pausable-paused--
    91. 

  91. :xref-Pausable-_requireNotPaused--: xref:utils.adoc#Pausable-_requireNotPaused--
    92. 

  92. :xref-Pausable-_requirePaused--: xref:utils.adoc#Pausable-_requirePaused--
    93. 

  93. :xref-Pausable-_pause--: xref:utils.adoc#Pausable-_pause--
    94. 

  94. :xref-Pausable-_unpause--: xref:utils.adoc#Pausable-_unpause--
    95. 

  95. :xref-ERC1155-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155-supportsInterface-bytes4-
    96. 

  96. :xref-ERC1155-uri-uint256-: xref:token/ERC1155.adoc#ERC1155-uri-uint256-
    97. 

  97. :xref-ERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#ERC1155-balanceOf-address-uint256-
    98. 

  98. :xref-ERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#ERC1155-balanceOfBatch-address---uint256---
    99. 

  99. :xref-ERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#ERC1155-setApprovalForAll-address-bool-
    100. 

  100. :xref-ERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#ERC1155-isApprovedForAll-address-address-
    101. 

  101. :xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    102. 

  102. :xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    103. 

  103. :xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-
    104. 

  104. :xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-
    105. 

  105. :xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    106. 

  106. :xref-ERC1155-_setURI-string-: xref:token/ERC1155.adoc#ERC1155-_setURI-string-
    107. 

  107. :xref-ERC1155-_mint-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_mint-address-uint256-uint256-bytes-
    108. 

  108. :xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_mintBatch-address-uint256---uint256---bytes-
    109. 

  109. :xref-ERC1155-_burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155-_burn-address-uint256-uint256-
    110. 

  110. :xref-ERC1155-_burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_burnBatch-address-uint256---uint256---
    111. 

  111. :xref-ERC1155-_setApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#ERC1155-_setApprovalForAll-address-address-bool-
    112. 

  112. :xref-Pausable-Paused-address-: xref:utils.adoc#Pausable-Paused-address-
    113. 

  113. :xref-Pausable-Unpaused-address-: xref:utils.adoc#Pausable-Unpaused-address-
    114. 

  114. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    115. 

  115. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    116. 

  116. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    117. 

  117. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    118. 

  118. :xref-Pausable-EnforcedPause--: xref:utils.adoc#Pausable-EnforcedPause--
    119. 

  119. :xref-Pausable-ExpectedPause--: xref:utils.adoc#Pausable-ExpectedPause--
    120. 

  120. :xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-
    121. 

  121. :xref-IERC1155Errors-ERC1155InvalidSender-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidSender-address-
    122. 

  122. :xref-IERC1155Errors-ERC1155InvalidReceiver-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidReceiver-address-
    123. 

  123. :xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155MissingApprovalForAll-address-address-
    124. 

  124. :xref-IERC1155Errors-ERC1155InvalidApprover-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidApprover-address-
    125. 

  125. :xref-IERC1155Errors-ERC1155InvalidOperator-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidOperator-address-
    126. 

  126. :xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-
    127. 

  127. :ERC1155-_update: pass:normal[xref:token/ERC1155.adoc#ERC1155-_update-address-address-uint256---uint256---[`ERC1155._update`]]
    128. 

  128. :ERC1155: pass:normal[xref:token/ERC1155.adoc#ERC1155[`ERC1155`]]
    129. 

  129. :xref-ERC1155Burnable-burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155Burnable-burn-address-uint256-uint256-
    130. 

  130. :xref-ERC1155Burnable-burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155Burnable-burnBatch-address-uint256---uint256---
    131. 

  131. :xref-ERC1155-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155-supportsInterface-bytes4-
    132. 

  132. :xref-ERC1155-uri-uint256-: xref:token/ERC1155.adoc#ERC1155-uri-uint256-
    133. 

  133. :xref-ERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#ERC1155-balanceOf-address-uint256-
    134. 

  134. :xref-ERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#ERC1155-balanceOfBatch-address---uint256---
    135. 

  135. :xref-ERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#ERC1155-setApprovalForAll-address-bool-
    136. 

  136. :xref-ERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#ERC1155-isApprovedForAll-address-address-
    137. 

  137. :xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    138. 

  138. :xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    139. 

  139. :xref-ERC1155-_update-address-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_update-address-address-uint256---uint256---
    140. 

  140. :xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-
    141. 

  141. :xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-
    142. 

  142. :xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    143. 

  143. :xref-ERC1155-_setURI-string-: xref:token/ERC1155.adoc#ERC1155-_setURI-string-
    144. 

  144. :xref-ERC1155-_mint-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_mint-address-uint256-uint256-bytes-
    145. 

  145. :xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_mintBatch-address-uint256---uint256---bytes-
    146. 

  146. :xref-ERC1155-_burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155-_burn-address-uint256-uint256-
    147. 

  147. :xref-ERC1155-_burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_burnBatch-address-uint256---uint256---
    148. 

  148. :xref-ERC1155-_setApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#ERC1155-_setApprovalForAll-address-address-bool-
    149. 

  149. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    150. 

  150. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    151. 

  151. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    152. 

  152. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    153. 

  153. :xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-
    154. 

  154. :xref-IERC1155Errors-ERC1155InvalidSender-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidSender-address-
    155. 

  155. :xref-IERC1155Errors-ERC1155InvalidReceiver-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidReceiver-address-
    156. 

  156. :xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155MissingApprovalForAll-address-address-
    157. 

  157. :xref-IERC1155Errors-ERC1155InvalidApprover-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidApprover-address-
    158. 

  158. :xref-IERC1155Errors-ERC1155InvalidOperator-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidOperator-address-
    159. 

  159. :xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-
    160. 

  160. :xref-ERC1155Supply-totalSupply-uint256-: xref:token/ERC1155.adoc#ERC1155Supply-totalSupply-uint256-
    161. 

  161. :xref-ERC1155Supply-totalSupply--: xref:token/ERC1155.adoc#ERC1155Supply-totalSupply--
    162. 

  162. :xref-ERC1155Supply-exists-uint256-: xref:token/ERC1155.adoc#ERC1155Supply-exists-uint256-
    163. 

  163. :xref-ERC1155Supply-_update-address-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155Supply-_update-address-address-uint256---uint256---
    164. 

  164. :xref-ERC1155-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155-supportsInterface-bytes4-
    165. 

  165. :xref-ERC1155-uri-uint256-: xref:token/ERC1155.adoc#ERC1155-uri-uint256-
    166. 

  166. :xref-ERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#ERC1155-balanceOf-address-uint256-
    167. 

  167. :xref-ERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#ERC1155-balanceOfBatch-address---uint256---
    168. 

  168. :xref-ERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#ERC1155-setApprovalForAll-address-bool-
    169. 

  169. :xref-ERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#ERC1155-isApprovedForAll-address-address-
    170. 

  170. :xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    171. 

  171. :xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    172. 

  172. :xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-
    173. 

  173. :xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-
    174. 

  174. :xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    175. 

  175. :xref-ERC1155-_setURI-string-: xref:token/ERC1155.adoc#ERC1155-_setURI-string-
    176. 

  176. :xref-ERC1155-_mint-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_mint-address-uint256-uint256-bytes-
    177. 

  177. :xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_mintBatch-address-uint256---uint256---bytes-
    178. 

  178. :xref-ERC1155-_burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155-_burn-address-uint256-uint256-
    179. 

  179. :xref-ERC1155-_burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_burnBatch-address-uint256---uint256---
    180. 

  180. :xref-ERC1155-_setApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#ERC1155-_setApprovalForAll-address-address-bool-
    181. 

  181. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    182. 

  182. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    183. 

  183. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    184. 

  184. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    185. 

  185. :xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-
    186. 

  186. :xref-IERC1155Errors-ERC1155InvalidSender-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidSender-address-
    187. 

  187. :xref-IERC1155Errors-ERC1155InvalidReceiver-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidReceiver-address-
    188. 

  188. :xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155MissingApprovalForAll-address-address-
    189. 

  189. :xref-IERC1155Errors-ERC1155InvalidApprover-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidApprover-address-
    190. 

  190. :xref-IERC1155Errors-ERC1155InvalidOperator-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidOperator-address-
    191. 

  191. :xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-
    192. 

  192. :ERC1155-_update: pass:normal[xref:token/ERC1155.adoc#ERC1155-_update-address-address-uint256---uint256---[`ERC1155._update`]]
    193. 

  193. :ERC721URIStorage: pass:normal[xref:token/ERC721.adoc#ERC721URIStorage[`ERC721URIStorage`]]
    194. 

  194. :xref-ERC1155URIStorage-uri-uint256-: xref:token/ERC1155.adoc#ERC1155URIStorage-uri-uint256-
    195. 

  195. :xref-ERC1155URIStorage-_setURI-uint256-string-: xref:token/ERC1155.adoc#ERC1155URIStorage-_setURI-uint256-string-
    196. 

  196. :xref-ERC1155URIStorage-_setBaseURI-string-: xref:token/ERC1155.adoc#ERC1155URIStorage-_setBaseURI-string-
    197. 

  197. :xref-ERC1155-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155-supportsInterface-bytes4-
    198. 

  198. :xref-ERC1155-balanceOf-address-uint256-: xref:token/ERC1155.adoc#ERC1155-balanceOf-address-uint256-
    199. 

  199. :xref-ERC1155-balanceOfBatch-address---uint256---: xref:token/ERC1155.adoc#ERC1155-balanceOfBatch-address---uint256---
    200. 

  200. :xref-ERC1155-setApprovalForAll-address-bool-: xref:token/ERC1155.adoc#ERC1155-setApprovalForAll-address-bool-
    201. 

  201. :xref-ERC1155-isApprovedForAll-address-address-: xref:token/ERC1155.adoc#ERC1155-isApprovedForAll-address-address-
    202. 

  202. :xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-
    203. 

  203. :xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    204. 

  204. :xref-ERC1155-_update-address-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_update-address-address-uint256---uint256---
    205. 

  205. :xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-
    206. 

  206. :xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-
    207. 

  207. :xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-
    208. 

  208. :xref-ERC1155-_setURI-string-: xref:token/ERC1155.adoc#ERC1155-_setURI-string-
    209. 

  209. :xref-ERC1155-_mint-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155-_mint-address-uint256-uint256-bytes-
    210. 

  210. :xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155-_mintBatch-address-uint256---uint256---bytes-
    211. 

  211. :xref-ERC1155-_burn-address-uint256-uint256-: xref:token/ERC1155.adoc#ERC1155-_burn-address-uint256-uint256-
    212. 

  212. :xref-ERC1155-_burnBatch-address-uint256---uint256---: xref:token/ERC1155.adoc#ERC1155-_burnBatch-address-uint256---uint256---
    213. 

  213. :xref-ERC1155-_setApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#ERC1155-_setApprovalForAll-address-address-bool-
    214. 

  214. :xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-: xref:token/ERC1155.adoc#IERC1155-TransferSingle-address-address-address-uint256-uint256-
    215. 

  215. :xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---: xref:token/ERC1155.adoc#IERC1155-TransferBatch-address-address-address-uint256---uint256---
    216. 

  216. :xref-IERC1155-ApprovalForAll-address-address-bool-: xref:token/ERC1155.adoc#IERC1155-ApprovalForAll-address-address-bool-
    217. 

  217. :xref-IERC1155-URI-string-uint256-: xref:token/ERC1155.adoc#IERC1155-URI-string-uint256-
    218. 

  218. :xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-
    219. 

  219. :xref-IERC1155Errors-ERC1155InvalidSender-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidSender-address-
    220. 

  220. :xref-IERC1155Errors-ERC1155InvalidReceiver-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidReceiver-address-
    221. 

  221. :xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155MissingApprovalForAll-address-address-
    222. 

  222. :xref-IERC1155Errors-ERC1155InvalidApprover-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidApprover-address-
    223. 

  223. :xref-IERC1155Errors-ERC1155InvalidOperator-address-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidOperator-address-
    224. 

  224. :xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-: xref:interfaces.adoc#IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-
    225. 

  225. :IERC1155MetadataURI-uri: pass:normal[xref:token/ERC1155.adoc#IERC1155MetadataURI-uri-uint256-[`IERC1155MetadataURI.uri`]]
    226. 

  226. :xref-ERC1155Holder-supportsInterface-bytes4-: xref:token/ERC1155.adoc#ERC1155Holder-supportsInterface-bytes4-
    227. 

  227. :xref-ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-
    228. 

  228. :xref-ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
    229. 

  229. :IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
    230. 

  230. :xref-ERC1155Utils-checkOnERC1155Received-address-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#ERC1155Utils-checkOnERC1155Received-address-address-address-uint256-uint256-bytes-
    231. 

  231. :xref-ERC1155Utils-checkOnERC1155BatchReceived-address-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155Utils-checkOnERC1155BatchReceived-address-address-address-uint256---uint256---bytes-
    232. 

  232. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    233. 

  233. :IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
    234. 

  234. = ERC-1155
    235. 

  235. 

  236. [.readme-notice]
    237. 

  237. NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc1155
    238. 

  238. 

  239. This set of interfaces and contracts are all related to the https://eips.ethereum.org/EIPS/eip-1155[ERC-1155 Multi Token Standard].
    240. 

  240. 

  241. The ERC consists of three interfaces which fulfill different roles, found here as {IERC1155}, {IERC1155MetadataURI} and {IERC1155Receiver}.
    242. 

  242. 

  243. {ERC1155} implements the mandatory {IERC1155} interface, as well as the optional extension {IERC1155MetadataURI}, by relying on the substitution mechanism to use the same URI for all token types, dramatically reducing gas costs.
    244. 

  244. 

  245. Additionally there are multiple custom extensions, including:
    246. 

  246. 

  247. * designation of addresses that can pause token transfers for all users ({ERC1155Pausable}).
    248. 

  248. * destruction of own tokens ({ERC1155Burnable}).
    249. 

  249. 

  250. NOTE: This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC-1155 (such as <<ERC1155-_mint-address-uint256-uint256-bytes-,`_mint`>>) and expose them as external functions in the way they prefer.
    251. 

  251. 

  252. == Core
    253. 

  253. 

  254. :TransferSingle: pass:normal[xref:#IERC1155-TransferSingle-address-address-address-uint256-uint256-[`++TransferSingle++`]]
    255. 

  255. :TransferBatch: pass:normal[xref:#IERC1155-TransferBatch-address-address-address-uint256---uint256---[`++TransferBatch++`]]
    256. 

  256. :ApprovalForAll: pass:normal[xref:#IERC1155-ApprovalForAll-address-address-bool-[`++ApprovalForAll++`]]
    257. 

  257. :URI: pass:normal[xref:#IERC1155-URI-string-uint256-[`++URI++`]]
    258. 

  258. :balanceOf: pass:normal[xref:#IERC1155-balanceOf-address-uint256-[`++balanceOf++`]]
    259. 

  259. :balanceOfBatch: pass:normal[xref:#IERC1155-balanceOfBatch-address---uint256---[`++balanceOfBatch++`]]
    260. 

  260. :setApprovalForAll: pass:normal[xref:#IERC1155-setApprovalForAll-address-bool-[`++setApprovalForAll++`]]
    261. 

  261. :isApprovedForAll: pass:normal[xref:#IERC1155-isApprovedForAll-address-address-[`++isApprovedForAll++`]]
    262. 

  262. :safeTransferFrom: pass:normal[xref:#IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-[`++safeTransferFrom++`]]
    263. 

  263. :safeBatchTransferFrom: pass:normal[xref:#IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-[`++safeBatchTransferFrom++`]]
    264. 

  264. 

  265. [.contract]
    266. 

  266. [[IERC1155]]
    267. 

  267. === `++IERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/IERC1155.sol[{github-icon},role=heading-link]
    268. 

  268. 

  269. [.hljs-theme-light.nopadding]
    270. 

  270. ```solidity
    271. 

  271. import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
    272. 

  272. ```
    273. 

  273. 

  274. Required interface of an ERC-1155 compliant contract, as defined in the
    275. 

  275. https://eips.ethereum.org/EIPS/eip-1155[ERC].
    276. 

  276. 

  277. [.contract-index]
    278. 

  278. .Functions
    279. 

  279. --
    280. 

  280. * {xref-IERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    281. 

  281. * {xref-IERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    282. 

  282. * {xref-IERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    283. 

  283. * {xref-IERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    284. 

  284. * {xref-IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    285. 

  285. * {xref-IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    286. 

  286. 

  287. [.contract-subindex-inherited]
    288. 

  288. .IERC165
    289. 

  289. * {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    290. 

  290. 

  291. --
    292. 

  292. 

  293. [.contract-index]
    294. 

  294. .Events
    295. 

  295. --
    296. 

  296. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    297. 

  297. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    298. 

  298. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    299. 

  299. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    300. 

  300. 

  301. [.contract-subindex-inherited]
    302. 

  302. .IERC165
    303. 

  303. 

  304. --
    305. 

  305. 

  306. [.contract-item]
    307. 

  307. [[IERC1155-balanceOf-address-uint256-]]
    308. 

  308. ==== `[.contract-item-name]#++balanceOf++#++(address account, uint256 id) → uint256++` [.item-kind]#external#
    309. 

  309. 

  310. Returns the value of tokens of token type `id` owned by `account`.
    311. 

  311. 

  312. [.contract-item]
    313. 

  313. [[IERC1155-balanceOfBatch-address---uint256---]]
    314. 

  314. ==== `[.contract-item-name]#++balanceOfBatch++#++(address[] accounts, uint256[] ids) → uint256[]++` [.item-kind]#external#
    315. 

  315. 

  316. xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
    317. 

  317. 

  318. Requirements:
    319. 

  319. 

  320. - `accounts` and `ids` must have the same length.
    321. 

  321. 

  322. [.contract-item]
    323. 

  323. [[IERC1155-setApprovalForAll-address-bool-]]
    324. 

  324. ==== `[.contract-item-name]#++setApprovalForAll++#++(address operator, bool approved)++` [.item-kind]#external#
    325. 

  325. 

  326. Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
    327. 

  327. 

  328. Emits an {ApprovalForAll} event.
    329. 

  329. 

  330. Requirements:
    331. 

  331. 

  332. - `operator` cannot be the zero address.
    333. 

  333. 

  334. [.contract-item]
    335. 

  335. [[IERC1155-isApprovedForAll-address-address-]]
    336. 

  336. ==== `[.contract-item-name]#++isApprovedForAll++#++(address account, address operator) → bool++` [.item-kind]#external#
    337. 

  337. 

  338. Returns true if `operator` is approved to transfer ``account``'s tokens.
    339. 

  339. 

  340. See {setApprovalForAll}.
    341. 

  341. 

  342. [.contract-item]
    343. 

  343. [[IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-]]
    344. 

  344. ==== `[.contract-item-name]#++safeTransferFrom++#++(address from, address to, uint256 id, uint256 value, bytes data)++` [.item-kind]#external#
    345. 

  345. 

  346. Transfers a `value` amount of tokens of type `id` from `from` to `to`.
    347. 

  347. 

  348. WARNING: This function can potentially allow a reentrancy attack when transferring tokens
    349. 

  349. to an untrusted contract, when invoking {onERC1155Received} on the receiver.
    350. 

  350. Ensure to follow the checks-effects-interactions pattern and consider employing
    351. 

  351. reentrancy guards when interacting with untrusted contracts.
    352. 

  352. 

  353. Emits a {TransferSingle} event.
    354. 

  354. 

  355. Requirements:
    356. 

  356. 

  357. - `to` cannot be the zero address.
    358. 

  358. - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
    359. 

  359. - `from` must have a balance of tokens of type `id` of at least `value` amount.
    360. 

  360. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
    361. 

  361. acceptance magic value.
    362. 

  362. 

  363. [.contract-item]
    364. 

  364. [[IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-]]
    365. 

  365. ==== `[.contract-item-name]#++safeBatchTransferFrom++#++(address from, address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#external#
    366. 

  366. 

  367. xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
    368. 

  368. 

  369. WARNING: This function can potentially allow a reentrancy attack when transferring tokens
    370. 

  370. to an untrusted contract, when invoking {onERC1155BatchReceived} on the receiver.
    371. 

  371. Ensure to follow the checks-effects-interactions pattern and consider employing
    372. 

  372. reentrancy guards when interacting with untrusted contracts.
    373. 

  373. 

  374. Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
    375. 

  375. 

  376. Requirements:
    377. 

  377. 

  378. - `ids` and `values` must have the same length.
    379. 

  379. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
    380. 

  380. acceptance magic value.
    381. 

  381. 

  382. [.contract-item]
    383. 

  383. [[IERC1155-TransferSingle-address-address-address-uint256-uint256-]]
    384. 

  384. ==== `[.contract-item-name]#++TransferSingle++#++(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value)++` [.item-kind]#event#
    385. 

  385. 

  386. Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
    387. 

  387. 

  388. [.contract-item]
    389. 

  389. [[IERC1155-TransferBatch-address-address-address-uint256---uint256---]]
    390. 

  390. ==== `[.contract-item-name]#++TransferBatch++#++(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values)++` [.item-kind]#event#
    391. 

  391. 

  392. Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
    393. 

  393. transfers.
    394. 

  394. 

  395. [.contract-item]
    396. 

  396. [[IERC1155-ApprovalForAll-address-address-bool-]]
    397. 

  397. ==== `[.contract-item-name]#++ApprovalForAll++#++(address indexed account, address indexed operator, bool approved)++` [.item-kind]#event#
    398. 

  398. 

  399. Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
    400. 

  400. `approved`.
    401. 

  401. 

  402. [.contract-item]
    403. 

  403. [[IERC1155-URI-string-uint256-]]
    404. 

  404. ==== `[.contract-item-name]#++URI++#++(string value, uint256 indexed id)++` [.item-kind]#event#
    405. 

  405. 

  406. Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
    407. 

  407. 

  408. If an {URI} event was emitted for `id`, the standard
    409. 

  409. https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
    410. 

  410. returned by {IERC1155MetadataURI-uri}.
    411. 

  411. 

  412. :uri: pass:normal[xref:#IERC1155MetadataURI-uri-uint256-[`++uri++`]]
    413. 

  413. 

  414. [.contract]
    415. 

  415. [[IERC1155MetadataURI]]
    416. 

  416. === `++IERC1155MetadataURI++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol[{github-icon},role=heading-link]
    417. 

  417. 

  418. [.hljs-theme-light.nopadding]
    419. 

  419. ```solidity
    420. 

  420. import "@openzeppelin/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol";
    421. 

  421. ```
    422. 

  422. 

  423. Interface of the optional ERC1155MetadataExtension interface, as defined
    424. 

  424. in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[ERC].
    425. 

  425. 

  426. [.contract-index]
    427. 

  427. .Functions
    428. 

  428. --
    429. 

  429. * {xref-IERC1155MetadataURI-uri-uint256-}[`++uri(id)++`]
    430. 

  430. 

  431. [.contract-subindex-inherited]
    432. 

  432. .IERC1155
    433. 

  433. * {xref-IERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    434. 

  434. * {xref-IERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    435. 

  435. * {xref-IERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    436. 

  436. * {xref-IERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    437. 

  437. * {xref-IERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    438. 

  438. * {xref-IERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    439. 

  439. 

  440. [.contract-subindex-inherited]
    441. 

  441. .IERC165
    442. 

  442. * {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    443. 

  443. 

  444. --
    445. 

  445. 

  446. [.contract-index]
    447. 

  447. .Events
    448. 

  448. --
    449. 

  449. 

  450. [.contract-subindex-inherited]
    451. 

  451. .IERC1155
    452. 

  452. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    453. 

  453. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    454. 

  454. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    455. 

  455. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    456. 

  456. 

  457. [.contract-subindex-inherited]
    458. 

  458. .IERC165
    459. 

  459. 

  460. --
    461. 

  461. 

  462. [.contract-item]
    463. 

  463. [[IERC1155MetadataURI-uri-uint256-]]
    464. 

  464. ==== `[.contract-item-name]#++uri++#++(uint256 id) → string++` [.item-kind]#external#
    465. 

  465. 

  466. Returns the URI for token type `id`.
    467. 

  467. 

  468. If the `\{id\}` substring is present in the URI, it must be replaced by
    469. 

  469. clients with the actual token type ID.
    470. 

  470. 

  471. :constructor: pass:normal[xref:#ERC1155-constructor-string-[`++constructor++`]]
    472. 

  472. :supportsInterface: pass:normal[xref:#ERC1155-supportsInterface-bytes4-[`++supportsInterface++`]]
    473. 

  473. :uri: pass:normal[xref:#ERC1155-uri-uint256-[`++uri++`]]
    474. 

  474. :balanceOf: pass:normal[xref:#ERC1155-balanceOf-address-uint256-[`++balanceOf++`]]
    475. 

  475. :balanceOfBatch: pass:normal[xref:#ERC1155-balanceOfBatch-address---uint256---[`++balanceOfBatch++`]]
    476. 

  476. :setApprovalForAll: pass:normal[xref:#ERC1155-setApprovalForAll-address-bool-[`++setApprovalForAll++`]]
    477. 

  477. :isApprovedForAll: pass:normal[xref:#ERC1155-isApprovedForAll-address-address-[`++isApprovedForAll++`]]
    478. 

  478. :safeTransferFrom: pass:normal[xref:#ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-[`++safeTransferFrom++`]]
    479. 

  479. :safeBatchTransferFrom: pass:normal[xref:#ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-[`++safeBatchTransferFrom++`]]
    480. 

  480. :_update: pass:normal[xref:#ERC1155-_update-address-address-uint256---uint256---[`++_update++`]]
    481. 

  481. :_updateWithAcceptanceCheck: pass:normal[xref:#ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-[`++_updateWithAcceptanceCheck++`]]
    482. 

  482. :_safeTransferFrom: pass:normal[xref:#ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-[`++_safeTransferFrom++`]]
    483. 

  483. :_safeBatchTransferFrom: pass:normal[xref:#ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-[`++_safeBatchTransferFrom++`]]
    484. 

  484. :_setURI: pass:normal[xref:#ERC1155-_setURI-string-[`++_setURI++`]]
    485. 

  485. :_mint: pass:normal[xref:#ERC1155-_mint-address-uint256-uint256-bytes-[`++_mint++`]]
    486. 

  486. :_mintBatch: pass:normal[xref:#ERC1155-_mintBatch-address-uint256---uint256---bytes-[`++_mintBatch++`]]
    487. 

  487. :_burn: pass:normal[xref:#ERC1155-_burn-address-uint256-uint256-[`++_burn++`]]
    488. 

  488. :_burnBatch: pass:normal[xref:#ERC1155-_burnBatch-address-uint256---uint256---[`++_burnBatch++`]]
    489. 

  489. :_setApprovalForAll: pass:normal[xref:#ERC1155-_setApprovalForAll-address-address-bool-[`++_setApprovalForAll++`]]
    490. 

  490. 

  491. [.contract]
    492. 

  492. [[ERC1155]]
    493. 

  493. === `++ERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/ERC1155.sol[{github-icon},role=heading-link]
    494. 

  494. 

  495. [.hljs-theme-light.nopadding]
    496. 

  496. ```solidity
    497. 

  497. import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
    498. 

  498. ```
    499. 

  499. 

  500. Implementation of the basic standard multi-token.
    501. 

  501. See https://eips.ethereum.org/EIPS/eip-1155
    502. 

  502. Originally based on code by Enjin: https://github.com/enjin/erc-1155
    503. 

  503. 

  504. [.contract-index]
    505. 

  505. .Functions
    506. 

  506. --
    507. 

  507. * {xref-ERC1155-constructor-string-}[`++constructor(uri_)++`]
    508. 

  508. * {xref-ERC1155-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    509. 

  509. * {xref-ERC1155-uri-uint256-}[`++uri()++`]
    510. 

  510. * {xref-ERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    511. 

  511. * {xref-ERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    512. 

  512. * {xref-ERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    513. 

  513. * {xref-ERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    514. 

  514. * {xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    515. 

  515. * {xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    516. 

  516. * {xref-ERC1155-_update-address-address-uint256---uint256---}[`++_update(from, to, ids, values)++`]
    517. 

  517. * {xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-}[`++_updateWithAcceptanceCheck(from, to, ids, values, data)++`]
    518. 

  518. * {xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-}[`++_safeTransferFrom(from, to, id, value, data)++`]
    519. 

  519. * {xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++_safeBatchTransferFrom(from, to, ids, values, data)++`]
    520. 

  520. * {xref-ERC1155-_setURI-string-}[`++_setURI(newuri)++`]
    521. 

  521. * {xref-ERC1155-_mint-address-uint256-uint256-bytes-}[`++_mint(to, id, value, data)++`]
    522. 

  522. * {xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-}[`++_mintBatch(to, ids, values, data)++`]
    523. 

  523. * {xref-ERC1155-_burn-address-uint256-uint256-}[`++_burn(from, id, value)++`]
    524. 

  524. * {xref-ERC1155-_burnBatch-address-uint256---uint256---}[`++_burnBatch(from, ids, values)++`]
    525. 

  525. * {xref-ERC1155-_setApprovalForAll-address-address-bool-}[`++_setApprovalForAll(owner, operator, approved)++`]
    526. 

  526. 

  527. [.contract-subindex-inherited]
    528. 

  528. .IERC1155Errors
    529. 

  529. 

  530. [.contract-subindex-inherited]
    531. 

  531. .IERC1155MetadataURI
    532. 

  532. 

  533. [.contract-subindex-inherited]
    534. 

  534. .IERC1155
    535. 

  535. 

  536. [.contract-subindex-inherited]
    537. 

  537. .ERC165
    538. 

  538. 

  539. [.contract-subindex-inherited]
    540. 

  540. .IERC165
    541. 

  541. 

  542. --
    543. 

  543. 

  544. [.contract-index]
    545. 

  545. .Events
    546. 

  546. --
    547. 

  547. 

  548. [.contract-subindex-inherited]
    549. 

  549. .IERC1155Errors
    550. 

  550. 

  551. [.contract-subindex-inherited]
    552. 

  552. .IERC1155MetadataURI
    553. 

  553. 

  554. [.contract-subindex-inherited]
    555. 

  555. .IERC1155
    556. 

  556. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    557. 

  557. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    558. 

  558. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    559. 

  559. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    560. 

  560. 

  561. [.contract-subindex-inherited]
    562. 

  562. .ERC165
    563. 

  563. 

  564. [.contract-subindex-inherited]
    565. 

  565. .IERC165
    566. 

  566. 

  567. --
    568. 

  568. 

  569. [.contract-index]
    570. 

  570. .Errors
    571. 

  571. --
    572. 

  572. 

  573. [.contract-subindex-inherited]
    574. 

  574. .IERC1155Errors
    575. 

  575. * {xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-}[`++ERC1155InsufficientBalance(sender, balance, needed, tokenId)++`]
    576. 

  576. * {xref-IERC1155Errors-ERC1155InvalidSender-address-}[`++ERC1155InvalidSender(sender)++`]
    577. 

  577. * {xref-IERC1155Errors-ERC1155InvalidReceiver-address-}[`++ERC1155InvalidReceiver(receiver)++`]
    578. 

  578. * {xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-}[`++ERC1155MissingApprovalForAll(operator, owner)++`]
    579. 

  579. * {xref-IERC1155Errors-ERC1155InvalidApprover-address-}[`++ERC1155InvalidApprover(approver)++`]
    580. 

  580. * {xref-IERC1155Errors-ERC1155InvalidOperator-address-}[`++ERC1155InvalidOperator(operator)++`]
    581. 

  581. * {xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-}[`++ERC1155InvalidArrayLength(idsLength, valuesLength)++`]
    582. 

  582. 

  583. [.contract-subindex-inherited]
    584. 

  584. .IERC1155MetadataURI
    585. 

  585. 

  586. [.contract-subindex-inherited]
    587. 

  587. .IERC1155
    588. 

  588. 

  589. [.contract-subindex-inherited]
    590. 

  590. .ERC165
    591. 

  591. 

  592. [.contract-subindex-inherited]
    593. 

  593. .IERC165
    594. 

  594. 

  595. --
    596. 

  596. 

  597. [.contract-item]
    598. 

  598. [[ERC1155-constructor-string-]]
    599. 

  599. ==== `[.contract-item-name]#++constructor++#++(string uri_)++` [.item-kind]#internal#
    600. 

  600. 

  601. See {_setURI}.
    602. 

  602. 

  603. [.contract-item]
    604. 

  604. [[ERC1155-supportsInterface-bytes4-]]
    605. 

  605. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
    606. 

  606. 

  607. See {IERC165-supportsInterface}.
    608. 

  608. 

  609. [.contract-item]
    610. 

  610. [[ERC1155-uri-uint256-]]
    611. 

  611. ==== `[.contract-item-name]#++uri++#++(uint256) → string++` [.item-kind]#public#
    612. 

  612. 

  613. See {IERC1155MetadataURI-uri}.
    614. 

  614. 

  615. This implementation returns the same URI for *all* token types. It relies
    616. 

  616. on the token type ID substitution mechanism
    617. 

  617. https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
    618. 

  618. 

  619. Clients calling this function must replace the `\{id\}` substring with the
    620. 

  620. actual token type ID.
    621. 

  621. 

  622. [.contract-item]
    623. 

  623. [[ERC1155-balanceOf-address-uint256-]]
    624. 

  624. ==== `[.contract-item-name]#++balanceOf++#++(address account, uint256 id) → uint256++` [.item-kind]#public#
    625. 

  625. 

  626. See {IERC1155-balanceOf}.
    627. 

  627. 

  628. [.contract-item]
    629. 

  629. [[ERC1155-balanceOfBatch-address---uint256---]]
    630. 

  630. ==== `[.contract-item-name]#++balanceOfBatch++#++(address[] accounts, uint256[] ids) → uint256[]++` [.item-kind]#public#
    631. 

  631. 

  632. See {IERC1155-balanceOfBatch}.
    633. 

  633. 

  634. Requirements:
    635. 

  635. 

  636. - `accounts` and `ids` must have the same length.
    637. 

  637. 

  638. [.contract-item]
    639. 

  639. [[ERC1155-setApprovalForAll-address-bool-]]
    640. 

  640. ==== `[.contract-item-name]#++setApprovalForAll++#++(address operator, bool approved)++` [.item-kind]#public#
    641. 

  641. 

  642. See {IERC1155-setApprovalForAll}.
    643. 

  643. 

  644. [.contract-item]
    645. 

  645. [[ERC1155-isApprovedForAll-address-address-]]
    646. 

  646. ==== `[.contract-item-name]#++isApprovedForAll++#++(address account, address operator) → bool++` [.item-kind]#public#
    647. 

  647. 

  648. See {IERC1155-isApprovedForAll}.
    649. 

  649. 

  650. [.contract-item]
    651. 

  651. [[ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-]]
    652. 

  652. ==== `[.contract-item-name]#++safeTransferFrom++#++(address from, address to, uint256 id, uint256 value, bytes data)++` [.item-kind]#public#
    653. 

  653. 

  654. See {IERC1155-safeTransferFrom}.
    655. 

  655. 

  656. [.contract-item]
    657. 

  657. [[ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-]]
    658. 

  658. ==== `[.contract-item-name]#++safeBatchTransferFrom++#++(address from, address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#public#
    659. 

  659. 

  660. See {IERC1155-safeBatchTransferFrom}.
    661. 

  661. 

  662. [.contract-item]
    663. 

  663. [[ERC1155-_update-address-address-uint256---uint256---]]
    664. 

  664. ==== `[.contract-item-name]#++_update++#++(address from, address to, uint256[] ids, uint256[] values)++` [.item-kind]#internal#
    665. 

  665. 

  666. Transfers a `value` amount of tokens of type `id` from `from` to `to`. Will mint (or burn) if `from`
    667. 

  667. (or `to`) is the zero address.
    668. 

  668. 

  669. Emits a {TransferSingle} event if the arrays contain one element, and {TransferBatch} otherwise.
    670. 

  670. 

  671. Requirements:
    672. 

  672. 

  673. - If `to` refers to a smart contract, it must implement either {IERC1155Receiver-onERC1155Received}
    674. 

  674.   or {IERC1155Receiver-onERC1155BatchReceived} and return the acceptance magic value.
    675. 

  675. - `ids` and `values` must have the same length.
    676. 

  676. 

  677. NOTE: The ERC-1155 acceptance check is not performed in this function. See {_updateWithAcceptanceCheck} instead.
    678. 

  678. 

  679. [.contract-item]
    680. 

  680. [[ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-]]
    681. 

  681. ==== `[.contract-item-name]#++_updateWithAcceptanceCheck++#++(address from, address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#internal#
    682. 

  682. 

  683. Version of {_update} that performs the token acceptance check by calling
    684. 

  684. {IERC1155Receiver-onERC1155Received} or {IERC1155Receiver-onERC1155BatchReceived} on the receiver address if it
    685. 

  685. contains code (eg. is a smart contract at the moment of execution).
    686. 

  686. 

  687. IMPORTANT: Overriding this function is discouraged because it poses a reentrancy risk from the receiver. So any
    688. 

  688. update to the contract state after this function would break the check-effect-interaction pattern. Consider
    689. 

  689. overriding {_update} instead.
    690. 

  690. 

  691. [.contract-item]
    692. 

  692. [[ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-]]
    693. 

  693. ==== `[.contract-item-name]#++_safeTransferFrom++#++(address from, address to, uint256 id, uint256 value, bytes data)++` [.item-kind]#internal#
    694. 

  694. 

  695. Transfers a `value` tokens of token type `id` from `from` to `to`.
    696. 

  696. 

  697. Emits a {TransferSingle} event.
    698. 

  698. 

  699. Requirements:
    700. 

  700. 

  701. - `to` cannot be the zero address.
    702. 

  702. - `from` must have a balance of tokens of type `id` of at least `value` amount.
    703. 

  703. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
    704. 

  704. acceptance magic value.
    705. 

  705. 

  706. [.contract-item]
    707. 

  707. [[ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-]]
    708. 

  708. ==== `[.contract-item-name]#++_safeBatchTransferFrom++#++(address from, address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#internal#
    709. 

  709. 

  710. xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
    711. 

  711. 

  712. Emits a {TransferBatch} event.
    713. 

  713. 

  714. Requirements:
    715. 

  715. 

  716. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
    717. 

  717. acceptance magic value.
    718. 

  718. - `ids` and `values` must have the same length.
    719. 

  719. 

  720. [.contract-item]
    721. 

  721. [[ERC1155-_setURI-string-]]
    722. 

  722. ==== `[.contract-item-name]#++_setURI++#++(string newuri)++` [.item-kind]#internal#
    723. 

  723. 

  724. Sets a new URI for all token types, by relying on the token type ID
    725. 

  725. substitution mechanism
    726. 

  726. https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
    727. 

  727. 

  728. By this mechanism, any occurrence of the `\{id\}` substring in either the
    729. 

  729. URI or any of the values in the JSON file at said URI will be replaced by
    730. 

  730. clients with the token type ID.
    731. 

  731. 

  732. For example, the `https://token-cdn-domain/\{id\}.json` URI would be
    733. 

  733. interpreted by clients as
    734. 

  734. `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
    735. 

  735. for token type ID 0x4cce0.
    736. 

  736. 

  737. See {uri}.
    738. 

  738. 

  739. Because these URIs cannot be meaningfully represented by the {URI} event,
    740. 

  740. this function emits no events.
    741. 

  741. 

  742. [.contract-item]
    743. 

  743. [[ERC1155-_mint-address-uint256-uint256-bytes-]]
    744. 

  744. ==== `[.contract-item-name]#++_mint++#++(address to, uint256 id, uint256 value, bytes data)++` [.item-kind]#internal#
    745. 

  745. 

  746. Creates a `value` amount of tokens of type `id`, and assigns them to `to`.
    747. 

  747. 

  748. Emits a {TransferSingle} event.
    749. 

  749. 

  750. Requirements:
    751. 

  751. 

  752. - `to` cannot be the zero address.
    753. 

  753. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
    754. 

  754. acceptance magic value.
    755. 

  755. 

  756. [.contract-item]
    757. 

  757. [[ERC1155-_mintBatch-address-uint256---uint256---bytes-]]
    758. 

  758. ==== `[.contract-item-name]#++_mintBatch++#++(address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#internal#
    759. 

  759. 

  760. xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
    761. 

  761. 

  762. Emits a {TransferBatch} event.
    763. 

  763. 

  764. Requirements:
    765. 

  765. 

  766. - `ids` and `values` must have the same length.
    767. 

  767. - `to` cannot be the zero address.
    768. 

  768. - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
    769. 

  769. acceptance magic value.
    770. 

  770. 

  771. [.contract-item]
    772. 

  772. [[ERC1155-_burn-address-uint256-uint256-]]
    773. 

  773. ==== `[.contract-item-name]#++_burn++#++(address from, uint256 id, uint256 value)++` [.item-kind]#internal#
    774. 

  774. 

  775. Destroys a `value` amount of tokens of type `id` from `from`
    776. 

  776. 

  777. Emits a {TransferSingle} event.
    778. 

  778. 

  779. Requirements:
    780. 

  780. 

  781. - `from` cannot be the zero address.
    782. 

  782. - `from` must have at least `value` amount of tokens of type `id`.
    783. 

  783. 

  784. [.contract-item]
    785. 

  785. [[ERC1155-_burnBatch-address-uint256---uint256---]]
    786. 

  786. ==== `[.contract-item-name]#++_burnBatch++#++(address from, uint256[] ids, uint256[] values)++` [.item-kind]#internal#
    787. 

  787. 

  788. xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
    789. 

  789. 

  790. Emits a {TransferBatch} event.
    791. 

  791. 

  792. Requirements:
    793. 

  793. 

  794. - `from` cannot be the zero address.
    795. 

  795. - `from` must have at least `value` amount of tokens of type `id`.
    796. 

  796. - `ids` and `values` must have the same length.
    797. 

  797. 

  798. [.contract-item]
    799. 

  799. [[ERC1155-_setApprovalForAll-address-address-bool-]]
    800. 

  800. ==== `[.contract-item-name]#++_setApprovalForAll++#++(address owner, address operator, bool approved)++` [.item-kind]#internal#
    801. 

  801. 

  802. Approve `operator` to operate on all of `owner` tokens
    803. 

  803. 

  804. Emits an {ApprovalForAll} event.
    805. 

  805. 

  806. Requirements:
    807. 

  807. 

  808. - `operator` cannot be the zero address.
    809. 

  809. 

  810. :onERC1155Received: pass:normal[xref:#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
    811. 

  811. :onERC1155BatchReceived: pass:normal[xref:#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
    812. 

  812. 

  813. [.contract]
    814. 

  814. [[IERC1155Receiver]]
    815. 

  815. === `++IERC1155Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/IERC1155Receiver.sol[{github-icon},role=heading-link]
    816. 

  816. 

  817. [.hljs-theme-light.nopadding]
    818. 

  818. ```solidity
    819. 

  819. import "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
    820. 

  820. ```
    821. 

  821. 

  822. Interface that must be implemented by smart contracts in order to receive
    823. 

  823. ERC-1155 token transfers.
    824. 

  824. 

  825. [.contract-index]
    826. 

  826. .Functions
    827. 

  827. --
    828. 

  828. * {xref-IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(operator, from, id, value, data)++`]
    829. 

  829. * {xref-IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(operator, from, ids, values, data)++`]
    830. 

  830. 

  831. [.contract-subindex-inherited]
    832. 

  832. .IERC165
    833. 

  833. * {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    834. 

  834. 

  835. --
    836. 

  836. 

  837. [.contract-item]
    838. 

  838. [[IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-]]
    839. 

  839. ==== `[.contract-item-name]#++onERC1155Received++#++(address operator, address from, uint256 id, uint256 value, bytes data) → bytes4++` [.item-kind]#external#
    840. 

  840. 

  841. Handles the receipt of a single ERC-1155 token type. This function is
    842. 

  842. called at the end of a `safeTransferFrom` after the balance has been updated.
    843. 

  843. 

  844. NOTE: To accept the transfer, this must return
    845. 

  845. `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
    846. 

  846. (i.e. 0xf23a6e61, or its own function selector).
    847. 

  847. 

  848. [.contract-item]
    849. 

  849. [[IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
    850. 

  850. ==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address operator, address from, uint256[] ids, uint256[] values, bytes data) → bytes4++` [.item-kind]#external#
    851. 

  851. 

  852. Handles the receipt of a multiple ERC-1155 token types. This function
    853. 

  853. is called at the end of a `safeBatchTransferFrom` after the balances have
    854. 

  854. been updated.
    855. 

  855. 

  856. NOTE: To accept the transfer(s), this must return
    857. 

  857. `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
    858. 

  858. (i.e. 0xbc197c81, or its own function selector).
    859. 

  859. 

  860. == Extensions
    861. 

  861. 

  862. :_update: pass:normal[xref:#ERC1155Pausable-_update-address-address-uint256---uint256---[`++_update++`]]
    863. 

  863. 

  864. [.contract]
    865. 

  865. [[ERC1155Pausable]]
    866. 

  866. === `++ERC1155Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/extensions/ERC1155Pausable.sol[{github-icon},role=heading-link]
    867. 

  867. 

  868. [.hljs-theme-light.nopadding]
    869. 

  869. ```solidity
    870. 

  870. import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Pausable.sol";
    871. 

  871. ```
    872. 

  872. 

  873. ERC-1155 token with pausable token transfers, minting and burning.
    874. 

  874. 

  875. Useful for scenarios such as preventing trades until the end of an evaluation
    876. 

  876. period, or having an emergency switch for freezing all token transfers in the
    877. 

  877. event of a large bug.
    878. 

  878. 

  879. IMPORTANT: This contract does not include public pause and unpause functions. In
    880. 

  880. addition to inheriting this contract, you must define both functions, invoking the
    881. 

  881. {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
    882. 

  882. access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
    883. 

  883. make the contract pause mechanism of the contract unreachable, and thus unusable.
    884. 

  884. 

  885. [.contract-index]
    886. 

  886. .Functions
    887. 

  887. --
    888. 

  888. * {xref-ERC1155Pausable-_update-address-address-uint256---uint256---}[`++_update(from, to, ids, values)++`]
    889. 

  889. 

  890. [.contract-subindex-inherited]
    891. 

  891. .Pausable
    892. 

  892. * {xref-Pausable-paused--}[`++paused()++`]
    893. 

  893. * {xref-Pausable-_requireNotPaused--}[`++_requireNotPaused()++`]
    894. 

  894. * {xref-Pausable-_requirePaused--}[`++_requirePaused()++`]
    895. 

  895. * {xref-Pausable-_pause--}[`++_pause()++`]
    896. 

  896. * {xref-Pausable-_unpause--}[`++_unpause()++`]
    897. 

  897. 

  898. [.contract-subindex-inherited]
    899. 

  899. .ERC1155
    900. 

  900. * {xref-ERC1155-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    901. 

  901. * {xref-ERC1155-uri-uint256-}[`++uri()++`]
    902. 

  902. * {xref-ERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    903. 

  903. * {xref-ERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    904. 

  904. * {xref-ERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    905. 

  905. * {xref-ERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    906. 

  906. * {xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    907. 

  907. * {xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    908. 

  908. * {xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-}[`++_updateWithAcceptanceCheck(from, to, ids, values, data)++`]
    909. 

  909. * {xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-}[`++_safeTransferFrom(from, to, id, value, data)++`]
    910. 

  910. * {xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++_safeBatchTransferFrom(from, to, ids, values, data)++`]
    911. 

  911. * {xref-ERC1155-_setURI-string-}[`++_setURI(newuri)++`]
    912. 

  912. * {xref-ERC1155-_mint-address-uint256-uint256-bytes-}[`++_mint(to, id, value, data)++`]
    913. 

  913. * {xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-}[`++_mintBatch(to, ids, values, data)++`]
    914. 

  914. * {xref-ERC1155-_burn-address-uint256-uint256-}[`++_burn(from, id, value)++`]
    915. 

  915. * {xref-ERC1155-_burnBatch-address-uint256---uint256---}[`++_burnBatch(from, ids, values)++`]
    916. 

  916. * {xref-ERC1155-_setApprovalForAll-address-address-bool-}[`++_setApprovalForAll(owner, operator, approved)++`]
    917. 

  917. 

  918. [.contract-subindex-inherited]
    919. 

  919. .IERC1155Errors
    920. 

  920. 

  921. [.contract-subindex-inherited]
    922. 

  922. .IERC1155MetadataURI
    923. 

  923. 

  924. [.contract-subindex-inherited]
    925. 

  925. .IERC1155
    926. 

  926. 

  927. [.contract-subindex-inherited]
    928. 

  928. .ERC165
    929. 

  929. 

  930. [.contract-subindex-inherited]
    931. 

  931. .IERC165
    932. 

  932. 

  933. --
    934. 

  934. 

  935. [.contract-index]
    936. 

  936. .Events
    937. 

  937. --
    938. 

  938. 

  939. [.contract-subindex-inherited]
    940. 

  940. .Pausable
    941. 

  941. * {xref-Pausable-Paused-address-}[`++Paused(account)++`]
    942. 

  942. * {xref-Pausable-Unpaused-address-}[`++Unpaused(account)++`]
    943. 

  943. 

  944. [.contract-subindex-inherited]
    945. 

  945. .ERC1155
    946. 

  946. 

  947. [.contract-subindex-inherited]
    948. 

  948. .IERC1155Errors
    949. 

  949. 

  950. [.contract-subindex-inherited]
    951. 

  951. .IERC1155MetadataURI
    952. 

  952. 

  953. [.contract-subindex-inherited]
    954. 

  954. .IERC1155
    955. 

  955. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    956. 

  956. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    957. 

  957. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    958. 

  958. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    959. 

  959. 

  960. [.contract-subindex-inherited]
    961. 

  961. .ERC165
    962. 

  962. 

  963. [.contract-subindex-inherited]
    964. 

  964. .IERC165
    965. 

  965. 

  966. --
    967. 

  967. 

  968. [.contract-index]
    969. 

  969. .Errors
    970. 

  970. --
    971. 

  971. 

  972. [.contract-subindex-inherited]
    973. 

  973. .Pausable
    974. 

  974. * {xref-Pausable-EnforcedPause--}[`++EnforcedPause()++`]
    975. 

  975. * {xref-Pausable-ExpectedPause--}[`++ExpectedPause()++`]
    976. 

  976. 

  977. [.contract-subindex-inherited]
    978. 

  978. .ERC1155
    979. 

  979. 

  980. [.contract-subindex-inherited]
    981. 

  981. .IERC1155Errors
    982. 

  982. * {xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-}[`++ERC1155InsufficientBalance(sender, balance, needed, tokenId)++`]
    983. 

  983. * {xref-IERC1155Errors-ERC1155InvalidSender-address-}[`++ERC1155InvalidSender(sender)++`]
    984. 

  984. * {xref-IERC1155Errors-ERC1155InvalidReceiver-address-}[`++ERC1155InvalidReceiver(receiver)++`]
    985. 

  985. * {xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-}[`++ERC1155MissingApprovalForAll(operator, owner)++`]
    986. 

  986. * {xref-IERC1155Errors-ERC1155InvalidApprover-address-}[`++ERC1155InvalidApprover(approver)++`]
    987. 

  987. * {xref-IERC1155Errors-ERC1155InvalidOperator-address-}[`++ERC1155InvalidOperator(operator)++`]
    988. 

  988. * {xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-}[`++ERC1155InvalidArrayLength(idsLength, valuesLength)++`]
    989. 

  989. 

  990. [.contract-subindex-inherited]
    991. 

  991. .IERC1155MetadataURI
    992. 

  992. 

  993. [.contract-subindex-inherited]
    994. 

  994. .IERC1155
    995. 

  995. 

  996. [.contract-subindex-inherited]
    997. 

  997. .ERC165
    998. 

  998. 

  999. [.contract-subindex-inherited]
    1000. 

  1000. .IERC165
    1001. 

  1001. 

  1002. --
    1003. 

  1003. 

  1004. [.contract-item]
    1005. 

  1005. [[ERC1155Pausable-_update-address-address-uint256---uint256---]]
    1006. 

  1006. ==== `[.contract-item-name]#++_update++#++(address from, address to, uint256[] ids, uint256[] values)++` [.item-kind]#internal#
    1007. 

  1007. 

  1008. See {ERC1155-_update}.
    1009. 

  1009. 

  1010. Requirements:
    1011. 

  1011. 

  1012. - the contract must not be paused.
    1013. 

  1013. 

  1014. :burn: pass:normal[xref:#ERC1155Burnable-burn-address-uint256-uint256-[`++burn++`]]
    1015. 

  1015. :burnBatch: pass:normal[xref:#ERC1155Burnable-burnBatch-address-uint256---uint256---[`++burnBatch++`]]
    1016. 

  1016. 

  1017. [.contract]
    1018. 

  1018. [[ERC1155Burnable]]
    1019. 

  1019. === `++ERC1155Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/extensions/ERC1155Burnable.sol[{github-icon},role=heading-link]
    1020. 

  1020. 

  1021. [.hljs-theme-light.nopadding]
    1022. 

  1022. ```solidity
    1023. 

  1023. import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol";
    1024. 

  1024. ```
    1025. 

  1025. 

  1026. Extension of {ERC1155} that allows token holders to destroy both their
    1027. 

  1027. own tokens and those that they have been approved to use.
    1028. 

  1028. 

  1029. [.contract-index]
    1030. 

  1030. .Functions
    1031. 

  1031. --
    1032. 

  1032. * {xref-ERC1155Burnable-burn-address-uint256-uint256-}[`++burn(account, id, value)++`]
    1033. 

  1033. * {xref-ERC1155Burnable-burnBatch-address-uint256---uint256---}[`++burnBatch(account, ids, values)++`]
    1034. 

  1034. 

  1035. [.contract-subindex-inherited]
    1036. 

  1036. .ERC1155
    1037. 

  1037. * {xref-ERC1155-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    1038. 

  1038. * {xref-ERC1155-uri-uint256-}[`++uri()++`]
    1039. 

  1039. * {xref-ERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    1040. 

  1040. * {xref-ERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    1041. 

  1041. * {xref-ERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    1042. 

  1042. * {xref-ERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    1043. 

  1043. * {xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    1044. 

  1044. * {xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    1045. 

  1045. * {xref-ERC1155-_update-address-address-uint256---uint256---}[`++_update(from, to, ids, values)++`]
    1046. 

  1046. * {xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-}[`++_updateWithAcceptanceCheck(from, to, ids, values, data)++`]
    1047. 

  1047. * {xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-}[`++_safeTransferFrom(from, to, id, value, data)++`]
    1048. 

  1048. * {xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++_safeBatchTransferFrom(from, to, ids, values, data)++`]
    1049. 

  1049. * {xref-ERC1155-_setURI-string-}[`++_setURI(newuri)++`]
    1050. 

  1050. * {xref-ERC1155-_mint-address-uint256-uint256-bytes-}[`++_mint(to, id, value, data)++`]
    1051. 

  1051. * {xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-}[`++_mintBatch(to, ids, values, data)++`]
    1052. 

  1052. * {xref-ERC1155-_burn-address-uint256-uint256-}[`++_burn(from, id, value)++`]
    1053. 

  1053. * {xref-ERC1155-_burnBatch-address-uint256---uint256---}[`++_burnBatch(from, ids, values)++`]
    1054. 

  1054. * {xref-ERC1155-_setApprovalForAll-address-address-bool-}[`++_setApprovalForAll(owner, operator, approved)++`]
    1055. 

  1055. 

  1056. [.contract-subindex-inherited]
    1057. 

  1057. .IERC1155Errors
    1058. 

  1058. 

  1059. [.contract-subindex-inherited]
    1060. 

  1060. .IERC1155MetadataURI
    1061. 

  1061. 

  1062. [.contract-subindex-inherited]
    1063. 

  1063. .IERC1155
    1064. 

  1064. 

  1065. [.contract-subindex-inherited]
    1066. 

  1066. .ERC165
    1067. 

  1067. 

  1068. [.contract-subindex-inherited]
    1069. 

  1069. .IERC165
    1070. 

  1070. 

  1071. --
    1072. 

  1072. 

  1073. [.contract-index]
    1074. 

  1074. .Events
    1075. 

  1075. --
    1076. 

  1076. 

  1077. [.contract-subindex-inherited]
    1078. 

  1078. .ERC1155
    1079. 

  1079. 

  1080. [.contract-subindex-inherited]
    1081. 

  1081. .IERC1155Errors
    1082. 

  1082. 

  1083. [.contract-subindex-inherited]
    1084. 

  1084. .IERC1155MetadataURI
    1085. 

  1085. 

  1086. [.contract-subindex-inherited]
    1087. 

  1087. .IERC1155
    1088. 

  1088. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    1089. 

  1089. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    1090. 

  1090. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    1091. 

  1091. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    1092. 

  1092. 

  1093. [.contract-subindex-inherited]
    1094. 

  1094. .ERC165
    1095. 

  1095. 

  1096. [.contract-subindex-inherited]
    1097. 

  1097. .IERC165
    1098. 

  1098. 

  1099. --
    1100. 

  1100. 

  1101. [.contract-index]
    1102. 

  1102. .Errors
    1103. 

  1103. --
    1104. 

  1104. 

  1105. [.contract-subindex-inherited]
    1106. 

  1106. .ERC1155
    1107. 

  1107. 

  1108. [.contract-subindex-inherited]
    1109. 

  1109. .IERC1155Errors
    1110. 

  1110. * {xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-}[`++ERC1155InsufficientBalance(sender, balance, needed, tokenId)++`]
    1111. 

  1111. * {xref-IERC1155Errors-ERC1155InvalidSender-address-}[`++ERC1155InvalidSender(sender)++`]
    1112. 

  1112. * {xref-IERC1155Errors-ERC1155InvalidReceiver-address-}[`++ERC1155InvalidReceiver(receiver)++`]
    1113. 

  1113. * {xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-}[`++ERC1155MissingApprovalForAll(operator, owner)++`]
    1114. 

  1114. * {xref-IERC1155Errors-ERC1155InvalidApprover-address-}[`++ERC1155InvalidApprover(approver)++`]
    1115. 

  1115. * {xref-IERC1155Errors-ERC1155InvalidOperator-address-}[`++ERC1155InvalidOperator(operator)++`]
    1116. 

  1116. * {xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-}[`++ERC1155InvalidArrayLength(idsLength, valuesLength)++`]
    1117. 

  1117. 

  1118. [.contract-subindex-inherited]
    1119. 

  1119. .IERC1155MetadataURI
    1120. 

  1120. 

  1121. [.contract-subindex-inherited]
    1122. 

  1122. .IERC1155
    1123. 

  1123. 

  1124. [.contract-subindex-inherited]
    1125. 

  1125. .ERC165
    1126. 

  1126. 

  1127. [.contract-subindex-inherited]
    1128. 

  1128. .IERC165
    1129. 

  1129. 

  1130. --
    1131. 

  1131. 

  1132. [.contract-item]
    1133. 

  1133. [[ERC1155Burnable-burn-address-uint256-uint256-]]
    1134. 

  1134. ==== `[.contract-item-name]#++burn++#++(address account, uint256 id, uint256 value)++` [.item-kind]#public#
    1135. 

  1135. 

  1136. [.contract-item]
    1137. 

  1137. [[ERC1155Burnable-burnBatch-address-uint256---uint256---]]
    1138. 

  1138. ==== `[.contract-item-name]#++burnBatch++#++(address account, uint256[] ids, uint256[] values)++` [.item-kind]#public#
    1139. 

  1139. 

  1140. :totalSupply: pass:normal[xref:#ERC1155Supply-totalSupply-uint256-[`++totalSupply++`]]
    1141. 

  1141. :totalSupply: pass:normal[xref:#ERC1155Supply-totalSupply--[`++totalSupply++`]]
    1142. 

  1142. :exists: pass:normal[xref:#ERC1155Supply-exists-uint256-[`++exists++`]]
    1143. 

  1143. :_update: pass:normal[xref:#ERC1155Supply-_update-address-address-uint256---uint256---[`++_update++`]]
    1144. 

  1144. 

  1145. [.contract]
    1146. 

  1146. [[ERC1155Supply]]
    1147. 

  1147. === `++ERC1155Supply++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/extensions/ERC1155Supply.sol[{github-icon},role=heading-link]
    1148. 

  1148. 

  1149. [.hljs-theme-light.nopadding]
    1150. 

  1150. ```solidity
    1151. 

  1151. import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol";
    1152. 

  1152. ```
    1153. 

  1153. 

  1154. Extension of ERC-1155 that adds tracking of total supply per id.
    1155. 

  1155. 

  1156. Useful for scenarios where Fungible and Non-fungible tokens have to be
    1157. 

  1157. clearly identified. Note: While a totalSupply of 1 might mean the
    1158. 

  1158. corresponding is an NFT, there is no guarantees that no other token with the
    1159. 

  1159. same id are not going to be minted.
    1160. 

  1160. 

  1161. NOTE: This contract implies a global limit of 2**256 - 1 to the number of tokens
    1162. 

  1162. that can be minted.
    1163. 

  1163. 

  1164. CAUTION: This extension should not be added in an upgrade to an already deployed contract.
    1165. 

  1165. 

  1166. [.contract-index]
    1167. 

  1167. .Functions
    1168. 

  1168. --
    1169. 

  1169. * {xref-ERC1155Supply-totalSupply-uint256-}[`++totalSupply(id)++`]
    1170. 

  1170. * {xref-ERC1155Supply-totalSupply--}[`++totalSupply()++`]
    1171. 

  1171. * {xref-ERC1155Supply-exists-uint256-}[`++exists(id)++`]
    1172. 

  1172. * {xref-ERC1155Supply-_update-address-address-uint256---uint256---}[`++_update(from, to, ids, values)++`]
    1173. 

  1173. 

  1174. [.contract-subindex-inherited]
    1175. 

  1175. .ERC1155
    1176. 

  1176. * {xref-ERC1155-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    1177. 

  1177. * {xref-ERC1155-uri-uint256-}[`++uri()++`]
    1178. 

  1178. * {xref-ERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    1179. 

  1179. * {xref-ERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    1180. 

  1180. * {xref-ERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    1181. 

  1181. * {xref-ERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    1182. 

  1182. * {xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    1183. 

  1183. * {xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    1184. 

  1184. * {xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-}[`++_updateWithAcceptanceCheck(from, to, ids, values, data)++`]
    1185. 

  1185. * {xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-}[`++_safeTransferFrom(from, to, id, value, data)++`]
    1186. 

  1186. * {xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++_safeBatchTransferFrom(from, to, ids, values, data)++`]
    1187. 

  1187. * {xref-ERC1155-_setURI-string-}[`++_setURI(newuri)++`]
    1188. 

  1188. * {xref-ERC1155-_mint-address-uint256-uint256-bytes-}[`++_mint(to, id, value, data)++`]
    1189. 

  1189. * {xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-}[`++_mintBatch(to, ids, values, data)++`]
    1190. 

  1190. * {xref-ERC1155-_burn-address-uint256-uint256-}[`++_burn(from, id, value)++`]
    1191. 

  1191. * {xref-ERC1155-_burnBatch-address-uint256---uint256---}[`++_burnBatch(from, ids, values)++`]
    1192. 

  1192. * {xref-ERC1155-_setApprovalForAll-address-address-bool-}[`++_setApprovalForAll(owner, operator, approved)++`]
    1193. 

  1193. 

  1194. [.contract-subindex-inherited]
    1195. 

  1195. .IERC1155Errors
    1196. 

  1196. 

  1197. [.contract-subindex-inherited]
    1198. 

  1198. .IERC1155MetadataURI
    1199. 

  1199. 

  1200. [.contract-subindex-inherited]
    1201. 

  1201. .IERC1155
    1202. 

  1202. 

  1203. [.contract-subindex-inherited]
    1204. 

  1204. .ERC165
    1205. 

  1205. 

  1206. [.contract-subindex-inherited]
    1207. 

  1207. .IERC165
    1208. 

  1208. 

  1209. --
    1210. 

  1210. 

  1211. [.contract-index]
    1212. 

  1212. .Events
    1213. 

  1213. --
    1214. 

  1214. 

  1215. [.contract-subindex-inherited]
    1216. 

  1216. .ERC1155
    1217. 

  1217. 

  1218. [.contract-subindex-inherited]
    1219. 

  1219. .IERC1155Errors
    1220. 

  1220. 

  1221. [.contract-subindex-inherited]
    1222. 

  1222. .IERC1155MetadataURI
    1223. 

  1223. 

  1224. [.contract-subindex-inherited]
    1225. 

  1225. .IERC1155
    1226. 

  1226. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    1227. 

  1227. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    1228. 

  1228. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    1229. 

  1229. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    1230. 

  1230. 

  1231. [.contract-subindex-inherited]
    1232. 

  1232. .ERC165
    1233. 

  1233. 

  1234. [.contract-subindex-inherited]
    1235. 

  1235. .IERC165
    1236. 

  1236. 

  1237. --
    1238. 

  1238. 

  1239. [.contract-index]
    1240. 

  1240. .Errors
    1241. 

  1241. --
    1242. 

  1242. 

  1243. [.contract-subindex-inherited]
    1244. 

  1244. .ERC1155
    1245. 

  1245. 

  1246. [.contract-subindex-inherited]
    1247. 

  1247. .IERC1155Errors
    1248. 

  1248. * {xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-}[`++ERC1155InsufficientBalance(sender, balance, needed, tokenId)++`]
    1249. 

  1249. * {xref-IERC1155Errors-ERC1155InvalidSender-address-}[`++ERC1155InvalidSender(sender)++`]
    1250. 

  1250. * {xref-IERC1155Errors-ERC1155InvalidReceiver-address-}[`++ERC1155InvalidReceiver(receiver)++`]
    1251. 

  1251. * {xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-}[`++ERC1155MissingApprovalForAll(operator, owner)++`]
    1252. 

  1252. * {xref-IERC1155Errors-ERC1155InvalidApprover-address-}[`++ERC1155InvalidApprover(approver)++`]
    1253. 

  1253. * {xref-IERC1155Errors-ERC1155InvalidOperator-address-}[`++ERC1155InvalidOperator(operator)++`]
    1254. 

  1254. * {xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-}[`++ERC1155InvalidArrayLength(idsLength, valuesLength)++`]
    1255. 

  1255. 

  1256. [.contract-subindex-inherited]
    1257. 

  1257. .IERC1155MetadataURI
    1258. 

  1258. 

  1259. [.contract-subindex-inherited]
    1260. 

  1260. .IERC1155
    1261. 

  1261. 

  1262. [.contract-subindex-inherited]
    1263. 

  1263. .ERC165
    1264. 

  1264. 

  1265. [.contract-subindex-inherited]
    1266. 

  1266. .IERC165
    1267. 

  1267. 

  1268. --
    1269. 

  1269. 

  1270. [.contract-item]
    1271. 

  1271. [[ERC1155Supply-totalSupply-uint256-]]
    1272. 

  1272. ==== `[.contract-item-name]#++totalSupply++#++(uint256 id) → uint256++` [.item-kind]#public#
    1273. 

  1273. 

  1274. Total value of tokens in with a given id.
    1275. 

  1275. 

  1276. [.contract-item]
    1277. 

  1277. [[ERC1155Supply-totalSupply--]]
    1278. 

  1278. ==== `[.contract-item-name]#++totalSupply++#++() → uint256++` [.item-kind]#public#
    1279. 

  1279. 

  1280. Total value of tokens.
    1281. 

  1281. 

  1282. [.contract-item]
    1283. 

  1283. [[ERC1155Supply-exists-uint256-]]
    1284. 

  1284. ==== `[.contract-item-name]#++exists++#++(uint256 id) → bool++` [.item-kind]#public#
    1285. 

  1285. 

  1286. Indicates whether any token exist with a given id, or not.
    1287. 

  1287. 

  1288. [.contract-item]
    1289. 

  1289. [[ERC1155Supply-_update-address-address-uint256---uint256---]]
    1290. 

  1290. ==== `[.contract-item-name]#++_update++#++(address from, address to, uint256[] ids, uint256[] values)++` [.item-kind]#internal#
    1291. 

  1291. 

  1292. See {ERC1155-_update}.
    1293. 

  1293. 

  1294. :uri: pass:normal[xref:#ERC1155URIStorage-uri-uint256-[`++uri++`]]
    1295. 

  1295. :_setURI: pass:normal[xref:#ERC1155URIStorage-_setURI-uint256-string-[`++_setURI++`]]
    1296. 

  1296. :_setBaseURI: pass:normal[xref:#ERC1155URIStorage-_setBaseURI-string-[`++_setBaseURI++`]]
    1297. 

  1297. 

  1298. [.contract]
    1299. 

  1299. [[ERC1155URIStorage]]
    1300. 

  1300. === `++ERC1155URIStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/extensions/ERC1155URIStorage.sol[{github-icon},role=heading-link]
    1301. 

  1301. 

  1302. [.hljs-theme-light.nopadding]
    1303. 

  1303. ```solidity
    1304. 

  1304. import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155URIStorage.sol";
    1305. 

  1305. ```
    1306. 

  1306. 

  1307. ERC-1155 token with storage based token URI management.
    1308. 

  1308. Inspired by the {ERC721URIStorage} extension
    1309. 

  1309. 

  1310. [.contract-index]
    1311. 

  1311. .Functions
    1312. 

  1312. --
    1313. 

  1313. * {xref-ERC1155URIStorage-uri-uint256-}[`++uri(tokenId)++`]
    1314. 

  1314. * {xref-ERC1155URIStorage-_setURI-uint256-string-}[`++_setURI(tokenId, tokenURI)++`]
    1315. 

  1315. * {xref-ERC1155URIStorage-_setBaseURI-string-}[`++_setBaseURI(baseURI)++`]
    1316. 

  1316. 

  1317. [.contract-subindex-inherited]
    1318. 

  1318. .ERC1155
    1319. 

  1319. * {xref-ERC1155-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    1320. 

  1320. * {xref-ERC1155-balanceOf-address-uint256-}[`++balanceOf(account, id)++`]
    1321. 

  1321. * {xref-ERC1155-balanceOfBatch-address---uint256---}[`++balanceOfBatch(accounts, ids)++`]
    1322. 

  1322. * {xref-ERC1155-setApprovalForAll-address-bool-}[`++setApprovalForAll(operator, approved)++`]
    1323. 

  1323. * {xref-ERC1155-isApprovedForAll-address-address-}[`++isApprovedForAll(account, operator)++`]
    1324. 

  1324. * {xref-ERC1155-safeTransferFrom-address-address-uint256-uint256-bytes-}[`++safeTransferFrom(from, to, id, value, data)++`]
    1325. 

  1325. * {xref-ERC1155-safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++safeBatchTransferFrom(from, to, ids, values, data)++`]
    1326. 

  1326. * {xref-ERC1155-_update-address-address-uint256---uint256---}[`++_update(from, to, ids, values)++`]
    1327. 

  1327. * {xref-ERC1155-_updateWithAcceptanceCheck-address-address-uint256---uint256---bytes-}[`++_updateWithAcceptanceCheck(from, to, ids, values, data)++`]
    1328. 

  1328. * {xref-ERC1155-_safeTransferFrom-address-address-uint256-uint256-bytes-}[`++_safeTransferFrom(from, to, id, value, data)++`]
    1329. 

  1329. * {xref-ERC1155-_safeBatchTransferFrom-address-address-uint256---uint256---bytes-}[`++_safeBatchTransferFrom(from, to, ids, values, data)++`]
    1330. 

  1330. * {xref-ERC1155-_setURI-string-}[`++_setURI(newuri)++`]
    1331. 

  1331. * {xref-ERC1155-_mint-address-uint256-uint256-bytes-}[`++_mint(to, id, value, data)++`]
    1332. 

  1332. * {xref-ERC1155-_mintBatch-address-uint256---uint256---bytes-}[`++_mintBatch(to, ids, values, data)++`]
    1333. 

  1333. * {xref-ERC1155-_burn-address-uint256-uint256-}[`++_burn(from, id, value)++`]
    1334. 

  1334. * {xref-ERC1155-_burnBatch-address-uint256---uint256---}[`++_burnBatch(from, ids, values)++`]
    1335. 

  1335. * {xref-ERC1155-_setApprovalForAll-address-address-bool-}[`++_setApprovalForAll(owner, operator, approved)++`]
    1336. 

  1336. 

  1337. [.contract-subindex-inherited]
    1338. 

  1338. .IERC1155Errors
    1339. 

  1339. 

  1340. [.contract-subindex-inherited]
    1341. 

  1341. .IERC1155MetadataURI
    1342. 

  1342. 

  1343. [.contract-subindex-inherited]
    1344. 

  1344. .IERC1155
    1345. 

  1345. 

  1346. [.contract-subindex-inherited]
    1347. 

  1347. .ERC165
    1348. 

  1348. 

  1349. [.contract-subindex-inherited]
    1350. 

  1350. .IERC165
    1351. 

  1351. 

  1352. --
    1353. 

  1353. 

  1354. [.contract-index]
    1355. 

  1355. .Events
    1356. 

  1356. --
    1357. 

  1357. 

  1358. [.contract-subindex-inherited]
    1359. 

  1359. .ERC1155
    1360. 

  1360. 

  1361. [.contract-subindex-inherited]
    1362. 

  1362. .IERC1155Errors
    1363. 

  1363. 

  1364. [.contract-subindex-inherited]
    1365. 

  1365. .IERC1155MetadataURI
    1366. 

  1366. 

  1367. [.contract-subindex-inherited]
    1368. 

  1368. .IERC1155
    1369. 

  1369. * {xref-IERC1155-TransferSingle-address-address-address-uint256-uint256-}[`++TransferSingle(operator, from, to, id, value)++`]
    1370. 

  1370. * {xref-IERC1155-TransferBatch-address-address-address-uint256---uint256---}[`++TransferBatch(operator, from, to, ids, values)++`]
    1371. 

  1371. * {xref-IERC1155-ApprovalForAll-address-address-bool-}[`++ApprovalForAll(account, operator, approved)++`]
    1372. 

  1372. * {xref-IERC1155-URI-string-uint256-}[`++URI(value, id)++`]
    1373. 

  1373. 

  1374. [.contract-subindex-inherited]
    1375. 

  1375. .ERC165
    1376. 

  1376. 

  1377. [.contract-subindex-inherited]
    1378. 

  1378. .IERC165
    1379. 

  1379. 

  1380. --
    1381. 

  1381. 

  1382. [.contract-index]
    1383. 

  1383. .Errors
    1384. 

  1384. --
    1385. 

  1385. 

  1386. [.contract-subindex-inherited]
    1387. 

  1387. .ERC1155
    1388. 

  1388. 

  1389. [.contract-subindex-inherited]
    1390. 

  1390. .IERC1155Errors
    1391. 

  1391. * {xref-IERC1155Errors-ERC1155InsufficientBalance-address-uint256-uint256-uint256-}[`++ERC1155InsufficientBalance(sender, balance, needed, tokenId)++`]
    1392. 

  1392. * {xref-IERC1155Errors-ERC1155InvalidSender-address-}[`++ERC1155InvalidSender(sender)++`]
    1393. 

  1393. * {xref-IERC1155Errors-ERC1155InvalidReceiver-address-}[`++ERC1155InvalidReceiver(receiver)++`]
    1394. 

  1394. * {xref-IERC1155Errors-ERC1155MissingApprovalForAll-address-address-}[`++ERC1155MissingApprovalForAll(operator, owner)++`]
    1395. 

  1395. * {xref-IERC1155Errors-ERC1155InvalidApprover-address-}[`++ERC1155InvalidApprover(approver)++`]
    1396. 

  1396. * {xref-IERC1155Errors-ERC1155InvalidOperator-address-}[`++ERC1155InvalidOperator(operator)++`]
    1397. 

  1397. * {xref-IERC1155Errors-ERC1155InvalidArrayLength-uint256-uint256-}[`++ERC1155InvalidArrayLength(idsLength, valuesLength)++`]
    1398. 

  1398. 

  1399. [.contract-subindex-inherited]
    1400. 

  1400. .IERC1155MetadataURI
    1401. 

  1401. 

  1402. [.contract-subindex-inherited]
    1403. 

  1403. .IERC1155
    1404. 

  1404. 

  1405. [.contract-subindex-inherited]
    1406. 

  1406. .ERC165
    1407. 

  1407. 

  1408. [.contract-subindex-inherited]
    1409. 

  1409. .IERC165
    1410. 

  1410. 

  1411. --
    1412. 

  1412. 

  1413. [.contract-item]
    1414. 

  1414. [[ERC1155URIStorage-uri-uint256-]]
    1415. 

  1415. ==== `[.contract-item-name]#++uri++#++(uint256 tokenId) → string++` [.item-kind]#public#
    1416. 

  1416. 

  1417. See {IERC1155MetadataURI-uri}.
    1418. 

  1418. 

  1419. This implementation returns the concatenation of the `_baseURI`
    1420. 

  1420. and the token-specific uri if the latter is set
    1421. 

  1421. 

  1422. This enables the following behaviors:
    1423. 

  1423. 

  1424. - if `_tokenURIs[tokenId]` is set, then the result is the concatenation
    1425. 

  1425.   of `_baseURI` and `_tokenURIs[tokenId]` (keep in mind that `_baseURI`
    1426. 

  1426.   is empty per default);
    1427. 

  1427. 

  1428. - if `_tokenURIs[tokenId]` is NOT set then we fallback to `super.uri()`
    1429. 

  1429.   which in most cases will contain `ERC1155._uri`;
    1430. 

  1430. 

  1431. - if `_tokenURIs[tokenId]` is NOT set, and if the parents do not have a
    1432. 

  1432.   uri value set, then the result is empty.
    1433. 

  1433. 

  1434. [.contract-item]
    1435. 

  1435. [[ERC1155URIStorage-_setURI-uint256-string-]]
    1436. 

  1436. ==== `[.contract-item-name]#++_setURI++#++(uint256 tokenId, string tokenURI)++` [.item-kind]#internal#
    1437. 

  1437. 

  1438. Sets `tokenURI` as the tokenURI of `tokenId`.
    1439. 

  1439. 

  1440. [.contract-item]
    1441. 

  1441. [[ERC1155URIStorage-_setBaseURI-string-]]
    1442. 

  1442. ==== `[.contract-item-name]#++_setBaseURI++#++(string baseURI)++` [.item-kind]#internal#
    1443. 

  1443. 

  1444. Sets `baseURI` as the `_baseURI` for all tokens
    1445. 

  1445. 

  1446. == Utilities
    1447. 

  1447. 

  1448. :supportsInterface: pass:normal[xref:#ERC1155Holder-supportsInterface-bytes4-[`++supportsInterface++`]]
    1449. 

  1449. :onERC1155Received: pass:normal[xref:#ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
    1450. 

  1450. :onERC1155BatchReceived: pass:normal[xref:#ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
    1451. 

  1451. 

  1452. [.contract]
    1453. 

  1453. [[ERC1155Holder]]
    1454. 

  1454. === `++ERC1155Holder++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/utils/ERC1155Holder.sol[{github-icon},role=heading-link]
    1455. 

  1455. 

  1456. [.hljs-theme-light.nopadding]
    1457. 

  1457. ```solidity
    1458. 

  1458. import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
    1459. 

  1459. ```
    1460. 

  1460. 

  1461. Simple implementation of `IERC1155Receiver` that will allow a contract to hold ERC-1155 tokens.
    1462. 

  1462. 

  1463. IMPORTANT: When inheriting this contract, you must include a way to use the received tokens, otherwise they will be
    1464. 

  1464. stuck.
    1465. 

  1465. 

  1466. [.contract-index]
    1467. 

  1467. .Functions
    1468. 

  1468. --
    1469. 

  1469. * {xref-ERC1155Holder-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
    1470. 

  1470. * {xref-ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
    1471. 

  1471. * {xref-ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
    1472. 

  1472. 

  1473. [.contract-subindex-inherited]
    1474. 

  1474. .IERC1155Receiver
    1475. 

  1475. 

  1476. [.contract-subindex-inherited]
    1477. 

  1477. .ERC165
    1478. 

  1478. 

  1479. [.contract-subindex-inherited]
    1480. 

  1480. .IERC165
    1481. 

  1481. 

  1482. --
    1483. 

  1483. 

  1484. [.contract-item]
    1485. 

  1485. [[ERC1155Holder-supportsInterface-bytes4-]]
    1486. 

  1486. ==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#
    1487. 

  1487. 

  1488. See {IERC165-supportsInterface}.
    1489. 

  1489. 

  1490. [.contract-item]
    1491. 

  1491. [[ERC1155Holder-onERC1155Received-address-address-uint256-uint256-bytes-]]
    1492. 

  1492. ==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#
    1493. 

  1493. 

  1494. [.contract-item]
    1495. 

  1495. [[ERC1155Holder-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
    1496. 

  1496. ==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#
    1497. 

  1497. 

  1498. :checkOnERC1155Received: pass:normal[xref:#ERC1155Utils-checkOnERC1155Received-address-address-address-uint256-uint256-bytes-[`++checkOnERC1155Received++`]]
    1499. 

  1499. :checkOnERC1155BatchReceived: pass:normal[xref:#ERC1155Utils-checkOnERC1155BatchReceived-address-address-address-uint256---uint256---bytes-[`++checkOnERC1155BatchReceived++`]]
    1500. 

  1500. 

  1501. [.contract]
    1502. 

  1502. [[ERC1155Utils]]
    1503. 

  1503. === `++ERC1155Utils++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/token/ERC1155/utils/ERC1155Utils.sol[{github-icon},role=heading-link]
    1504. 

  1504. 

  1505. [.hljs-theme-light.nopadding]
    1506. 

  1506. ```solidity
    1507. 

  1507. import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Utils.sol";
    1508. 

  1508. ```
    1509. 

  1509. 

  1510. Library that provide common ERC-1155 utility functions.
    1511. 

  1511. 

  1512. See https://eips.ethereum.org/EIPS/eip-1155[ERC-1155].
    1513. 

  1513. 

  1514. _Available since v5.1._
    1515. 

  1515. 

  1516. [.contract-index]
    1517. 

  1517. .Functions
    1518. 

  1518. --
    1519. 

  1519. * {xref-ERC1155Utils-checkOnERC1155Received-address-address-address-uint256-uint256-bytes-}[`++checkOnERC1155Received(operator, from, to, id, value, data)++`]
    1520. 

  1520. * {xref-ERC1155Utils-checkOnERC1155BatchReceived-address-address-address-uint256---uint256---bytes-}[`++checkOnERC1155BatchReceived(operator, from, to, ids, values, data)++`]
    1521. 

  1521. 

  1522. --
    1523. 

  1523. 

  1524. [.contract-item]
    1525. 

  1525. [[ERC1155Utils-checkOnERC1155Received-address-address-address-uint256-uint256-bytes-]]
    1526. 

  1526. ==== `[.contract-item-name]#++checkOnERC1155Received++#++(address operator, address from, address to, uint256 id, uint256 value, bytes data)++` [.item-kind]#internal#
    1527. 

  1527. 

  1528. Performs an acceptance check for the provided `operator` by calling {IERC1155-onERC1155Received}
    1529. 

  1529. on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
    1530. 

  1530. 

  1531. The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
    1532. 

  1532. Otherwise, the recipient must implement {IERC1155Receiver-onERC1155Received} and return the acceptance magic value to accept
    1533. 

  1533. the transfer.
    1534. 

  1534. 

  1535. [.contract-item]
    1536. 

  1536. [[ERC1155Utils-checkOnERC1155BatchReceived-address-address-address-uint256---uint256---bytes-]]
    1537. 

  1537. ==== `[.contract-item-name]#++checkOnERC1155BatchReceived++#++(address operator, address from, address to, uint256[] ids, uint256[] values, bytes data)++` [.item-kind]#internal#
    1538. 

  1538. 

  1539. Performs a batch acceptance check for the provided `operator` by calling {IERC1155-onERC1155BatchReceived}
    1540. 

  1540. on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
    1541. 

  1541. 

  1542. The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
    1543. 

  1543. Otherwise, the recipient must implement {IERC1155Receiver-onERC1155Received} and return the acceptance magic value to accept
    1544. 

  1544. the transfer.
    1545. 

  1545.