feat(contracts): upgrade from soroban-client to stellar-sdk

Author: esteblock

packages/contracts/package.json

@@ -30,8 +30,7 @@
   },
   "dependencies": {
     "@soroban-react/core": "^7.4.0",
-    "@stellar/stellar-sdk": "^11.1.0",
-    "soroban-client": "1.0.0-beta.4"
+    "stellar-sdk": "11.1.0"
   },
   "devDependencies": {
     "@babel/preset-react": "^7.22.5",

packages/contracts/src/contractInvoke.tsx

@@ -1,18 +1,18 @@
 import { SorobanContextType } from '@soroban-react/core'
 
-import * as SorobanClient from 'soroban-client'
-import { SorobanRpc } from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+import { SorobanRpc } from 'stellar-sdk'
 
 import { contractTransaction } from './contractTransaction'
 import { signAndSendTransaction } from './transaction'
 import { TxResponse } from './types'
 
-let xdr = SorobanClient.xdr
+let xdr = StellarSdk.xdr
 
 export type InvokeArgs = {
   contractAddress: string
   method: string
-  args?: SorobanClient.xdr.ScVal[] | undefined
+  args?: StellarSdk.xdr.ScVal[] | undefined
   signAndSend?: boolean
   fee?: number
   skipAddingFootprint?: boolean
@@ -35,7 +35,7 @@ export async function contractInvoke({
   secretKey,
   sorobanContext,
   reconnectAfterTx = true,
-}: InvokeArgs): Promise<TxResponse | SorobanClient.xdr.ScVal> {
+}: InvokeArgs): Promise<TxResponse | StellarSdk.xdr.ScVal> {
   const { server, address, activeChain } = sorobanContext
 
   if (!activeChain) {
@@ -55,15 +55,15 @@ export async function contractInvoke({
 
   if (secretKey) {
     source = await server.getAccount(
-      SorobanClient.Keypair.fromSecret(secretKey).publicKey()
+      StellarSdk.Keypair.fromSecret(secretKey).publicKey()
     )
   } else {
     try {
       if (!address) throw new Error('No address')
 
       source = await server.getAccount(address)
     } catch (error) {
-      source = new SorobanClient.Account(defaultAddress, '0')
+      source = new StellarSdk.Account(defaultAddress, '0')
     }
   }
 
@@ -76,10 +76,10 @@ export async function contractInvoke({
     args,
   })
 
-  const simulated: SorobanRpc.SimulateTransactionResponse =
+  const simulated: SorobanRpc.Api.SimulateTransactionResponse =
     await server?.simulateTransaction(txn)
 
-  if (SorobanRpc.isSimulationError(simulated)) {
+  if (SorobanRpc.Api.isSimulationError(simulated)) {
     throw new Error(simulated.error)
   } else if (!simulated.result) {
     throw new Error(`invalid simulation: no result in ${simulated}`)

packages/contracts/src/contractTransaction.tsx

@@ -1,11 +1,12 @@
-import * as SorobanClient from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+
 
 export interface contractTransactionProps {
   networkPassphrase: string
-  source: SorobanClient.Account
+  source: StellarSdk.Account
   contractAddress: string
   method: string
-  args?: SorobanClient.xdr.ScVal[]
+  args?: StellarSdk.xdr.ScVal[]
 }
 
 export function contractTransaction({
@@ -14,15 +15,15 @@ export function contractTransaction({
   contractAddress,
   method,
   args,
-}: contractTransactionProps): SorobanClient.Transaction {
-  let myParams: SorobanClient.xdr.ScVal[] = args || []
-  const contract = new SorobanClient.Contract(contractAddress)
-  return new SorobanClient.TransactionBuilder(source, {
+}: contractTransactionProps): StellarSdk.Transaction {
+  let myParams: StellarSdk.xdr.ScVal[] = args || []
+  const contract = new StellarSdk.Contract(contractAddress)
+  return new StellarSdk.TransactionBuilder(source, {
     // TODO: Figure out the fee
     fee: '100',
     networkPassphrase,
   })
     .addOperation(contract.call(method, ...myParams))
-    .setTimeout(SorobanClient.TimeoutInfinite)
+    .setTimeout(StellarSdk.TimeoutInfinite)
     .build()
 }

packages/contracts/src/setTrustline.tsx

@@ -1,7 +1,7 @@
 import { SorobanContextType } from '@soroban-react/core'
 
-import * as StellarSdk from '@stellar/stellar-sdk'
-import * as SorobanClient from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+
 
 export async function setTrustline({
   tokenSymbol,
@@ -41,7 +41,7 @@ export async function setTrustline({
     networkPassphrase,
   })
     .addOperation(operation)
-    .setTimeout(SorobanClient.TimeoutInfinite)
+    .setTimeout(StellarSdk.TimeoutInfinite)
     .build()
 
   const signed = await sorobanContext.activeConnector?.signTransaction(

packages/contracts/src/transaction.tsx

@@ -1,8 +1,9 @@
 import { SorobanContextType } from '@soroban-react/core'
 
 import { Sign } from 'crypto'
-import * as SorobanClient from 'soroban-client'
-import { SorobanRpc } from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+
+import { SorobanRpc } from 'stellar-sdk'
 
 import type { Tx, Transaction, TxResponse } from './types'
 
@@ -29,7 +30,7 @@ export async function signAndSendTransaction({
 
   // preflight and add the footprint !
   if (!skipAddingFootprint) {
-    txn = await server.prepareTransaction(txn, networkPassphrase)
+    txn = await server.prepareTransaction(txn)
     if (!txn) {
       throw new Error('No transaction after adding footprint')
     }
@@ -42,8 +43,8 @@ export async function signAndSendTransaction({
   // if (auth_len > 1) {
   //   throw new NotImplementedError("Multiple auths not yet supported");
   // } else if (auth_len == 1) {
-  //   // TODO: figure out how to fix with new SorobanClient
-  //   // const auth = SorobanClient.xdr.SorobanAuthorizationEntry.fromXDR(auths![0]!, 'base64')
+  //   // TODO: figure out how to fix with new StellarSdk
+  //   // const auth = StellarSdk.xdr.SorobanAuthorizationEntry.fromXDR(auths![0]!, 'base64')
   //   // if (auth.addressWithNonce() !== undefined) {
   //   //   throw new NotImplementedError(
   //   //     `This transaction needs to be signed by ${auth.addressWithNonce()
@@ -55,21 +56,19 @@ export async function signAndSendTransaction({
   let signed = ''
   if (secretKey) {
     // User as set a secretKey, txn will be signed using the secretKey
-    const keypair = SorobanClient.Keypair.fromSecret(secretKey)
+    const keypair = StellarSdk.Keypair.fromSecret(secretKey)
     txn.sign(keypair)
     signed = txn.toXDR()
   } else if (sorobanContext.activeConnector) {
     // User has not set a secretKey, txn will be signed using the Connector (wallet) provided in the sorobanContext
-    signed = await sorobanContext.activeConnector.signTransaction(txn.toXDR(), {
-      networkPassphrase,
-    })
+    signed = await sorobanContext.activeConnector.signTransaction(txn.toXDR())
   } else {
     throw new Error(
       'signAndSendTransaction: no secretKey, neither active Connector'
     )
   }
 
-  const transactionToSubmit = SorobanClient.TransactionBuilder.fromXDR(
+  const transactionToSubmit = StellarSdk.TransactionBuilder.fromXDR(
     signed,
     networkPassphrase
   )
@@ -89,7 +88,7 @@ export async function sendTx({
 }: {
   tx: Tx
   secondsToWait: number
-  server: SorobanClient.Server
+  server: StellarSdk.SorobanRpc.Server
 }): Promise<TxResponse> {
   const sendTransactionResponse = await server.sendTransaction(tx)
   let getTransactionResponse = await server.getTransaction(
@@ -116,7 +115,7 @@ export async function sendTx({
   }
 
   if (
-    getTransactionResponse.status === SorobanRpc.GetTransactionStatus.NOT_FOUND
+    getTransactionResponse.status === SorobanRpc.Api.GetTransactionStatus.NOT_FOUND
   ) {
     console.error(
       `Waited ${secondsToWait} seconds for transaction to complete, but it did not. ` +

packages/contracts/src/types.tsx

@@ -1,17 +1,18 @@
-import * as SorobanClient from 'soroban-client'
-import { SorobanRpc } from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+
+import { SorobanRpc } from 'stellar-sdk'
 import type {
   Memo,
   MemoType,
   Operation,
-  Transaction as SorobanClientTransaction,
-} from 'soroban-client'
+  Transaction as StellarSdkTransaction,
+} from 'stellar-sdk'
 
 export type Transaction =
-  | SorobanClient.Transaction
-  | SorobanClient.FeeBumpTransaction
-export type Tx = SorobanClientTransaction<Memo<MemoType>, Operation[]>
-export type TxResponse = SorobanRpc.GetTransactionResponse & {
+  | StellarSdk.Transaction
+  | StellarSdk.FeeBumpTransaction
+export type Tx = StellarSdkTransaction<Memo<MemoType>, Operation[]>
+export type TxResponse = SorobanRpc.Api.GetTransactionResponse & {
   txHash: string
 }
-export type Simulation = SorobanRpc.SimulateTransactionResponse
+export type Simulation = SorobanRpc.Api.SimulateTransactionResponse

packages/contracts/src/useContractValue.tsx

@@ -1,25 +1,26 @@
 import { SorobanContextType } from '@soroban-react/core'
 import React from 'react'
 
-import { SorobanRpc } from 'soroban-client'
-import * as SorobanClient from 'soroban-client'
+import { SorobanRpc } from 'stellar-sdk'
+import * as StellarSdk from 'stellar-sdk'
+
 
 import { contractTransaction } from './contractTransaction'
 import { defaultAddress } from './defaultAddress'
 
-let xdr = SorobanClient.xdr
+let xdr = StellarSdk.xdr
 
 export type ContractValueType = {
   loading?: true
-  result?: SorobanClient.xdr.ScVal
+  result?: StellarSdk.xdr.ScVal
   error?: string | unknown
 }
 
 export interface useContractValueProps {
   contractAddress: string
   method: string
-  args?: SorobanClient.xdr.ScVal[] | undefined
-  source?: SorobanClient.Account
+  args?: StellarSdk.xdr.ScVal[] | undefined
+  source?: StellarSdk.Account
   sorobanContext: SorobanContextType
 }
 
@@ -42,7 +43,7 @@ export function useContractValue({
   )
 
   React.useEffect(() => {
-    source = source ?? new SorobanClient.Account(address ?? defaultAddress, '0')
+    source = source ?? new StellarSdk.Account(address ?? defaultAddress, '0')
     if (!activeChain) {
       setValue({ error: 'No active chain' })
       return
@@ -84,12 +85,12 @@ export function useContractValue({
 }
 
 export interface fetchContractValueProps {
-  server: SorobanClient.Server
+  server: SorobanRpc.Server
   networkPassphrase: string
   contractAddress: string
   method: string
-  args?: SorobanClient.xdr.ScVal[] | undefined
-  source: SorobanClient.Account
+  args?: StellarSdk.xdr.ScVal[] | undefined
+  source: StellarSdk.Account
 }
 
 async function fetchContractValue({
@@ -99,7 +100,7 @@ async function fetchContractValue({
   method,
   args,
   source,
-}: fetchContractValueProps): Promise<SorobanClient.xdr.ScVal> {
+}: fetchContractValueProps): Promise<StellarSdk.xdr.ScVal> {
   //Builds the transaction.
   let txn = contractTransaction({
     source,
@@ -111,9 +112,9 @@ async function fetchContractValue({
 
   let a = Math.random()
 
-  const simulated: SorobanRpc.SimulateTransactionResponse =
+  const simulated: SorobanRpc.Api.SimulateTransactionResponse =
     await server?.simulateTransaction(txn)
-  if (SorobanRpc.isSimulationError(simulated)) {
+  if (SorobanRpc.Api.isSimulationError(simulated)) {
     throw new Error(simulated.error)
   } else if (!simulated.result) {
     throw new Error(`invalid simulation: no result in ${simulated}`)

packages/contracts/src/useSendTransaction.tsx

@@ -1,15 +1,16 @@
 import { SorobanContextType } from '@soroban-react/core'
 import React from 'react'
 
-import * as SorobanClient from 'soroban-client'
+import * as StellarSdk from 'stellar-sdk'
+
 
 import { signAndSendTransaction } from './transaction'
 import type { Transaction, Tx, TxResponse, Simulation } from './types'
 
 export type TransactionStatus = 'idle' | 'error' | 'loading' | 'success'
 
 export interface SendTransactionResult<E = Error> {
-  data?: SorobanClient.xdr.ScVal
+  data?: StellarSdk.xdr.ScVal
   error?: E
   isError: boolean
   isIdle: boolean

packages/contracts/tests/setTrustline.test.js

@@ -1,5 +1,5 @@
 const { setTrustline } = require('../dist/setTrustline')
-const SorobanClient = require('soroban-client')
+const StellarSdk = require('soroban-client')
 describe('setTrustline', () => {
   const tokenSymbol = 'XLM'
   const tokenAdmin = 'GAV6GQGSOSGCRX262R4MTGKNT6UDWJTNUQLLWBZK5CHHRB5GMNNC7XAB'
@@ -55,7 +55,7 @@ describe('setTrustline', () => {
     }
     sorobanContext.server = {
       async getAccount() {
-        return new SorobanClient.Account(
+        return new StellarSdk.Account(
           'GAV6GQGSOSGCRX262R4MTGKNT6UDWJTNUQLLWBZK5CHHRB5GMNNC7XAB',
           '231'
         )
@@ -82,7 +82,7 @@ describe('setTrustline', () => {
     }
     sorobanContext.server = {
       async getAccount() {
-        return new SorobanClient.Account(
+        return new StellarSdk.Account(
           'GAV6GQGSOSGCRX262R4MTGKNT6UDWJTNUQLLWBZK5CHHRB5GMNNC7XAB',
           '231'
         )