Setting up your account

Before being able to upload and download data onto the LimeWire Network you will have to set up an Account, API Key(s), Bucket(s), Access Policies and Access Policy Attachment. Please follow these steps for getting started:

1. Set up an Account

First, head on over to our Dapp at https://dapp.limewire.network and connect a Binance Smartchain compatible wallet. In order to create an account, you’ll have to perform the “Signup” operation.

For all operations listed here, you’ll have to have BNB available in your wallet for the Gas fees.

2. Fund your Account

LimeWire Network uses LMWR natively. You’ll have to click on “Top Up Now” to top up your LMWR balance. Please make sure that you have LMWR on the BNB chain in your wallet. For more information please see https://lmwr.com .

3. Create a Bucket

LimeWire Network buckets are equivalent to AWS S3 buckets. They must have a unique name across the entire LimeWire Network. In contract to AWS S3 though, once a bucket is deleted, bucket names can’t be reused anymore.

Choose a descriptive name for your bucket and Click the “Create Bucket” button in the Buckets List on https://dapp.limewire.network/buckets/

4. Create an Access Policy for your Bucket

LimeWire Network access policies have the same format as AWS S3 access policies. In the Dapp, click on your bucket’s name and then “Access Policies” → “New Policy”. For the purpose of this demo, we suggest that you click on the “Read & Write” policy and create it

5. Create an API Key and associate it with your Access Policy

For security reasons, your Account wallet is never used directly to interact with storage operations. Instead, we create API Keys used in the ECDSA signing of the storage payloads. API Keys are using the secp256k1 curve - secp256k1 is a specific elliptic curve used for public‑key cryptography, best known as the curve used by Ethereum/Bitcoin/Binance. We chose this curve so that you can re-use all your tools.

In the Dapp, click on “API Keys” and then “Create API Key”. You can choose to use the one presented to you (calculated in your browser, the private key is not sent to the LimeWire Network) or import an existing public key that is on the secp256k1 curve. Make sure to save your private key - you’ll need it later on.
After creating the API Key you will have to associate the API key with the Access Policy that you created earlier. Click on the API Key and attach the policy that you created.

6. Setup done 🎉

Congratulations, you are done with the initial setup steps.

Now you can choose to either follow the native SDK steps to integrate your apps with LimeWire Network OR you can choose to use any s3-compatible client by using our public S3 Gateway.

Getting Started with SDKS

The SDKs allow you to natively use LimeWire Network’s infrastructure without having to go through S3 Gatways. We currently offer SDKs for Javascript/Typescript, Go and Java. The SDKs are a thin wrapper around the official AWS S3 SDKs and just need a few lines of code to transform any existing S3-based application to a LimeWire Network-native capable one.

Typescript / Javascript SDK

Please see the Github repository for a getting started guide with the integration

https://github.com/LimeWireOfficial/lmwrntwrk-sdk-ts

Java SDK

We also have a Github repository with instructions for you for the Java SDK:

https://github.com/LimeWireOfficial/lmwrntwrk-sdk-java

Go SDK

Lastly, we also provide a fully-featured Golang SDK:

https://github.com/LimeWireOfficial/lmwrntwrk-sdk-go

Getting Started using the Public S3 Gateway

If you have legacy clients that are S3 compatible or if you don’t want to or can’t change your software to use the SDKs, you can utilize our public S3 Gateways to access your data in the LimeWire Network.

During the public beta, the following S3 gateway endpoint is available:

s3-gw.us-east.limewire.network

After the beta phase, more regions will be made available and you will also be able to download and setup your own S3 gateway. Please contact us if you need to run your own in the meantime.

In order to use the S3 Gateway, you will have to send the Private Key of one of your API Keys to the gateway in order for it to be able to do its job. Please be careful not to use your crypto wallet’s private keys!

To get started, please follow these steps:

You will have to have completed all the steps of “Setting up your Account”
In the Dapp, click on “S3 Gateways”
Next to the “official” Gateway (s3-gw.us-east.limewire.network ) click “Connect”
Paste in your API Key and finish connecting to the Gateway
Click on “Create New Key” in the “Manage HMAC Keys” section. Be sure to save both the “Access Key” and “Secret Key”

Depending on your client, you will need to configure the following settings:

S3 Endpoint: https://s3-gw.us-east.limewire.network
Region: us-east-1 (default)
Access Key or AWS_ACCESS_KEY_ID environment variable: The access key that you copied
Secret Key or AWS_SECRET_KEY_ID environment variable

That’s it - you should be good to go! 🎉