├── .gitbook └── assets │ └── 68747470733a2f2f72756e2e7073746d6e2e696f2f627574746f6e2e737667.svg ├── README.md ├── SUMMARY.md ├── hackathon.md ├── server └── http-api.md └── tools ├── license.md └── textury-arkb └── README.md /.gitbook/assets/68747470733a2f2f72756e2e7073746d6e2e696f2f627574746f6e2e737667.svg: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Getting Started 2 | 3 | {% page-ref page="server/http-api.md" %} 4 | 5 | {% page-ref page="tools/textury-arkb/" %} 6 | -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Table of contents 2 | 3 | * [Getting Started](README.md) 4 | * [Hackathon info sheet](hackathon.md) 5 | * [Mining Docs](https://docs.arweave.org) 6 | 7 | ## Arweave Node Server 8 | 9 | * [HTTP API](server/http-api.md) 10 | 11 | ## Arkb - Arweave Upload Tool 12 | 13 | * [Arkb User Guide](tools/textury-arkb/README.md) 14 | 15 | 16 | ## Libraries/SDKs 17 | 18 | * [JavaScript/TypeScript/NodeJS](https://github.com/ArweaveTeam/arweave-js) 19 | * [Go](https://github.com/everFinance/goar) 20 | * [PHP](https://github.com/ArweaveTeam/arweave-php) 21 | * [Scala](https://github.com/toknapp/arweave4s) 22 | 23 | 24 | -------------------------------------------------------------------------------- /hackathon.md: -------------------------------------------------------------------------------- 1 | # Hackathon info sheet 2 | 3 | The Arweave network itself is a global, permanent hard drive, while the permaweb is a decentralised, immutable web built on top of the Arweave. 4 | 5 | Permaweb apps are built using normal web technologies — HTML, CSS, and Javascript — but are deployed to Arweave’s on-chain storage system, making them permanent and available in a fast, decentralised manner. You can deploy a permaweb app in 2 minutes or less with Arweave Deploy! 6 | 7 | 8 | [**Get a free wallet with some AR to try it out**](http://tokens.arweave.org)**.** 9 | 10 | ## **Introduction & background:** 11 | 12 | * [**What is the permaweb**](https://medium.com/arweave-updates/welcome-to-the-permaweb-ce0e6c73ddfb) 13 | * [**User guides**](https://docs.arweave.org/info/) 14 | * [**Lightpaper**](https://www.arweave.org/technology.html) 15 | 16 | ## **Developer information:** 17 | 18 | * \*\*\*\*[**Arweave JS**](https://github.com/ArweaveTeam/arweave-js)\*\*\*\* 19 | * [**HTTP API docs** ](https://docs.arweave.org/developers/server/http-api) 20 | * [**Arkb Deploy**](https://github.com/textury/arkb) 21 | * [**Older permaweb apps**](http://arweaveapps.com) 22 | * [**Block explorer**](http://viewblock.io/arweave) 23 | 24 | ## **Community:** 25 | 26 | * [**Discord**](https://discordapp.com/invite/DjAFMJc) 27 | * [**Telegram**](https://t.me/arweave) 28 | * [**Github**](https://github.com/arweaveteam) 29 | * [**Reddit**](https://www.reddit.com/r/Arweave/) 30 | * [**Medium**](https://medium.com/@arweave) 31 | * [**Twitter**](https://twitter.com/arweaveteam) 32 | * [**Facebook**](https://www.facebook.com/ArweaveTeam/) 33 | 34 | -------------------------------------------------------------------------------- /tools/license.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Arweave Deploy Terms of Use v3.1 3 | --- 4 | 5 | # License 6 | 7 | **PLEASE READ CAREFULLY BEFORE DOWNLOADING APPLICATIONS FROM THIS WEBSITE:** 8 | 9 | **IMPORTANT NOTICE TO ALL USERS:** 10 | 11 | BY DOWNLOADING THE APPLICATION FROM OUR WEBSITE THE TERMS OF THIS LICENCE WILL APPLY TO YOU. 12 | 13 | **You may print a copy of this Licence for future reference.** 14 | 15 | This licence agreement $**Licence**$ is a legal agreement between you $**User** or **you**$ and Minimum Spanning Technologies Limited of International House, 24 Holborn Viaduct London, EC1A 2BN United Kingdom $**Arweave, us** or **we**$ for: 16 | 17 | * The Arweave wallet/archiving tool and the Arweave Deploy tool $**Application**$; and 18 | * Any online materials associated with installing and using the Application $e.g. user guides, tutorials$ $**Guide** or **Guides**$. 19 | 20 | We license use of the Application and Guide to you on the basis of this Licence. We do not sell the Application or Guides to you. We remain the owners of the Application and Guides at all times. 21 | 22 | 1. **SCOPE OF LICENCE** 23 | 24 | In consideration of you agreeing to abide by the terms of this Licence, we hereby grant to you a non-exclusive, non-transferable licence to use the Application and the Guides on the terms of this Licence. You may download, install and use the Application, transfer the Application from one computer to another; and use our Guides in support. 25 | 26 | 1. **INTELLECTUAL PROPERTY RIGHTS** 27 | 28 | The Application is provided to you and all users as an open-source software product under the GNU General Public Licence v2, the source code for which can be downloaded from Arweave’s public Github repository. 29 | 30 | 1. **LIMITED WARRANTY** 31 | 32 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT WILL WE AS AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 33 | 34 | 1. 1. By using the Application for the first time $and each time that you then use it$ you acknowledge that: 35 | 1. the Application is a tool enabling data to be uploaded to the Arweave public access network, but your right and ability to make any upload is entirely outside our control and depends $among other factors$ on the availability of storage capacity which is provided by other independent Users and not by Arweave, protocols applicable to data storage in the network and the facilitation of each upload by determination of the current community of Users of the network; 36 | 2. we give no assurance whatever that the network will be available for any specific time, or that storage capacity at least equivalent; 37 | 3. the network may be unavailable for various reasons including $i$ hardware or software failure, malfunction or outages; $ii$ misuse of the Application or the network by other Users; or $iii$ an Event Outside Our Control. 38 | 2. This Licence sets out the full extent of our obligations and liabilities in respect of the supply of the Application and Guides. Except as expressly stated in this Licence, there are no conditions, warranties, representations or other terms, express or implied, that are binding on us. Any condition, warranty, representation or other term concerning the supply of the Application and Guides which might otherwise be implied into, or incorporated in, this Licence whether by statute, common law or otherwise, is excluded to the fullest extent permitted by law. 39 | 3. This Licence sets out the entire agreement between us and supersedes and extinguishes all previous agreements, promises, assurances, warranties, representations and understandings between us, whether written or oral, relating to its subject matter. 40 | 2. **STORAGE OF DATA** 41 | 1. Each time that you use the Application, it is your responsibility alone to make sure that you have all necessary rights with regard to any data, information or other material $“Stored Material”$ which you choose to post or upload to the Arweave network. 42 | 2. WE DO NOT OWN, CONTROL OR ENDORSE ANY STORED MATERIAL THAT IS POSTED, TRANSMITTED, STORED, OR PROCESSED IN THE ARWEAVE NETWORK. WE DO NOT HAVE THE LEGAL RIGHTS OR TECHNICAL ABILITY TO MODIFY OR REMOVE $IN WHOLE OR PART$ ANY STORED MATERIAL. 43 | 3. We do not: 44 | 1. claim any ownership over or other rights in the Stored Material you post or upload to the Arweave network 45 | 2. monitor postings to the network for compliance with $or infringement of$ 3rd party rights; or 46 | 3. monitor postings to the network for compliance with $or breach of$ the commitments you agree to about the nature of Stored Material $see next sections$. 47 | 4. Each time that you use the Application to post or upload to the Arweave network, you make a commitment to us and to all other Users that you have all necessary rights with regard to the data, information or other material comprised in that Stored Material. Specifically, you are solely responsible to ensure that your Stored Material will not violate any agreements or confidentiality obligations, and will not infringe any intellectual property right or other legal right, including the right of privacy, of any person or entity. 48 | 1. Each time that you use the Application to post or upload to the Arweave network, you make a commitment to us and to all other Users that you will not $and will not knowingly allow others to$ create, post, share or store Stored Material that is libellous, defamatory, harassing, threatening, or invasive of privacy rights. 49 | 5. You acknowledge that: 50 | 1. no other User has any obligation to review, screen, edit or monitor your proposed Stored Material; 51 | 2. the right and ability of any User to post material to the Arweave network is subject to potential prior peer review by all other then Users, and if a majority of those Users who express a response determine for any reason that the proposed material should not become Stored Material, it may not be accepted into the Arweave network; and 52 | 3. neither we nor any other User has or will have any liability to you $or person working with or through you$ for declining to accept materials into the network. 53 | 6. Arweave reserves the right to pursue available legal recourse against you or other persons with regard to costs and damages incurred by Arweave or any of our affiliates resulting from malicious breach by you or persons working with or through you of the commitments you agree to about the nature of Stored Material. 54 | 3. **LIMITATION OF LIABILITY** 55 | 1. You acknowledge that the Application has not been developed to meet your individual requirements, and that it is therefore your responsibility to ensure that the facilities and functions of the Application meet your requirements. 56 | 2. We shall not in any circumstances whatever be liable to you, whether in contract, tort $including negligence$, breach of statutory duty, or otherwise, arising under or in connection with the Licence for loss of profits, sales, business, or revenue; business interruption; loss or corruption of data or information; loss of business opportunity, goodwill or reputation; or any indirect or consequential loss or damage. 57 | 3. Other than the losses set out in Condition 5.2 $for which we are not liable$, our maximum aggregate liability under or in connection with this Licence whether in contract, tort $including negligence$ or otherwise, shall in all circumstances be limited to GBP 1000.00/US$ 1500.00. This maximum cap does not apply to Condition 5.5. 58 | 4. Nothing in this Licence shall limit or exclude our liability for any liability that cannot be excluded or limited by English law. 59 | 4. **COMMUNICATIONS BETWEEN US** 60 | 1. If you wish to contact us in writing, you can send this to us by e-mail or by pre-paid post to Arweave at team@arweave.org. We will confirm receipt of this by contacting you in writing, normally by e-mail. If we have to contact you or give you notice in writing, we will do so by e-mail or by post to the most recent address you have provided to us. 61 | 5. **EVENTS OUTSIDE OUR CONTROL** 62 | 1. We will not be liable or responsible for any failure to perform, or delay in performance of, any of our obligations under this Licence or for the reduction, suspension or total cessation of functionality of the Application that is caused by an Event Outside Our Control. An Event Outside Our Control means any act or event beyond our reasonable control, including without limitation failure of public or private telecommunications networks. 63 | 2. If an Event Outside Our Control takes place that affects the performance of, or causes the reduction, suspension or total cessation of functionality of the Application our responsibility $if any$ to you and all other Users of the Application will be fully suspended for the duration of the Event Outside Our Control. 64 | 6. **YOUR PERSONAL INFORMATION** 65 | 1. We will only use your personal information as set out in our most recent privacy policy as set out on the Arweave website. 66 | 7. **OTHER IMPORTANT TERMS** 67 | 1. We may transfer our rights and obligations under this Licence to another organisation, but this will not affect your rights or our obligations under this Licence. 68 | 2. Each of the conditions of this Licence operates separately. If any court or competent authority decides that any of them are unlawful or unenforceable, the remaining conditions will remain in full force and effect. 69 | 3. This Licence and its subject matter are governed by English law. You and we both agree that the courts of England and Wales will have non-exclusive jurisdiction. 70 | 71 | \*\*\*\* 72 | 73 | -------------------------------------------------------------------------------- /tools/textury-arkb/README.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: >- 3 | A guide for getting started deploying web apps and web pages to Arweave's 4 | permaweb. 5 | --- 6 | 7 | # Arkb User Guide 8 | 9 | {% hint style="warning" %} 10 | For any questions and support queries regarding Arkb, we strongly recommend that you join our [***Discord server***](https://discord.gg/DjAFMJc) as this is the hub of our developer community. Here you will find plenty of community devs and Arweave team members available to help you out 🤖 11 | {% endhint %} 12 | 13 | ## Installation 14 | 15 | Install the latest version: 16 | ```bash 17 | npm install -g arkb 18 | ``` 19 | 20 | For installation issues, see [***troubleshooting***](#installation-issues-troubleshooting) below 21 | 22 | 23 | ## Quick Start 24 | 25 | 26 | ### Deploy a folder (not for large batches of files) 27 | 28 | ```bash 29 | arkb deploy ./folder --wallet path/to/my/wallet.json 30 | ``` 31 | 32 | ### Save your keyfile 33 | 34 | ```text 35 | arkb wallet-save path/to/arweave-wallet-key.json 36 | ``` 37 | 38 | After saving your key you can now run commands without the `--wallet-file` option, like this 39 | 40 | ```text 41 | arkb deploy ./folder 42 | ``` 43 | 44 | ### Using Bundles 45 | 46 | > **Note:** If you are planning to upload large batches of data transactions to the Arweave network, it is ***strongly*** advised that you use the `--use-bundler` option instead of regular deploy to avoid transaction failures. You can read about bundles and their advantages on the [***Arwiki***](https://arwiki.wiki/#/en/preview/WUAtjfiDQEIqhsUcHXIFTn5ZmeDIE7If9hJREBLRgak). 47 | 48 | ```bash 49 | arkb deploy ./folder --use-bundler URL_OF_BUNDLR_NODE 50 | ``` 51 | 52 | > The current list of Bundlr nodes can be found here [***https://docs.bundlr.network/docs/bundlers***](https://docs.bundlr.network/docs/bundlers) 53 | 54 | > For up-to-date usage please always check the [***Arkb README***](https://github.com/textury/arkb#readme) and [***Bundlr.network docs***](https://docs.bundlr.network) 55 | 56 | ## Other Commands 57 | 58 | ### Check a deployment status 59 | 60 | ```text 61 | arkb status YOUR_TRANSACTION_ID 62 | ``` 63 | Example output 64 | ```bash 65 | # arkb status ERWTghgB8wDkOdKJ-8F1ne6BPIybv_rMLQPGP8c3YuE 66 | Confirmed: true | Status: 200 67 | ``` 68 | Note: If your txid begins with a `-` minus symbol you will need to enclose in quotes and escape the `-` character, like the following 69 | ```bash 70 | # arkb status "\-hvARuCZcnPxcdiqhuSx_qwVKDTsBv3aq6Inz5NiheQ" 71 | Confirmed: true | Status: 200 72 | ``` 73 | 74 | ### Check your wallet balance 75 | 76 | ```bash 77 | # arkb balance 78 | pEbU_SLfRzEseum0_hMB1Ie-hqvpeHWypRhZiPoioDI has a balance of 10.113659492352 AR 79 | ``` 80 | 81 | ## FAQs 82 | 83 | **Why do I need a keyfile?** 84 | 85 | Arweave is a blockchain-like network, so each data upload $transaction$ needs signing with a valid Arweave keyfile. 86 | 87 | **I don't have an Arweave keyfile or tokens?** 88 | 89 | If you don't have any Arweave tokens [***you can get some free to try this out***](https://faucet.arweave.net). 90 | 91 | **I already have an Arweave wallet, how do I get the keyfile?** 92 | 93 | You can use the same keyfiles as the Arweave [Chrome Extension Wallet](https://chrome.google.com/webstore/detail/arweave/iplppiggblloelhoglpmkmbinggcaaoc?hl=en-GB), go to Wallets > Select a wallet > Select 'Export Key' to download the json keyfile. 94 | 95 | You need to transfer funds to your new wallet address before you can use the keyfile for deployments. You can use the [Chrome Extension Wallet](https://chrome.google.com/webstore/detail/arweave/iplppiggblloelhoglpmkmbinggcaaoc?hl=en-GB) for transacting AR between wallets. 96 | 97 | 98 | ## Installation Issues / Troubleshooting 99 | 100 | ### Arkb requires NodeJS v15+ 101 | 102 | Ensure your system/nvm version of NodeJS is updated to version 15 or later. 103 | 104 | ### Make sure you do not have any older versions of arkb installed 105 | 106 | Run the following commands as admin/root 107 | ```bash 108 | npm uninstall -g @textury/arkb 109 | npm uninstall -g arkb 110 | ``` 111 | 112 | Then install a fresh copy of the latest version 113 | ```bash 114 | npm install -g arkb@latest 115 | ``` 116 | --------------------------------------------------------------------------------