arweave 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d04de6a25b28b4b42809d2d14fbcd7e71befe7b49ed3977a81ef7eba5d3ac35
-  data.tar.gz: 74e087df6a11aa74699391335df2c8c01ec6bfe640a874320ce6e2dca300426e
+  metadata.gz: 3735532e9b91e9cbe5e84b671ae9f7685fdd8328f2fd8ae644e0f069bcb75d3e
+  data.tar.gz: 4df8ea22c8f6a20ae9299deb6043c798a23cf071c0cfc9e7222ce843aa5b5da2
 SHA512:
-  metadata.gz: 79526f3f277e5425d6c52b0dbfcd63e1852d8a6923195d38e28378dacf753992817ddbea79fcba7d1558260cc4985d2120decaa4af10b9d53bfacfc13acee831
-  data.tar.gz: 52b5b82f06a20d5cee8f4c0e13621d27a50f5eb6068d7d1790c1d870c3420671ceadaab2ead190de3ea805529b92221ce1bf0ab66659f2d7b521d411af1a52ae
+  metadata.gz: 804ebaacd0bfe841f3a38b586dba8ae7e271248b80e35b6755c5affc0aa90fb292dfd0125fb3c029f2fab43afbe585b1a578a6759cda5c6ddaf4df63b14cec53
+  data.tar.gz: 25bc0d61ab800180e4066b9c171d1a383cd1a7f5d13ed7a803dea078b70c6ec01f8d207c35c8a6c9a5dea479ed9573f31e3ffb89f7c92cd7238c21361331bd43

data/README.md

@@ -12,7 +12,7 @@ gem 'arweave'
 ```
 ## Usage
 
-### Configuration
+## Configuration
 The default node that this package uses is `https://arweave.net`. But you can simply configure it:
 
 ```ruby
@@ -23,11 +23,96 @@ Arweave::Client.configure do |config|
 end
 ```
 
+## Transaction methods
+
+### Getting transaction anchor
+```ruby
+anchor = Arweave::Transaction.anchor
+```
+
 ### Creating transactions
