Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ethereum-sanction-check

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ethereum-sanction-check

  • 1.0.1
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source
Ethereum Sanction Check for Node.js

This node module help to check if a account is sanction. Currently only chainalysis sanction api is support. Here you can find more Information: https://public.chainalysis.com/docs/index.html#create-an-api-key


Examples

ENS Names compatible

async function main( { tests } ) {
    const check = new SanctionCheck( {
        'providerUrl': process.env.HTTP_NODE_PROVIDER,
        'chainalysisApiKey': process.env.CHAINALYSIS_API_KEY
    } )

    await check.start( { 'tests': tests } )
    check.print()
    return s.checks
}


main( { 'tests': 'vitalik.eth' } )
    .then( checks => console.log( checks ) )
    .catch( e => console.log( e ) )

LISTS with validation check

async function main( { tests } ) {
    const check = new SanctionCheck( {
        'providerUrl': process.env.HTTP_NODE_PROVIDER,
        'chainalysisApiKey': process.env.CHAINALYSIS_API_KEY
    } )

    await check.start( { 'tests': tests } )
    check.print()
    return s.checks
}

const tests = [ 
    '0x0000000000000000000000000000000000000001',
    '0x0000000000000000000000000000000000000002',
    '0x0000000000000000000000000000000000000003',
    null,
    1,
    'invalid'
 ]

main( { 'tests': tests } )
    .then( checks => console.log( checks ) )
    .catch( e => console.log( e ) )

Table of Contents
  1. Examples
  2. Quickstart
  3. Setup
  4. Options
  5. Contributing
  6. License
  7. Code of Conduct
  8. Support my Work

Quickstart
const SanctionCheck = require( 'ethereum-sanction-check' )

const check = new SanctionCheck( {
    'chainalysisApiKey': process.env.CHAINALYSIS_API_KEY
} )

const tests = [ '0x0000000000000000000000000000000000000000' ]

check.start( { 'tests': tests } )
    .then( s => { s.print() } )
    .catch( err => console.log( err ) )

Setup
npm i ethereum-sanction-check

Options

constructor()

const SanctionCheck = require( 'ethereum-sanction-check' )

const check = new SanctionCheck( { 
    'providerUrl': null, 
    'chainalysisApiKey': process.env.CHAINALYSIS_API_KEY
    'sleep': 1, 
    'provider': null 
} )
NameTypeRequiredDefaultDescription
providerUrlStringNonullIs only used for ENS Domainnames: LINK
chainalysisApiKeyStringYesnullYou can find more Information here: LINK
sleepStringNo0Delay between queries in milliseconds
providerEtherjs Provider ObjectNonullBy default it will created for you. You can also pass the object y yourself: LINK

.start( { tests: [] } )

NameTypeRequiredDefaultDescription
testsString or ArrayYesInsert your addresses here as Array or a single string

.print()
Console log all results.

.checks
Return results as array


Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/a6b8/ethereum-sanction-check-for-nodejs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.


Limitations
  • Only chainalysis api included

Credits
License

The module is available as open source under the terms of the MIT License.


Code of Conduct

Everyone interacting in the Statosio project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.


Star us

Please ⭐️ star this Project, every ⭐️ star makes us very happy!

FAQs

Package last updated on 27 May 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc