https://github.com/pedrouid/starkware-controller

Starkware JSON-RPC Controller Library
https://github.com/pedrouid/starkware-controller

Last synced: about 2 months ago
JSON representation

Starkware JSON-RPC Controller Library

• Host: GitHub
• URL: https://github.com/pedrouid/starkware-controller
• Owner: pedrouid
• License: apache-2.0
• Created: 2020-04-21T16:44:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T17:21:08.000Z (almost 2 years ago)
• Last Synced: 2024-10-24T14:29:33.536Z (2 months ago)
• Language: TypeScript
• Size: 800 KB
• Stars: 6
• Watchers: 3
• Forks: 7
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# starkware-controller [![npm version](https://badge.fury.io/js/starkware-controller.svg)](https://badge.fury.io/js/starkware-controller)

Starkware JSON-RPC Controller Library

## Example

```typescript

import StarkwareController from 'starkware-controller';

const mnemonic = `puzzle number lab sense puzzle escape glove faith strike poem acoustic picture grit struggle know tuna soul indoor thumb dune fit job timber motor`;

const rpcUrl = 'https://ropsten.mycustomnode.com';

const store = {

  set: async (key: string, data: any) => {

    window.localStorage.setItem(key, JSON.stringify(data));

  },

  get: async (key: string) => {

    return JSON.parse(window.localStorage.getItem(key));

  },

  remove: async (key: string) => {

    window.localStorage.removeItem(key);

  },

};

//  Create StarkwareController

const controller = new StarkwareController(mnemonic, rpcUrl, store);

// Stark Account Params

const layer = 'starkex';

const application = 'starkexdvf';

const index = '0';

// Get Stark Public Key

const starkPublicKey = await controller.account(layer, application, index);

// 0x59a543d42bcc9475917247fa7f136298bb385a6388c3df7309955fcb39b8dd4

```

## API

```typescript

interface StarkwareController {

  provider: providers.Provider;

  walletIndex: number;

  setProvider(provider: string | providers.Provider): void;

  setWalletIndex(walletIndex: number): void;

  getStarkPublicKey(path?: string): Promise;

  getActiveKeyPair(): Promise;

  getEthereumAddress(): string;

  account(layer: string, application: string, index: string): Promise;

  register(

    contractAddress: string,

    starkPublicKey: string,

    operatorSignature: string

  ): Promise;

  deposit(

    contractAddress: string,

    starkPublicKey: string,

    quantizedAmount: string,

    token: starkwareCrypto.Token,

    vaultId: string

  ): Promise;

  depositCancel(

    contractAddress: string,

    starkPublicKey: string,

    token: starkwareCrypto.Token,

    vaultId: string

  ): Promise;

  depositReclaim(

    contractAddress: string,

    starkPublicKey: string,

    token: starkwareCrypto.Token,

    vaultId: string

  ): Promise;

  transfer(

    from: starkwareCrypto.TransferParams,

    to: starkwareCrypto.TransferParams,

    token: starkwareCrypto.Token,

    quantizedAmount: string,

    nonce: string,

    expirationTimestamp: string

  ): Promise;

  createOrder(

    starkPublicKey: string,

    sell: starkwareCrypto.OrderParams,

    buy: starkwareCrypto.OrderParams,

    nonce: string,

    expirationTimestamp: string

  ): Promise;

  withdrawal(

    contractAddress: string,

    starkPublicKey: string,

    token: starkwareCrypto.Token

  ): Promise;

  fullWithdrawal(

    contractAddress: string,

    starkPublicKey: string,

    vaultId: string

  ): Promise;

  freeze(

    contractAddress: string,

    starkPublicKey: string,

    vaultId: string

  ): Promise;

  verifyEscape(

    contractAddress: string,

    starkPublicKey: string,

    proof: string[]

  ): Promise;

  escape(

    contractAddress: string,

    starkPublicKey: string,

    vaultId: string,

    token: starkwareCrypto.Token,

    quantizedAmount: string

  ): Promise;

}

interface PopulatedTransaction {

  to?: string;

  from?: string;

  nonce?: number;

  gasLimit?: BigNumber;

  gasPrice?: BigNumber;

  data?: string;

  value?: BigNumber;

  chainId?: number;

}

```