Class SecretSDK

SecretSDK interface

Hierarchy

SecretSDK

Constructors

constructor

new SecretSDK(account: SecretAccount, serverAddr: string, circuitPath: string, eddsa: any, userAccount: any, spongePoseidonAddress: string, tokenRegistryAddress: string, poseidon2Address: string, poseidon3Address: string, poseidon6Address: string, rollupAddress: string, smtVerifierAddress?: string): SecretSDK
Parameters
- account: SecretAccount
- serverAddr: string
- circuitPath: string
- eddsa: any
- userAccount: any
- spongePoseidonAddress: string
- tokenRegistryAddress: string
- poseidon2Address: string
- poseidon3Address: string
- poseidon6Address: string
- rollupAddress: string
- smtVerifierAddress: string = ""
Returns SecretSDK
- Defined in sdk.ts:41

Properties

account

account: SecretAccount

alias

alias: string

circuitPath

circuitPath: string

eddsa

eddsa: any

`Private` noteBuff

noteBuff: any[] = ...

rollupSC

rollupSC: RollupSC

serverAddr

serverAddr: any

`Private` txBuff

txBuff: any[] = ...

Methods

`Private` addNotes

addNotes(encryptedNotes: any): Promise<void>
Parameters
- encryptedNotes: any
Returns Promise<void>
- Defined in sdk.ts:233

`Private` adoptNotes

adoptNotes(ctx: Context, notes: Note[], encryptedNotes: any[]): Promise<AppResp>
Parameters
- ctx: Context
- notes: Note[]
- encryptedNotes: any[]
Returns Promise<AppResp>
- Defined in sdk.ts:519

allowance

allowance(token: string): Promise<AppResp>
Parameters
- token: string
Returns Promise<AppResp>
- Defined in sdk.ts:1073

approve

approve(token: string, value: bigint): Promise<any>
Parameters
- token: string
- value: bigint
Returns Promise<any>
- Defined in sdk.ts:1065

approveToken

approveToken(token: string): Promise<any>
register testToken to rollup contract
Parameters
- token: string
Returns Promise<any>
- Defined in sdk.ts:1035

`Private` commit

commit(ctx: Context): Promise<AppResp>
Parameters
- ctx: Context
Returns Promise<AppResp>
- Defined in sdk.ts:247

createAccount

createAccount(ctx: Context, password: string): Promise<AppResp>
Create proof for the secret account created.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the createAccount.
Parameters
- ctx: Context
- password: string
  
  The password used to decrypt the SecretAccount.
Returns Promise<AppResp>
- Defined in sdk.ts:1094

createAsset

createAsset(ctx: Context, token: string, assetId: any): Promise<AppResp>
Parameters
- ctx: Context
- token: string
- assetId: any
Returns Promise<AppResp>
- Defined in sdk.ts:1042

`Private` createServerAccount

createServerAccount(ctx: Context, password: string): Promise<AppResp>
Parameters
- ctx: Context
- password: string
Returns Promise<AppResp>
- Defined in sdk.ts:99

`Private` createTx

createTx(txData: string, proofAndPublicSignals: any, operation: string): Promise<void>
Parameters
- txData: string
- proofAndPublicSignals: any
- operation: string
Returns Promise<void>
- Defined in sdk.ts:237

`Private` curl

curl(resource: string, params: any): Promise<AppResp>
Parameters
- resource: string
- params: any
Returns Promise<AppResp>
- Defined in sdk.ts:68

deposit

deposit(ctx: Context, receiver: string, value: bigint, assetId: number, nonce: number): Promise<AppResp>
Create proof for the deposit of the asset from L1 to L2.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the deposit.
Parameters
- ctx: Context
- receiver: string
  
  The receiver account address for the deposit.
- value: bigint
  
  The amount of asset to be deposited.
- assetId: number
  
  The token to be deposited.
- nonce: number
  
  The nonce of the current transaction, usually obtained from a wallet like Metamask.
Returns Promise<AppResp>
- Defined in sdk.ts:559

fallback

fallback(_ctx: Context): Promise<void>
Parameters
- _ctx: Context
Returns Promise<void>
- Defined in sdk.ts:263

`Private` fetchTransaction

fetchTransaction(ctx: Context, options: any): Promise<AppResp>
Parameters
- ctx: Context
- options: any
Returns Promise<AppResp>
- Defined in sdk.ts:267

formatValue

formatValue(_ctx: Context, value: string | bigint, assetId: number, decimals?: number): string
Parameters
- _ctx: Context
- value: string | bigint
- assetId: number
- decimals: number = 18
Returns string
- Defined in sdk.ts:1058

