npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sidetree/cas-s3

v0.3.1-unstable.60

Published

This package contains an implementation of [Content Addressable Storage](https://en.wikipedia.org/wiki/Content-addressable_storage) used in Sidetree.

Downloads

42

Readme

@sidetree/cas-s3

This package contains an implementation of Content Addressable Storage used in Sidetree.

It contains:

  • S3Cas: A CAS interface for AWS S3
  • MockS3Cas: A Mock-CAS interface for AWS S3

Usage

npm install --save @sidetree/cas-s3

Development

git clone https://github.com/transmute-industries/sidetree.js.git && cd sidetree.js
npm install

Testing for this Module

cd packages/cas-s3
npm run test

By default the test for this package will use a the MockS3Cas implementation to replicate the functionality of S3 on AWS. To enable the AWS S3Cas module for testing the following two actions are required.

  1. Create a ~/.aws/credentials file
  2. Enable the use of the S3Cas by editing the test file

Instructions

  1. Create a ~/.aws/credentials file

To create the ~/.aws/credentials you will need to have the aws cli tool, which can be installed from this repository: https://github.com/aws/aws-cli.

Once that is installed, run the aws configure command to create the file.

$ aws configure
AWS Access Key ID: MYACCESSKEY
AWS Secret Access Key: MYSECRETKEY
Default region name [us-west-2]: us-west-2
Default output format [None]: json
  1. Enable the use of the S3Cas by editing the test file

To enable the S3Cas module for testing, the test file is located at src/S3Cas.spec.ts. You must change the variable value of forceMock from true to false. An example is shown below.

import { testSuite } from '@sidetree/cas';
import S3Cas from './S3Cas';
import MockS3Cas from './MockS3Cas';
import casConfig from './cas-config.json';
// import AWS object without services
import AWS from 'aws-sdk/global';

const forceMock = false; // This line

const config = new AWS.Config();
if (forceMock) {
  console.warn('Using mock s3 interface for S3 tests');
} else if (!config.credentials) {
  console.warn(
    'No AWS credentials found in ~/.aws/credentials, using mock interace'
  );
}

const cas =
  config.credentials && !forceMock
    ? new S3Cas(casConfig.s3BucketName)
    : new MockS3Cas();

testSuite(cas);

Note that you will need both the ~/.aws/credentials file and const forceMock = false; for the S3 module to run.

Bucket Name

The default bucket name is sidetree-cas-s3-test. The value for this can be changed in src/cas-config.json.

{
  "s3BucketName": "sidetree-cas-s3-test"
}