AWS SDK for JavaScript
Learn how to pin files and folders to IPFS using the AWS SDK for JavaScript.
AWS SDKs (software development kits) help simplify coding and application development by supporting and providing code objects for use with S3-compatible services. There are a variety of different AWS SDKs, each for a different coding language. This guide covers AWS SDK - JavaScript.
The AWS SDK for JavaScript supports three runtimes:
- JavaScript
- Node.js
- React Native for mobile development
AWS SDK - JavaScript also supports cross-runtime. Cross-runtime is a service client package that can be run on browsers, Node.js, and React-Native without needing any change to the code.
A .car file is a type of compressed archive file that contains multiple files, similar to a ZIP file. .car files are used by the FileCoin and IPFS networks, which utilize the metadata fields to include the IPFS CIDs of each file within the archive.
Read below to learn how to pin files and folders to IPFS using the AWS SDK for JavaScript.



The following code example uploads an IPFS file to the bucket name provided. Replace the following values in the code to match your configuration:
- accessKeyId: Filebase Access Key
- secretAccessKey: Filebase Secret Key
- Bucket: Your Filebase Bucket Name
- Key: The Local Path To The Object To Be Uploaded To IPFS
const AWS = require('aws-sdk');
const fs = require('fs');
const s3 = new AWS.S3({
accessKeyId: 'Filebase-Access-Key',
secretAccessKey: 'Filebase-Secret-Key',
endpoint: 'https://s3.filebase.com',
region: 'us-east-1',
signatureVersion: 'v4',
});
fs.readFile('image.png', (err, data) => {
if (err) {
console.error(err);
return;
}
const params = {
Bucket: 'my-ipfs-bucket',
Key: 'ipfs-file.png',
Body: data,
Metadata: { import: "car" }
};
const request = s3.putObject(params);
request.on('httpHeaders', (statusCode, headers) => {
console.log(`CID: ${headers['x-amz-meta-cid']}`);
});
request.send();
});
git clone https://github.com/web3-storage/ipfs-car
npx ipfs-car
This has been tested with .car archives containing 10,000 or more files. Use either of the following commands, depending on your desired workflow:
ipfs-car --pack path/to/file/or/dir
ipfs-car --pack path/to/files --output path/to/write/ipfs-car.car
The following code example uploads an IPFS file to the bucket name provided. Replace the following values in the code to match your configuration:
- accessKeyId: Filebase Access Key
- secretAccessKey: Filebase Secret Key
- Bucket: Your Filebase Bucket Name
- Key: The Local Path To The Object To Be Uploaded To IPFS
const AWS = require('aws-sdk');
const fs = require('fs');
const s3 = new AWS.S3({
accessKeyId: 'Filebase-Access-Key',
secretAccessKey: 'Filebase-Secret-Key',
endpoint: 'https://s3.filebase.com',
region: 'us-east-1',
signatureVersion: 'v4',
});
fs.readFile('ipfs-car.car', (err, data) => {
if (err) {
console.error(err);
return;
}
const params = {
Bucket: 'my-ipfs-bucket',
Key: 'ipfs-car.car',
Body: data,
Metadata: { import: "car" }
};
const request = s3.putObject(params);
request.on('httpHeaders', (statusCode, headers) => {
console.log(`CID: ${headers['x-amz-meta-cid']}`);
});
request.send();
});
const command = new PutObjectCommand({...});
command.middlewareStack.add(
(next) => async (args) => {
// Check if request is incoming as middleware works both ways
const response = await next(args);
if (!response.response.statusCode) return response;
// Get cid from headers
const cid = response.response.headers["x-amz-meta-cid"];
console.log(cid);
return response;
},
{
step: "build",
name: "addCidToOutput",
},
);
const res = await client.send(command);
If you have any questions, please join our Discord server, or send us an email at [email protected]
Last modified 11mo ago