solana-ruby 0.1.0 → 0.1.2

data/lib/solana-ruby/keypair.rb

@@ -0,0 +1,105 @@
+require 'rbnacl'
+require 'json'
+require_relative 'utils'
+
+module Solana
+  ##
+  # The Keypair class represents a keypair for signing transactions on the Solana blockchain.
+  #
+  class Keypair
+    attr_reader :public_key, :secret_key
+
+    ##
+    # Initializes a new Keypair.
+    #
+    # If a +secret_key+ is provided, it must be 64 bytes long. The first 32 bytes are used as the signing key,
+    # and the public key is derived from it. If no +secret_key+ is provided, a new keypair is generated.
+    #
+    # Raises an error if the +secret_key+ is not 64 bytes long.
+    #
+    # @param [String, nil] secret_key The secret key to use for the keypair, in binary format (optional).
+    def initialize(secret_key = nil)
+      if secret_key
+        raise 'Bad secret key size' unless secret_key.bytesize == 64
+        @signing_key = RbNaCl::Signatures::Ed25519::SigningKey.new(secret_key[0, 32])
+        @public_key = @signing_key.verify_key.to_bytes
+      else
+        @signing_key = RbNaCl::Signatures::Ed25519::SigningKey.generate
+        @public_key = @signing_key.verify_key.to_bytes
+      end
+      @secret_key = @signing_key.to_bytes + @public_key
+    end
+
+    ##
+    # Generates a new Keypair.
+    #
+    # @return [Keypair] A new Keypair instance.
+    def self.generate
+      new
+    end
+
+    ##
+    # Creates a Keypair from a provided secret key.
+    #
+    # @param [String] secret_key The secret key in binary format.
+    # @return [Keypair] A new Keypair instance initialized with the provided secret key.
+    def self.from_secret_key(secret_key)
+      new(secret_key)
+    end
+
+    ##
+    # Saves the keypair to a JSON file.
+    #
+    # The public and secret keys are encoded in Base58 format before being saved.
+    #
+    # @param [String] file_path The path to the file where the keypair will be saved.
+    def save_to_json(file_path)
+      data = {
+        public_key: Utils::base58_encode(@public_key),
+        secret_key: Utils::base58_encode(@secret_key)
+      }
+      File.write(file_path, data.to_json)
+    end
+
+    ##
+    # Loads a keypair from a JSON file.
+    #
+    # The file must contain the public and secret keys in Base58 format. The method verifies the size of the secret key and
+    # checks that the derived public key matches the saved public key.
+    #
+    # Raises an error if the +secret_key+ is not 64 bytes long or if the derived public key does not match the saved public key.
+    #
+    # @param [String] file_path The path to the file from which the keypair will be loaded.
+    # @return [Keypair] The loaded keypair.
+    def self.load_from_json(file_path)
+      data = JSON.parse(File.read(file_path), symbolize_names: true)
+      secret_key = Utils::base58_decode(data[:secret_key])
+      public_key = Utils::base58_decode(data[:public_key])
+
+      raise 'Bad secret key size' unless secret_key.bytesize == 64
+
+      signing_key = RbNaCl::Signatures::Ed25519::SigningKey.new(secret_key[0, 32])
+      loaded_public_key = signing_key.verify_key.to_bytes
+
+      raise 'Provided secretKey is invalid' unless loaded_public_key == public_key
+
+      new(secret_key)
+    end
+
+    ##
+    # Returns the public key for this keypair in Base58 format.
+    #
+    # @return [String] The public key in Base58 format.
+    def public_key_base58
+      Utils::base58_encode(@public_key)
+    end
+
+    ##
+    # Returns the raw secret key for this keypair in Base58 format.
+    #
+    # @return [String] The secret key in Base58 format.
+    def secret_key_base58
+      Utils::base58_encode(@secret_key)
+    end
+  end
+end

data/lib/solana-ruby/utils.rb

