Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.93 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.93 KB
Raw

JavaScript Crypto helpers for Sorare

@sorare/crypto is a JavaScript library (TypeScript types included) providing various crypto functions to be used to sign your Sorare LimitOrder objects in order to make a bid, create or accept an offer. It can be used in both NodeJS and Browser environments.

Functions

signLimitOrder

The signLimitOrder(privateKey, limitOrder) function is used to sign a LimitOrder object with a Sorare private key.

import { signLimitOrder } from '@sorare/crypto';

const privateKey = /* Your Sorare private key */;
const limitOrder = /* The LimitOrder object you get from GraphQL */;

const signature = signLimitOrder(privateKey, limitOrder);

C++ bindings

Starting from v1.3.2, C++ bindings can be used for faster verifyTransfer and verifyLimitOrder operations. It uses Starkware's crypto-cpp library and can be enabled by adding USE_STARKWARE_CRYPTO_CPP=true to your env. Please note that this variable also needs to be set when yarn install runs in order to build the C++ bindings using node-gyp.

Release

  • Clone git submodules
  • Bump version in package.json
  • Run yarn release

License

@sorare/crypto is MIT licensed.