chore: fix return comment and set_emis contract call

script3 · Mar 13, 2024 · 92c1586 · 92c1586
1 parent 4e33cf3
commit 92c1586
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 32 deletions.
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "version": "0.2.0",
+    "version": "0.3.0",
     "name": "soroban-governor-js-sdk",
     "dependencies": {
         "@stellar/freighter-api": "1.7.1",

diff --git a/src/governor.ts b/src/governor.ts
@@ -271,7 +271,7 @@ export class GovernorClient {
    * Constructs an initialize operation
    * @param votes - The address of the votes contract
    * @param settings - The governor settings for managing proposals
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   initialize({
     votes,
@@ -293,7 +293,7 @@ export class GovernorClient {
 
   /**
    * Construct a settings operation. (READ ONLY: Operation should only be simulated)
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   settings(): string {
     return this.contract
@@ -307,7 +307,7 @@ export class GovernorClient {
    * @param title - The title of the proposal
    * @param description - The description of the proposal
    * @param action - The action to be taken by the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   propose({
     creator,
@@ -340,7 +340,7 @@ export class GovernorClient {
   /**
    * Contructs a getProposal operation (READ ONLY: Operation should only be simulated)
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getProposal({ proposal_id }: { proposal_id: u32 }): string {
     return this.contract
@@ -356,7 +356,7 @@ export class GovernorClient {
   /**
    * Construct a close operation
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   close({ proposal_id }: { proposal_id: u32 }): string {
     return this.contract
@@ -372,7 +372,7 @@ export class GovernorClient {
   /**
    * Construct a execute operation
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   execute({ proposal_id }: { proposal_id: u32 }): string {
     return this.contract
@@ -389,7 +389,7 @@ export class GovernorClient {
    * Construct a cancel operation
    * @param creator - The address of the creator
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   cancel({
     creator,
@@ -414,7 +414,7 @@ export class GovernorClient {
    * @param voter - The address of the voter
    * @param proposal_id - The id of the proposal
    * @param support - The vote
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   vote({
     voter,
@@ -441,7 +441,7 @@ export class GovernorClient {
    * Construct a getVote operation (READ ONLY: Operation should only be simulated)
    * @param voter - The address of the voter
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getVote({ voter, proposal_id }: { voter: string; proposal_id: u32 }): string {
     return this.contract
@@ -458,7 +458,7 @@ export class GovernorClient {
   /**
    * Construct a getProposalVotes operation (READ ONLY: Operation should only be simulated)
    * @param proposal_id - The id of the proposal
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getProposalVotes({ proposal_id }: { proposal_id: u32 }): string {
     return this.contract

diff --git a/src/votes.ts b/src/votes.ts
@@ -157,7 +157,7 @@ export class VotesClient {
    * Constructs an allowance operation
    * @param from The address of the owner of the tokens
    * @param spender The address of the spender
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   allowance({ from, spender }: { from: string; spender: string }): string {
     return this.contract
@@ -177,7 +177,7 @@ export class VotesClient {
    * @param spender The address of the spender
    * @param amount The amount of tokens to approve
    * @param expiration_ledger The expiration ledger
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   approve({
     from,
@@ -206,7 +206,7 @@ export class VotesClient {
   /**
    * Constructs a balance operation
    * @param id The address of the account
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   balance({ id }: { id: string }): string {
     return this.contract
@@ -224,7 +224,7 @@ export class VotesClient {
    * @param from The address of the sender
    * @param to The address of the recipient
    * @param amount The amount of tokens to transfer
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   transfer({
     from,
@@ -253,7 +253,7 @@ export class VotesClient {
    * @param from The address of the sender
    * @param to The address of the recipient
    * @param amount The amount of tokens to transfer
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   transferFrom({
     spender,
@@ -283,7 +283,7 @@ export class VotesClient {
    * Constructs a burn operation
    * @param from The address of the account
    * @param amount The amount of tokens to burn
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   burn({ from, amount }: { from: string; amount: i128 }): string {
     return this.contract
@@ -302,7 +302,7 @@ export class VotesClient {
    * @param spender The address of the spender
    * @param from The address of the account
    * @param amount The amount of tokens to burn
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   burnFrom({
     spender,
@@ -327,7 +327,7 @@ export class VotesClient {
 
   /**
    * Constructs a decimals operation (READ ONLY: Operation should only be simulated)
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   decimals(): string {
     return this.contract
@@ -337,7 +337,7 @@ export class VotesClient {
 
   /**
    * Constructs a name operation (READ ONLY: Operation should only be simulated)
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   name(): string {
     return this.contract
@@ -347,7 +347,7 @@ export class VotesClient {
 
   /**
    * Constructs a symbol operation (READ ONLY: Operation should only be simulated)
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   symbol(): string {
     return this.contract
@@ -359,7 +359,7 @@ export class VotesClient {
    * Constructs an initialize operation
    * @param token The address of the voting token
    * @param governor The address of the governor
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   initialize({ token, governor }: { token: string; governor: string }): string {
     return this.contract
@@ -375,7 +375,7 @@ export class VotesClient {
 
   /**
    * Constructs a total_supply operation (READ ONLY: Operation should only be simulated)
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   totalSupply(): string {
     return this.contract
@@ -386,7 +386,7 @@ export class VotesClient {
   /**
    * Constructs a get_past_total_supply operation (READ ONLY: Operation should only be simulated)
    * @param sequence The sequence number
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getPastTotalSupply({ sequence }: { sequence: u32 }): string {
     return this.contract
@@ -402,7 +402,7 @@ export class VotesClient {
   /**
    * Constructs a get_votes operation (READ ONLY: Operation should only be simulated)
    * @param account The address of the account
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getVotes({ account }: { account: string }): string {
     return this.contract
@@ -419,7 +419,7 @@ export class VotesClient {
    * Constructs a get_past_votes operation (READ ONLY: Operation should only be simulated)
    * @param user The address of the user
    * @param sequence The sequence number
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getPastVotes({ user, sequence }: { user: string; sequence: u32 }): string {
     return this.contract
@@ -436,7 +436,7 @@ export class VotesClient {
   /**
    * Constructs a get_delegate operation (READ ONLY: Operation should only be simulated)
    * @param account The address of the account
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   getDelegate({ account }: { account: string }): string {
     return this.contract
@@ -453,7 +453,7 @@ export class VotesClient {
    * Constructs a delegate operation
    * @param account The address of the account delgating the votes
    * @param delegatee The address of the delegatee
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   delegate({
     account,
@@ -477,7 +477,7 @@ export class VotesClient {
    * Constructs a deposit_for operation
    * @param from The address of the account
    * @param amount The amount of tokens to deposit
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   depositFor({ from, amount }: { from: string; amount: i128 }): string {
     return this.contract
@@ -495,7 +495,7 @@ export class VotesClient {
    * Constructs a withdraw_to operation
    * @param from The address of the account
    * @param amount The amount of tokens to withdraw
-   * @returns An object containing the operation and a parser for the result
+   * @returns A base64 XDR string of the operation
    */
   withdrawTo({ from, amount }: { from: string; amount: i128 }): string {
     return this.contract
@@ -529,12 +529,12 @@ export class VotesClient {
    * Constructs a set_emis operation
    * @param from The address of the account
    * @param amount The amount of tokens to withdraw
-   * @returns An object containing the operation
+   * @returns A base64 XDR string of the operation
    */
   setEmis({ tokens, expiration }: { tokens: i128; expiration: u64 }): string {
     return this.contract
       .call(
-        "claim",
+        "set_emis",
         ...this.spec.funcArgsToScVals("set_emis", { tokens, expiration })
       )
       .toXDR("base64");