@ar.io/sdk 2.5.0-alpha.5 → 2.5.0-alpha.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -80,6 +80,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
80
80
  - [`setTicker({ ticker })`](#setticker-ticker-)
81
81
  - [`setDescription({ description })`](#setdescription-description-)
82
82
  - [`setKeywords({ keywords })`](#setkeywords-keywords-)
83
+ - [`setLogo({ txId })`](#setlogo-txid-)
83
84
  - [`releaseName({ name, ioProcessId })`](#releasename-name-ioprocessid-)
84
85
  - [`reassignName({ name, ioProcessId, antProcessId })`](#reassignname-name-ioprocessid-antprocessid-)
85
86
  - [Configuration](#configuration-1)
@@ -1810,6 +1811,20 @@ const { id: txId } = await ant.setDescription(
1810
1811
  );
1811
1812
  ```
1812
1813
 
1814
+ #### `setLogo({ txId })`
1815
+
1816
+ Sets the Logo of the ANT - logo should be an Arweave transaction ID.
1817
+
1818
+ _Note: Requires `signer` to be provided on `ANT.init` to sign the transaction._
1819
+
1820
+ ```typescript
1821
+ const { id: txId } = await ant.setLogo(
1822
+ { txId: 'U7RXcpaVShG4u9nIcPVmm2FJSM5Gru9gQCIiRaIPV7f' },
1823
+ // optional tags
1824
+ { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
1825
+ );
1826
+ ```
1827
+
1813
1828
  #### `releaseName({ name, ioProcessId })`
1814
1829
 
1815
1830
  Releases a name from the auction and makes it available for auction on the IO contract. The name must be permanently owned by the releasing wallet. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.