Module js-plugin-aws - v0.17.12

AWS Plugin for the Metaplex JavaScript SDK

This plugin provides a storage driver for the Metaplex JavaScript SDK that uses Amazon Web Services (AWS) to upload assets.

Installation

npm install @metaplex-foundation/js-plugin-aws

Usage

The awsStorage plugin uploads assets off-chain to an S3 bucket of your choice.

To set this up, you need to pass in the AWS client as well as the bucket name you wish to use. For instance:

import { awsStorage } from "@metaplex-foundation/js-plugin-aws";
import { S3Client } from "@aws-sdk/client-s3";

const awsClient = new S3Client({
region: "us-east-1",
credentials: {
accessKeyId: "",
secretAccessKey: "",
},
});

metaplex.use(awsStorage(awsClient, 'my-nft-bucket'));

When uploading a MetaplexFile using metaplex.storage().upload(file), the unique name of the file will be used as the AWS key. By default, this will be a random string generated by the SDK but you may explicitly provide your own like so.

const file = toMetaplexFile('file-content', 'filename.jpg', {
uniqueName: 'my-unique-aws-key',
})

const uri = await metaplex.storage().upload(file);

Index

Classes

Functions

Generated using TypeDoc