@@ -0,0 +1,107 @@
+require 'base58'
+require 'base64'
+
+module Solana
+  ##
+  # The Utils module provides utility methods and constants for interacting with the Solana blockchain.
+  #
+  module Utils
+    ##
+    # The system program ID for Solana.
+    SYSTEM_PROGRAM_ID = '11111111111111111111111111111111'
+
+    ##
+    # The maximum packet data size for Solana transactions.
+    PACKET_DATA_SIZE = 1232
+
+    ##
+    # Endpoints for the mainnet.
+    module MAINNET
+      ##
+      # HTTP endpoint for the mainnet.
+      HTTP = 'https://api.mainnet-beta.solana.com'
+
+      ##
+      # WebSocket endpoint for the mainnet.
+      WS = 'wss://api.mainnet-beta.solana.com'
+    end
+
+    ##
+    # Endpoints for the testnet.
+    module TESTNET
+      ##
+      # HTTP endpoint for the testnet.
+      HTTP = 'https://api.testnet.solana.com'
+
+      ##
+      # WebSocket endpoint for the testnet.
+      WS = 'wss://api.testnet.solana.com'
+    end
+
+    ##
+    # Endpoints for the devnet.
+    module DEVNET
+      ##
+      # HTTP endpoint for the devnet.
+      HTTP = 'https://api.devnet.solana.com'
+
+      ##
+      # WebSocket endpoint for the devnet.
+      WS = 'wss://api.devnet.solana.com'
+    end
+
+    ##
+    # Instruction types for Solana transactions.
+    module InstructionType
+      CREATE_ACCOUNT = 0
+      ASSIGN = 1
+      TRANSFER = 2
+      CREATE_ACCOUNT_WITH_SEED = 3
+      ADVANCE_NONCE_ACCOUNT = 4
+      WITHDRAW_NONCE_ACCOUNT = 5
+      INITIALIZE_NONCE_ACCOUNT = 6
+      AUTHORIZE_NONCE_ACCOUNT = 7
+      ALLOCATE = 8
+      ALLOCATE_WITH_SEED = 9
+      ASSIGN_WITH_SEED = 10
+      TRANSFER_WITH_SEED = 11
+    end
+
+    ##
+    # Encodes a byte array into a Base58 string.
+    #
+    # @param [String] bytes The byte array to encode.
+    # @return [String] The Base58-encoded string.
+    def self.base58_encode(bytes)
+      Base58.binary_to_base58(bytes, :bitcoin)
+    end
+
+    ##
+    # Decodes a Base58 string into a byte array.
+    #
+    # @param [String] base58 The Base58 string to decode.
+    # @return [String] The decoded byte array.
+    def self.base58_decode(base58)
+      Base58.base58_to_binary(base58, :bitcoin)
+    end
+
+    ##
+    # Encodes a byte array into a Base64 string.
+    #
+    # @param [String] bytes The byte array to encode.
+    # @return [String] The Base64-encoded string.
+    def self.base64_encode(bytes)
+      Base64.strict_encode64(bytes)
+    end
+
+    ##
+    # Decodes a Base64 string into a byte array.
+    #
+    # @param [String] base64 The Base64 string to decode.
+    # @return [String] The decoded byte array.
+    def self.base64_decode(base64)
+      Base64.strict_decode64(base64)
+    end
+  end
+  Utils.freeze
+end

data/lib/solana-ruby/version.rb

@@ -1,3 +1,3 @@
-module SolanaRB
-    VERSION = '0.1.0'.freeze
-end
+module Solana
+    VERSION = '0.1.2'.freeze
+end

data/lib/solana-ruby.rb

@@ -1,5 +1,7 @@
-require_relative 'solana-ruby/version'
 require_relative 'solana-ruby/client'
+require_relative 'solana-ruby/keypair'
+require_relative 'solana-ruby/utils'
+require_relative 'solana-ruby/version'
 
-module SolanaRB
+module Solana
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: solana-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Fabrice Renard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: base58
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,11 +159,14 @@ extra_rdoc_files: []
 files:
 - lib/solana-ruby.rb
 - lib/solana-ruby/client.rb
+- lib/solana-ruby/keypair.rb
+- lib/solana-ruby/utils.rb
 - lib/solana-ruby/version.rb
 homepage: https://github.com/fabricerenard12/solana-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/fabricerenard12/solana-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -98,5 +185,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for the Solana blockchain API
+summary: A Ruby SDK for the Solana blockchain API
 test_files: []