-For a complete list of argument you can pass to the `create_transaction` method, checkout the [documentation](https://docs.arweave.org/developers/server/http-api#submit-a-transaction).
+For a complete list of arguments you can pass to the `new` method,
+checkout the [documentation](https://docs.arweave.org/developers/server/http-api#submit-a-transaction).
 
 ```ruby
-client = Arweave::Client.new
 jwk = JSON.parse(File.read(File.expand_path(File.join('path-to-keyfile'))))
-client.create_transaction(wallet: wallet, data: '<b>test</b>').commit
+wallet = Arweave::Wallet.new jwk
+
+transaction = Arweave::Transaction.new(data: '<b>test</b>')
+transaction.sign(wallet)
+transaction.commit
+# => #<Arweavev::Transaction:0x00007f9b61299330 @attributes={...}>
+```
+
+You can also chain the methods
+```ruby
+Arweave::Transaction.new(data: '<b>test</b>').sign(wallet).commit
+# => #<Arweavev::Transaction:0x00007f9b61299330 @attributes={...}>
+```
+
+You can get the transaction attributes from the attribuets hash:
+```ruby
+transaction.attributes[:id]
+# => "tSF6pxiknBk0hBUTkdzq02E0zvsrT0xe4UtCzZit-bz"
+```
+
+### Find transaction by id
+```ruby
+Arweave::Transaction.find('tSF6pxiknBk0hBUTkdzq02E0zvsrT0xe4UtCzZit-bz')
+# => #<Arweavev::Transaction:0x00007f9b61299330 @attributes={...}>
+```
+
+### Getting a transaction data
+the transaction `data` class method returns base64 decoded data for data transactions
+```ruby
+Arweave::Transaction.data('tSF6pxiknBk0hBUTkdzq02E0zvsrT0xe4UtCzZit-bz')
+# => "<b>test</b>"
+```
+
+### Getting transaction status
+the `status` class method returns a hash containing transaction status
+(which is pending or accepted) and the and the data and a hash about the block.
+```ruby
+Arweave::Transaction.status('tSF6pxiknBk0hBUTkdzq02E0zvsrT0xe4UtCzZit-bz')
+# => {
+#   "status": "accepted",
+#   "data": {
+#     "block_height": 468306,
+#     "block_indep_hash": "hh0ceHGfEOuTQWYMXGNzb2AabezqZUhtSw5vtUPKTtGmkViPArX5WeLBKBYZIwlS",
+#     "number_of_confirmations": 388
+#   }
+# }
+```
+
+## Wallet methods
+
+### Getting wallet owner
+The `owner` method returns the full RSA modulus value of the wallet.
+```ruby
+wallet.owner
+# => "...-Tr3S_HBgX2ixr1ZwEMD7iJlUEJrvItE-lBepKHHLd0OFJ3PgkKsP15TEefVezhssSO_s_EQdJ4yA7Ij8Y_XsAGXrjM76MYa7QZNWTLqhc7cixBDBWk0KLPBuN-AdjN71BXYJRZ_5gMzUyu1GKSuaIcvzISTqPbVuJwFPTNLkmm3t-wRtioKAyQzieqskQuh4iYKmeBQ0SAuDd0Xf3wcGxWRIrK7lphP2A0cIA65dUY2klDbiZVwWh_82igD00cGmZLSzFTaVNqIBNyPN5nTLriCGnYbWnMj9-uPghK_NYGyKYOkwPGJB3bZ_fPvLzWkrTnKi1uqyKdp_4AEKAfKLO3agh7rfB3wNKe-..."
+```
+
+### Getting wallet address
+The address of a wallet is a Base64 URL encoded SHA-256 hash of the `n` value from the JWK.
+```ruby
+wallet.address
+# => "bQ3zPuzKXOpnaZ_O_kcbByRBaso2e4nyIN8KmsQH80"
+```
+
+### Getting wallet balance
+This method returns an open struct contains the balance both `ar` and `winston`
+as `BigDecimal`.
+```ruby
+balance = wallet.balance
+# => #<OpenStruct ar=0.249891527825e0, winston=0.249891527825e12>
+balance.ar # => 0.249891527825e0
+balance.winston # => 0.249891527825e12
+
+balance.winston.to_i # => 249891527825
+```
+
+### Get the wallet's last transaction id
+```ruby
+wallet.last_transaction_id # => "BsHjWHBwSlmW_VgOcgLmsQacQjpohmvVDLMMVyuAkie"
 ```

data/lib/arweave.rb

@@ -3,3 +3,4 @@ require 'arweave/client'
 require 'arweave/api'
 require 'arweave/transaction'
 require 'arweave/wallet'
+require 'arweave/errors'

data/lib/arweave/api.rb

@@ -19,6 +19,26 @@ module Arweave
       self.class.get('/tx_anchor')
     end
 
+    def get_transaction(transaction_id)
+      self.class.get("/tx/#{transaction_id}")
+    end
+
+    def get_transaction_data(transaction_id)
+      self.class.get("/tx/#{transaction_id}/data")
+    end
+
+    def get_transaction_status(transaction_id)
+      self.class.get("/tx/#{transaction_id}/status")
+    end
+
+    def get_last_transaction_id(wallet_address)
+      self.class.get("/wallet/#{wallet_address}/last_tx")
+    end
+
+    def get_wallet_balance(wallet_address)
+      self.class.get("/wallet/#{wallet_address}/balance")
+    end
+
     def reward(byte_size, address = '')
       self.class.get("/price/#{byte_size}/#{address}")
     end

data/lib/arweave/client.rb

@@ -2,40 +2,6 @@ require 'base64'
 
 module Arweave
   class Client
-    def initialize
-      @api = Api.instance
-    end
-
-    def create_transaction(wallet:, **attributes)
-      attributes.transform_keys!(&:to_sym)
-
-      transaction =
-        Transaction.new(
-          last_tx: api.get_transaction_anchor,
-          owner: wallet.owner,
-          tags: [],
-          target: attributes.fetch(:target, ''),
-          quantity: attributes.fetch(:quantity, '0'),
-          data:
-            Base64.urlsafe_encode64(
-              attributes.fetch(:data, ''),
-              padding: false
-            ),
-          reward:
-            api.reward(
-              attributes.fetch(:data, '').length,
-              attributes.fetch(:target, nil)
-            )
-        )
-
-      transaction.sign(wallet)
-      transaction
-    end
-
-    def commit(transaction)
-      api.commit(transaction)
-    end
-
     class << self
       attr_accessor :configuration
     end

data/lib/arweave/errors.rb

@@ -0,0 +1,4 @@
+module Arweave
+  class TransactionNotFound < StandardError; end
+  class TransactionNotSigned < StandardError; end
+end

data/lib/arweave/transaction.rb

@@ -16,29 +16,74 @@ module Arweave
           data: '',
           reward: '0',
           signature: ''
-        }.merge(attributes).yield_self do |hash|
-          hash.each do |key, value|
-            value.respond_to?(:map) ? hash[key] = value : hash[key] = value.to_s
+        }.merge(attributes).transform_keys!(&:to_sym).yield_self do |hash|
+          if hash[:data]
+            hash[:data] = Base64.urlsafe_encode64(hash[:data], padding: false)
           end