getAllBalance

getAllBalance(ctx: Context): Promise<AppResp>
Obtain user balance.

Returns
An AppResp object with data property of type 'Map' which contains user balance. { "assetInfo": [ { "assetId": 2, "balance": "20", "tokenInfo": { "chainId": "1", "address": "0x0165878A594ca255338adfa4d48449f69242Eb8F", "name": "TT", "symbol": "TT", "decimals": 18, "logoURI": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2/logo.png", "extensions": "" }, "balanceUSD": 20, "profit24Hour": 0, "return": 0 } ], "totalBalanceUSD": 20, "totalProfit24Hour": 0, "totalReturn": 0 }
Parameters
- ctx: Context
Returns Promise<AppResp>
- Defined in sdk.ts:437

`Private` getAndDecryptNote

getAndDecryptNote(ctx: Context, noteState: NoteState[], indices?: string[], skipZeroNote?: boolean): Promise<AppResp>
Retrieve all current user's unspent notes.

Returns
An AppResp object with data property of type Array<Note> if notes are successfully retrieved.
Parameters
- ctx: Context
- noteState: NoteState[]
- indices: string[] = []
- skipZeroNote: boolean = true
  
  is false if all notes(with val 0) are required to return
Returns Promise<AppResp>
- Defined in sdk.ts:506

getAssetInfo

getAssetInfo(ctx: Context): Promise<AppResp>
Fetch registered token list from server

Returns
token symbol to token asset id and it's contract address, e.g. { message: 'Success', errno: 0, data: [ { assetId: '2', latest_price: 1, latest_24h_price: 1, tokenInfo: { chainId: '', address: '0x0165878A594ca255338adfa4d48449f69242Eb8F', name: 'Unknown Token', symbol: '', decimals: 18, logoURI: '', extensions: '' } } ] }
Parameters
- ctx: Context
Returns Promise<AppResp>
- Defined in sdk.ts:402

getNotes

getNotes(ctx: Context, noteState: NoteState[], indices?: string[]): Promise<AppResp>
Parameters
- ctx: Context
- noteState: NoteState[]
- indices: string[] = []
Returns Promise<AppResp>
- Defined in sdk.ts:224

getProofs

getProofs(ctx: Context): Promise<AppResp>
Parameters
- ctx: Context
Returns Promise<AppResp>
- Defined in sdk.ts:353

getRegisteredToken

getRegisteredToken(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
- Defined in sdk.ts:1081

getTransactions

getTransactions(ctx: Context, options: any): Promise<AppResp>
Returns
transactions, e.g. [ { operation: 'deposit', amount: '0', assetId: 2, to: '', txhash: '', timestamp: '2023-05-14 13:52:12.546 +00:00' } ]
Parameters
- ctx: Context
- options: any
Returns Promise<AppResp>
- Defined in sdk.ts:292

initialize

initialize(contractABI: any): Promise<void>
Connect the rollup contracts.
Parameters
- contractABI: any
  
  the contracts ABI directory
Returns Promise<void>
- Defined in sdk.ts:364

migrateAccount

migrateAccount(ctx: Context, newAccountKey: SigningKey, password: string): Promise<AppResp>
Create proof for migrating the account to another ETH address.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the migrateAccount.
Parameters
- ctx: Context
- newAccountKey: SigningKey
  
  The account key that which user renews.
- password: string
  
  The password used to decrypt the SecretAccount.
Returns Promise<AppResp>
- Defined in sdk.ts:1281

parseValue

parseValue(_ctx: Context, value: string, assetId: number, decimals?: number): bigint
Parameters
- _ctx: Context
- value: string
- assetId: number
- decimals: number = 18
Returns bigint
- Defined in sdk.ts:1051

registerToken

registerToken(token: string): Promise<void>
register testToken to rollup contract
Parameters
- token: string
Returns Promise<void>
- Defined in sdk.ts:1027

send

send(ctx: Context, receiver: string, receiverAlias: string, value: bigint, assetId: number): Promise<AppResp>
Creates proof for sending an asset from the sender to the receiver in L2.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the send.
Parameters
- ctx: Context
- receiver: string
  
  The receiver account address for the send.
- receiverAlias: string
  
  The receiver's alias or ‘__DEFAULT_ALIAS__’.
- value: bigint
  
  The amount of asset to be sent.
- assetId: number
  
  The token to be sent.
Returns Promise<AppResp>
- Defined in sdk.ts:696

setRollupNC

setRollupNC(): Promise<void>
register testToken to rollup contract

Returns Promise<void>
- Defined in sdk.ts:1019

submitProofs

submitProofs(ctx: Context, proofs: any): Promise<AppResp>
Parameters
- ctx: Context
- proofs: any
Returns Promise<AppResp>
- Defined in sdk.ts:345

updateAccount

updateAccount(ctx: Context, newSigningKey: SigningKey, password: string): Promise<any>
Create a proof for updating the user's signing key.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the updateAccount.
Parameters
- ctx: Context
- newSigningKey: SigningKey
  
  The new signing key to be updated to.
- password: string
  
  The password used to decrypt the SecretAccount.
Returns Promise<any>
- Defined in sdk.ts:1158

`Private` updateServerAccount

updateServerAccount(ctx: Context, password: string): Promise<AppResp>
Parameters
- ctx: Context
- password: string
Returns Promise<AppResp>
- Defined in sdk.ts:112

updateStateTree

updateStateTree(ctx: Context, outputNc1: bigint, nullifier1: bigint, outputNc2: bigint, nullifier2: bigint, acStateKey: bigint, padding?: boolean): Promise<AppResp>
Parameters
- ctx: Context
- outputNc1: bigint
- nullifier1: bigint
- outputNc2: bigint
- nullifier2: bigint
- acStateKey: bigint
- padding: boolean = true
Returns Promise<AppResp>
- Defined in sdk.ts:200

withdraw

withdraw(ctx: Context, receiver: string, value: bigint, assetId: number): Promise<AppResp>
Creates a proof for withdrawing an asset from L2 to L1.

Returns
An AppResp object with data property of type 'string[]' which contains a batch of proof for the withdraw.
Parameters
- ctx: Context
- receiver: string
- value: bigint
  
  The amount to be withdrawn.
- assetId: number
  
  The token to be withdrawn.
Returns Promise<AppResp>
- Defined in sdk.ts:814

`Static` curlEx

curlEx(serverAddr: string, resource: string, params: any): Promise<AppResp>
Parameters
- serverAddr: string
- resource: string
- params: any
Returns Promise<AppResp>
- Defined in sdk.ts:72

`Static` initSDKFromAccount

initSDKFromAccount(ctx: Context, serverAddr: string, password: string, user: any, contractJson: any, circuitPath: string, contractABI: any, isCreate??: boolean): Promise<AppResp>
Initializes the SDK from either an existing account or no account.

Returns
An AppResp object with data property of type 'class' that contains the initialized SecretSDK instance.
Parameters
- ctx: Context
- serverAddr: string
  
  The address of the server to connect to.
- password: string
  
  The password used to encrypt the SecretAccount for secure storage.
- user: any
  
  The Ethereum address of the user.
- contractJson: any
  
  The JSON object for the contract.
- circuitPath: string
  
  The path to the circuit file.
- contractABI: any
  
  The ABI of the contract.
- Optional isCreate: boolean = false
  
  the flag indicating whether to create a new account. Optional.
Returns Promise<AppResp>
- Defined in sdk.ts:137

Class SecretSDK

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

account: SecretAccount

serverAddr: string

circuitPath: string

eddsa: any

userAccount: any

spongePoseidonAddress: string

tokenRegistryAddress: string

poseidon2Address: string

poseidon3Address: string

poseidon6Address: string

rollupAddress: string

smtVerifierAddress: string = ""

Returns SecretSDK

Properties

account

alias

circuitPath

eddsa

Private noteBuff

rollupSC

serverAddr

Private txBuff

Methods

Private addNotes

Parameters

encryptedNotes: any

Returns Promise<void>

Private adoptNotes

Parameters

ctx: Context

notes: Note[]

encryptedNotes: any[]

Returns Promise<AppResp>

allowance

Parameters

token: string

Returns Promise<AppResp>

approve

Parameters

token: string

value: bigint

Returns Promise<any>

approveToken

Parameters

token: string

Returns Promise<any>

Private commit

Parameters

ctx: Context

Returns Promise<AppResp>

createAccount

Returns

Parameters

ctx: Context

password: string

Returns Promise<AppResp>

createAsset

Parameters

ctx: Context

token: string

assetId: any

Returns Promise<AppResp>

Private createServerAccount

Parameters

ctx: Context

password: string

Returns Promise<AppResp>

Private createTx

Parameters

txData: string

proofAndPublicSignals: any

`Private` noteBuff

`Private` txBuff

`Private` addNotes

`Private` adoptNotes

`Private` commit

`Private` createServerAccount

`Private` createTx

`Private` curl

`Private` fetchTransaction

`Private` getAndDecryptNote