v0.6.0 Remove registration signing (#23)

* Signable -> StarkSignable

* v0.6.0 Remove signable registration

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/starkex-lib",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Cryptographic functions for use with StarkEx",
   "main": "build/src/index.js",
   "scripts": {

src/signable/api-request.ts

@@ -4,12 +4,12 @@ import BN from 'bn.js';
 
 import { hexToBn } from '../lib/util';
 import { ApiRequestParams } from '../types';
-import { Signable } from './signable';
+import { StarkSignable } from './stark-signable';
 
 /**
  * Wrapper object to hash, sign, and verify an API request.
  */
-export class SignableApiRequest extends Signable<ApiRequestParams> {
+export class SignableApiRequest extends StarkSignable<ApiRequestParams> {
 
   public constructor(
     apiRequest: ApiRequestParams,

src/signable/index.ts

@@ -1,5 +1,4 @@
 export { SignableApiRequest } from './api-request';
 export { SignableOraclePrice } from './oracle-price';
 export { SignableOrder } from './order';
-export { SignableRegistration } from './registration';
 export { SignableWithdrawal } from './withdrawal';

src/signable/oracle-price.ts

@@ -8,12 +8,12 @@ import {
   OraclePriceWithAssetId,
 } from '../types';
 import { ORACLE_PRICE_FIELD_BIT_LENGTHS } from './constants';
-import { Signable } from './signable';
+import { StarkSignable } from './stark-signable';
 
 /**
  * Wrapper object to hash, sign, and verify an oracle price.
  */
-export class SignableOraclePrice extends Signable<OraclePriceWithAssetId> {
+export class SignableOraclePrice extends StarkSignable<OraclePriceWithAssetId> {
 
   static fromPrice = SignableOraclePrice.fromPriceWithAssetName; // Alias.
 

src/signable/order.ts

@@ -23,15 +23,15 @@ import {
 import {
   ORDER_FIELD_BIT_LENGTHS,
 } from './constants';
-import { Signable } from './signable';
+import { StarkSignable } from './stark-signable';
 
 const LIMIT_ORDER_WITH_FEES = 3;
 const ORDER_PADDING_BITS = 17;
 
 /**
  * Wrapper object to convert an order, and hash, sign, and verify its signature.
  */
-export class SignableOrder extends Signable<StarkwareOrder> {
+export class SignableOrder extends StarkSignable<StarkwareOrder> {
 
   static fromOrder = SignableOrder.fromOrderWithClientId; // Alias.
 

src/signable/signable.ts → src/signable/stark-signable.ts

@@ -14,9 +14,9 @@ import { bnToHex32 } from '../lib/util';
 import { KeyPair } from '../types';
 
 /**
- * Base class for a Starkware signable message.
+ * Base class for a STARK key signable message.
  */
-export abstract class Signable<T> {
+export abstract class StarkSignable<T> {
   protected readonly message: T;
 
   private _hashBN: BN | null = null;
@@ -27,6 +27,9 @@ export abstract class Signable<T> {
     this.message = message;
   }
 
+  /**
+   * Return the message hash as a hex string, no 0x prefix.
+   */
   get hash(): string {
     return this.hashBN.toString(16);
   }

src/signable/withdrawal.ts

@@ -17,7 +17,7 @@ import {
   WithdrawalWithClientId,
 } from '../types';
 import { WITHDRAWAL_FIELD_BIT_LENGTHS } from './constants';
-import { Signable } from './signable';
+import { StarkSignable } from './stark-signable';
 
 const COLLATERAL_ASSET_ID_BN = hexToBn(COLLATERAL_ASSET_ID);
 const WITHDRAWAL_PREFIX = 6;
@@ -26,7 +26,7 @@ const WITHDRAWAL_PADDING_BITS = 49;
 /**
  * Wrapper object to convert a withdrawal, and hash, sign, and verify its signature.
  */
-export class SignableWithdrawal extends Signable<StarkwareWithdrawal> {
+export class SignableWithdrawal extends StarkSignable<StarkwareWithdrawal> {
 
   static fromWithdrawal = SignableWithdrawal.fromWithdrawalWithClientId; // Alias.
 

src/types.ts

@@ -117,13 +117,6 @@ export interface ApiRequestParams {
   body: string;
 }
 
-// ============ Regsistration Parameters ============
-
-export interface RegistrationParams {
-  ethereumAddress: string;
-  starkKey: string;
-}
-
 // ============ Oracle Price Parameters ============
 
 export interface OraclePriceWithAssetName {