Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
@stacks/storage
Advanced tools
Store and fetch files with Gaia, the decentralized storage system.
npm install @stacks/storage
Users must authenticate to an app before the storage package will work to save or retrieve data on their behalf.
See also authentication guide using connect for web apps
The storage capabilities will work in cases userSession.isUserSignedIn()
returns true
import { UserSession, AppConfig } from '@stacks/auth';
import { Storage } from '@stacks/storage';
const privateKey = '896adae13a1bf88db0b2ec94339b62382ec6f34cd7e2ff8abae7ec271e05f9d8';
const appConfig = new AppConfig();
const userSession = new UserSession({ appConfig });
userSession.store.getSessionData().userData = <any> {
appPrivateKey: privateKey,
};
const storage = new Storage({ userSession });
Note that you can also use an existing userSession
object created during the authentication process.
const myData = JSON.stringify({
hello: "world",
num: 1
});
const fileUrl = await storage.putFile('my_data.json', myData);
// You'll need to save an entirely new string of modified data using putFile with the same fileName every time you want to update a record.
// There is no separate update method.
Store data at a different path
const fileUrl = await storage.putFile('path/my_data.json', myData);
Put file with options
const putFileOptions = {
// override the default content type
contentType: 'application/json',
// override encrypting data by default
// you can also set encrypt to a private key to specify a custom encryption key
encrypt: false,
// ignore automatic conflict prevention using etags
dangerouslyIgnoreEtag: true
}
const fileUrl = await storage.putFile('my_data.json', myData, putFileOptions);
const fileContent = await storage.getFile('my_data.json');
console.log(fileContent);
Get file with options
const getFileOptions = {
decrypt: false,
// by default files stored are signed and can be verified for authenticity
verify: false
}
const fileContent = await storage.getFile('my_data.json', getFileOptions);
console.log(fileContent);
Get file for other user
// Retrieve public data saved by users other than the one with the active session
// User should have registered username via BNS
const options = {
username: 'yukan.id',
// app: 'https://example.org',
decrypt: false,
};
// Set an additional app property within options to retrieve data for a user as saved by an app hosted at a separate domain
const fileContent = await storage.getFile('my_data.json', options);
console.log(fileContent);
await storage.deleteFile('my_data.json');
Delete the file and the corresponding signature file if signed
await storage.deleteFile('my_data.json', { wasSigned: true });
List all files in the user's Gaia hub
const files: Promise<string | undefined | ArrayBuffer | null>[] = [];
const options = { decrypt: false };
await storage.listFiles((filename: string) => {
if (filename === 'my_data.json') {
files.push(storage.getFile(filename, options));
// return false to stop iterating through files
return false;
} else {
// return true to continue iterating
return true;
}
});
const fileContents = await Promise.all(files);
FAQs
Stacks storage library
The npm package @stacks/storage receives a total of 8,072 weekly downloads. As such, @stacks/storage popularity was classified as popular.
We found that @stacks/storage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.