-
           hash
-        end.transform_keys!(&:to_sym)
+        end
     end
 
     def sign(wallet)
-      signature = wallet.sign(get_signature_data)
+      @attributes[:last_tx] = self.class.anchor
+      @attributes[:reward] =
+        Api.instance.reward(
+          @attributes.fetch(:data, '').length,
+          @attributes.fetch(:target, nil)
+        ).body
+      @attributes[:owner] = wallet.owner
 
+      signature = wallet.sign(get_signature_data)
       @attributes[:signature] =
         Base64.urlsafe_encode64 signature, padding: false
       @attributes[:id] =
         Base64.urlsafe_encode64 Digest::SHA256.digest(signature), padding: false
 
       # TODO: verify signature
-      signature
+      self
     end
 
     def commit
+      raise Arweave::TransactionNotSigned if @attributes[:signature].empty?
+
       Api.instance.commit(self)
+      self
+    end
+
+    class << self
+      def anchor
+        Api.instance.get_transaction_anchor.body
+      end
+
+      def find(id)
+        res = Api.instance.get_transaction(id)
+        raise TransactionNotFound if res.not_found?
+        data =
+          JSON.parse(res.body).transform_keys!(&:to_sym).yield_self do |hash|
+            hash[:data] = Base64.urlsafe_decode64(hash[:data]) if hash[:data]
+            hash
+          end
+
+        new(data)
+      end
+
+      def data(id)
+        res = Api.instance.get_transaction_data(id)
+        raise TransactionNotFound if res.not_found?
+
+        Base64.urlsafe_decode64(res.body)
+      end
+
+      def status(id)
+        res = Api.instance.get_transaction_status(id)
+        raise TransactionNotFound if res.not_found?
+
+        {
+          status: :accepted, data: JSON.parse(res.body).transform_keys(&:to_sym)
+        }
+      rescue JSON::ParserError
+        { status: :pending, data: {} }
+      end
     end
 
     private

data/lib/arweave/version.rb

@@ -1,3 +1,3 @@
 module Arweave
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

data/lib/arweave/wallet.rb

@@ -1,12 +1,14 @@
 require 'json/jwt'
 require 'base64'
 require 'digest'
+require 'ostruct'
 
 module Arweave
   class Wallet
-    attr_reader :address, :owner
+    attr_reader :address, :owner, :api
 
     def initialize(jwk)
+      @api = Api.instance
       @jwk = jwk.transform_keys!(&:to_sym)
     end
 
@@ -29,6 +31,19 @@ module Arweave
       )
     end
 
+    def balance
+      balance_in_winstons = BigDecimal(api.get_wallet_balance(address).body)
+
+      OpenStruct.new(
+        ar: balance_in_winstons / 1e12,
+        winston: balance_in_winstons
+      )
+    end
+
+    def last_transaction_id
+      api.get_last_transaction_id(address).body
+    end
+
     private
 
     attr_reader :jwk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arweave
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Aref Aslani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-jwt
@@ -74,6 +74,7 @@ files:
 - lib/arweave.rb
 - lib/arweave/api.rb
 - lib/arweave/client.rb
+- lib/arweave/errors.rb
 - lib/arweave/transaction.rb
 - lib/arweave/version.rb
 - lib/arweave/wallet.rb